Aws::Client Namespace Reference

Namespaces

namespace  CoreErrorsMapper

 

Classes

class  AdaptiveRetryStrategy

 

class  AsyncCallerContext

 

class  AWSAuthBearerSigner

 

class  AWSAuthEventStreamV4Signer

 

class  AWSAuthSigner

 

class  AWSAuthV4Signer

 

class  AWSClient

 

class  AWSError

 

class  AWSErrorMarshaller

 

class  AWSJsonClient

 

class  AWSNullSigner

 

class  AWSUrlPresigner

 

class  AWSXMLClient

 

class  BidirectionalEventStreamingTask

 

struct  ClientConfiguration

 

struct  ClientConfigurationInitValues

 

class  ClientWithAsyncTemplateMethods

 

class  DefaultRetryQuotaContainer

 

class  DefaultRetryStrategy

 

struct  GenericClientConfiguration

 

struct  IsEventStreamOperation

 

struct  IsEventStreamOperation< ReturnT(ClassT::*)() const >

 

struct  IsEventStreamOperation< ReturnT(ClassT::*)(RequestT) const >

 

class  JsonErrorMarshaller

 

class  JsonErrorMarshallerQueryCompatible

 

class  MonitorContext

 

class  RequestCompression

 

struct  RequestCompressionConfig

 

class  RetryQuotaContainer

 

class  RetryStrategy

 

class  RetryTokenBucket

 

class  SpecifiedRetryableErrorsRetryStrategy

 This retry strategy is almost identical to DefaultRetryStrategy, except it accepts a vector of error or exception names that you want to retry anyway (bypass the retryable definition of the error instance itself) if the retry attempts is less than maxRetries. More...

 

class  StandardRetryStrategy

 

class  UserAgent

 

class  XmlErrorMarshaller

 

Typedefs

typedef Utils::Outcome< std::shared_ptr< Aws::Http::HttpResponse >, AWSError< CoreErrors > > HttpResponseOutcome

 

typedef Utils::Outcome< AmazonWebServiceResult< Utils::Stream::ResponseStream >, AWSError< CoreErrors > > StreamOutcome

 

using JsonOutcome = Utils::Outcome< AmazonWebServiceResult< Utils::Json::JsonValue >, AWSError< CoreErrors > >

 

using XmlOutcome = Utils::Outcome< AmazonWebServiceResult< Utils::Xml::XmlDocument >, AWSError< CoreErrors > >

 

Enumerations

enum class  ErrorPayloadType { NOT_SET , XML , JSON }

 

enum class  RetryableType { NOT_RETRYABLE , RETRYABLE , RETRYABLE_THROTTLING }

 

enum class  FollowRedirectsPolicy { DEFAULT , ALWAYS , NEVER }

 

enum class  UseRequestCompression { DISABLE , ENABLE }

 

enum class  RequestChecksumCalculation { WHEN_SUPPORTED , WHEN_REQUIRED }

 

enum class  ResponseChecksumValidation { WHEN_SUPPORTED , WHEN_REQUIRED }

 

enum class  CoreErrors {
  INCOMPLETE_SIGNATURE = 0 , INTERNAL_FAILURE = 1 , INVALID_ACTION = 2 , INVALID_CLIENT_TOKEN_ID = 3 ,
  INVALID_PARAMETER_COMBINATION = 4 , INVALID_QUERY_PARAMETER = 5 , INVALID_PARAMETER_VALUE = 6 , MISSING_ACTION = 7 ,
  MISSING_AUTHENTICATION_TOKEN = 8 , MISSING_PARAMETER = 9 , OPT_IN_REQUIRED = 10 , REQUEST_EXPIRED = 11 ,
  SERVICE_UNAVAILABLE = 12 , THROTTLING = 13 , VALIDATION = 14 , ACCESS_DENIED = 15 ,
  RESOURCE_NOT_FOUND = 16 , UNRECOGNIZED_CLIENT = 17 , MALFORMED_QUERY_STRING = 18 , SLOW_DOWN = 19 ,
  REQUEST_TIME_TOO_SKEWED = 20 , INVALID_SIGNATURE = 21 , SIGNATURE_DOES_NOT_MATCH = 22 , INVALID_ACCESS_KEY_ID = 23 ,
  REQUEST_TIMEOUT = 24 , NOT_INITIALIZED = 25 , MEMORY_ALLOCATION = 26 , NETWORK_CONNECTION = 99 ,
  UNKNOWN = 100 , CLIENT_SIGNING_FAILURE = 101 , USER_CANCELLED = 102 , ENDPOINT_RESOLUTION_FAILURE = 103 ,
  SERVICE_EXTENSION_START_RANGE = 128 , OK = -1
}

 

enum class  CompressionAlgorithm { NONE , GZIP }

 

enum class  UserAgentFeature {
  RETRY_MODE_LEGACY , RETRY_MODE_STANDARD , RETRY_MODE_ADAPTIVE , S3_TRANSFER ,
  S3_CRYPTO_V1N , S3_CRYPTO_V2 , FLEXIBLE_CHECKSUMS_REQ_CRC32 , FLEXIBLE_CHECKSUMS_REQ_CRC32C ,
  FLEXIBLE_CHECKSUMS_REQ_CRC64 , FLEXIBLE_CHECKSUMS_REQ_SHA1 , FLEXIBLE_CHECKSUMS_REQ_SHA256 , FLEXIBLE_CHECKSUMS_REQ_WHEN_SUPPORTED ,
  FLEXIBLE_CHECKSUMS_REQ_WHEN_REQUIRED , FLEXIBLE_CHECKSUMS_RES_WHEN_SUPPORTED , FLEXIBLE_CHECKSUMS_RES_WHEN_REQUIRED
}

 

Functions

template<typename ClientT , typename RequestT , typename HandlerT , typename HandlerContextT , typename OperationFuncT , typename ExecutorT >

void AWS_CORE_LOCAL MakeAsyncOperation (OperationFuncT &&operationFunc, const ClientT *clientThis, const RequestT &request, const HandlerT &handler, const HandlerContextT &context, ExecutorT *pExecutor)

 

template<typename ClientT , typename RequestT , typename HandlerT , typename HandlerContextT , typename OperationFuncT , typename ExecutorT >

void AWS_CORE_LOCAL MakeAsyncStreamingOperation (OperationFuncT &&operationFunc, const ClientT *clientThis, RequestT &request, const HandlerT &handler, const HandlerContextT &context, ExecutorT *pExecutor)

 

template<typename ClientT , typename HandlerT , typename HandlerContextT , typename OperationFuncT , typename ExecutorT >

void AWS_CORE_LOCAL MakeAsyncOperation (OperationFuncT &&operationFunc, const ClientT *clientThis, const HandlerT &handler, const HandlerContextT &context, ExecutorT *pExecutor)

 

template<typename ClientT , typename RequestT , typename OperationFuncT , typename ExecutorT >

auto AWS_CORE_LOCAL MakeCallableOperation (const char *ALLOCATION_TAG, OperationFuncT &&operationFunc, const ClientT *clientThis, const RequestT &request, ExecutorT *pExecutor) -> std::future< decltype((clientThis-> *operationFunc)(request))>

 

template<typename ClientT , typename RequestT , typename OperationFuncT , typename ExecutorT >

auto AWS_CORE_LOCAL MakeCallableStreamingOperation (const char *ALLOCATION_TAG, OperationFuncT &&operationFunc, const ClientT *clientThis, RequestT &request, ExecutorT *pExecutor) -> std::future< decltype((clientThis-> *operationFunc)(request))>

 

template<typename ClientT , typename OperationFuncT , typename ExecutorT >

auto AWS_CORE_LOCAL MakeCallableOperation (const char *ALLOCATION_TAG, OperationFuncT &&operationFunc, const ClientT *clientThis, ExecutorT *pExecutor) -> std::future< decltype((clientThis-> *operationFunc)())>

 

AWS_CORE_API Aws::String GetAuthorizationHeader (const Aws::Http::HttpRequest &httpRequest)

 

template<typename OutcomeT , typename ClientT , typename AWSEndpointT , typename RequestT , typename HandlerT >

static BidirectionalEventStreamingTask< OutcomeT, ClientT, AWSEndpointT, RequestT, HandlerT > CreateBidirectionalEventStreamTask (const ClientT *pClientThis, AWSEndpointT &&endpoint, const std::shared_ptr< RequestT > &pRequest, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &handlerContext, const std::shared_ptr< Utils::Event::EventEncoderStream > &stream, const Http::HttpMethod method=Aws::Http::HttpMethod::HTTP_POST, char const *const signerName=Aws::Auth::EVENTSTREAM_SIGV4_SIGNER)

 

template<typename T >

Aws::OStream & operator<< (Aws::OStream &s, const AWSError< T > &e)

 

std::shared_ptr< RetryStrategy > InitRetryStrategy (Aws::String retryMode="")

 

AWS_CORE_API Aws::String ComputeUserAgentString (ClientConfiguration const *const pConfig=nullptr)

 

AWS_CORE_API Aws::String FilterUserAgentToken (char const *const token)

 

AWS_CORE_API Aws::OStream & operator<< (Aws::OStream &oStream, CoreErrors code)

 

Aws::String AWS_CORE_API GetCompressionAlgorithmId (const CompressionAlgorithm &algorithm)

 

Variables

static const int NO_RETRY_INCREMENT = 1

 

Typedef Documentation

HttpResponseOutcome

typedef Utils::Outcome< std::shared_ptr< Aws::Http::HttpResponse >, AWSError< CoreErrors > > Aws::Client::HttpResponseOutcome

Definition at line 72 of file AWSClient.h.

JsonOutcome

using Aws::Client::JsonOutcome = typedef Utils::Outcome<AmazonWebServiceResult<Utils::Json::JsonValue>, AWSError<CoreErrors> >

Definition at line 25 of file AWSJsonClient.h.

StreamOutcome

typedef Utils::Outcome<AmazonWebServiceResult<Utils::Stream::ResponseStream>, AWSError<CoreErrors> > Aws::Client::StreamOutcome

Definition at line 73 of file AWSClient.h.

XmlOutcome

using Aws::Client::XmlOutcome = typedef Utils::Outcome<AmazonWebServiceResult<Utils::Xml::XmlDocument>, AWSError<CoreErrors> >

Definition at line 25 of file AWSXmlClient.h.

Enumeration Type Documentation

CompressionAlgorithm

enum class Aws::Client::CompressionAlgorithm

strong

Enumerator
NONE
GZIP

Definition at line 20 of file RequestCompression.h.

CoreErrors

enum class Aws::Client::CoreErrors

strong

Enumerator
INCOMPLETE_SIGNATURE
INTERNAL_FAILURE
INVALID_ACTION
INVALID_CLIENT_TOKEN_ID
INVALID_PARAMETER_COMBINATION
INVALID_QUERY_PARAMETER
INVALID_PARAMETER_VALUE
MISSING_ACTION
MISSING_AUTHENTICATION_TOKEN
MISSING_PARAMETER
OPT_IN_REQUIRED
REQUEST_EXPIRED
SERVICE_UNAVAILABLE
THROTTLING
VALIDATION
ACCESS_DENIED
RESOURCE_NOT_FOUND
UNRECOGNIZED_CLIENT
MALFORMED_QUERY_STRING
SLOW_DOWN
REQUEST_TIME_TOO_SKEWED
INVALID_SIGNATURE
SIGNATURE_DOES_NOT_MATCH
INVALID_ACCESS_KEY_ID
REQUEST_TIMEOUT
NOT_INITIALIZED
MEMORY_ALLOCATION
NETWORK_CONNECTION
UNKNOWN
CLIENT_SIGNING_FAILURE
USER_CANCELLED
ENDPOINT_RESOLUTION_FAILURE
SERVICE_EXTENSION_START_RANGE
OK

Definition at line 21 of file CoreErrors.h.

ErrorPayloadType

enum class Aws::Client::ErrorPayloadType

strong

Enumerator
NOT_SET
XML
JSON

Definition at line 23 of file AWSError.h.

FollowRedirectsPolicy

enum class Aws::Client::FollowRedirectsPolicy

strong

Sets the behaviors of the underlying HTTP clients handling response with 30x status code. By default, HTTP clients will always redirect the 30x response automatically, except when specifying aws-global as the client region, then SDK will handle 30x response and redirect the request manually.

Enumerator
DEFAULT
ALWAYS
NEVER

Definition at line 43 of file ClientConfiguration.h.

RequestChecksumCalculation

enum class Aws::Client::RequestChecksumCalculation

strong

Setting on whether to calculate a checksum for a payload only when it is required. i.e. when setting WHEN_REQUIRED the SDK will NOT calculate a checksum for an endpoint where it is supported but is NOT required.

Enumerator
WHEN_SUPPORTED
WHEN_REQUIRED

Definition at line 64 of file ClientConfiguration.h.

ResponseChecksumValidation

enum class Aws::Client::ResponseChecksumValidation

strong

Setting on whether to client side response validate a content body that had a checksum associated with it. Response validation right now cannot be modeled as required but rely on an associated model configuration.

Enumerator
WHEN_SUPPORTED
WHEN_REQUIRED

Definition at line 74 of file ClientConfiguration.h.

RetryableType

enum class Aws::Client::RetryableType

strong

Enumerator
NOT_RETRYABLE
RETRYABLE
RETRYABLE_THROTTLING

Definition at line 30 of file AWSError.h.

UserAgentFeature

enum class Aws::Client::UserAgentFeature

strong

Enumerator
RETRY_MODE_LEGACY
RETRY_MODE_STANDARD
RETRY_MODE_ADAPTIVE
S3_TRANSFER
S3_CRYPTO_V1N
S3_CRYPTO_V2
FLEXIBLE_CHECKSUMS_REQ_CRC32
FLEXIBLE_CHECKSUMS_REQ_CRC32C
FLEXIBLE_CHECKSUMS_REQ_CRC64
FLEXIBLE_CHECKSUMS_REQ_SHA1
FLEXIBLE_CHECKSUMS_REQ_SHA256
FLEXIBLE_CHECKSUMS_REQ_WHEN_SUPPORTED
FLEXIBLE_CHECKSUMS_REQ_WHEN_REQUIRED
FLEXIBLE_CHECKSUMS_RES_WHEN_SUPPORTED
FLEXIBLE_CHECKSUMS_RES_WHEN_REQUIRED

Definition at line 13 of file UserAgent.h.

UseRequestCompression

enum class Aws::Client::UseRequestCompression

strong

This setting is an enumeration, not a boolean, to allow for future expansion.

Enumerator
DISABLE
ENABLE

Definition at line 53 of file ClientConfiguration.h.

Function Documentation

ComputeUserAgentString()

AWS_CORE_API Aws::String Aws::Client::ComputeUserAgentString ( ClientConfiguration const *const  pConfig = nullptr)

A helper function to compute a user agent

Returns

Aws::String with a user-agent

CreateBidirectionalEventStreamTask()

template<typename OutcomeT , typename ClientT , typename AWSEndpointT , typename RequestT , typename HandlerT >

static BidirectionalEventStreamingTask< OutcomeT, ClientT, AWSEndpointT, RequestT, HandlerT > Aws::Client::CreateBidirectionalEventStreamTask ( const ClientT *  pClientThis,

AWSEndpointT &&  endpoint,

const std::shared_ptr< RequestT > &  pRequest,

const HandlerT &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  handlerContext,

const std::shared_ptr< Utils::Event::EventEncoderStream > &  stream,

const Http::HttpMethod  method = Aws::Http::HttpMethod::HTTP_POST,

char const *const  signerName = Aws::Auth::EVENTSTREAM_SIGV4_SIGNER 

)

static

Definition at line 131 of file AWSClientEventStreamingAsyncTask.h.

FilterUserAgentToken()

AWS_CORE_API Aws::String Aws::Client::FilterUserAgentToken ( char const *const  token)

GetAuthorizationHeader()

AWS_CORE_API Aws::String Aws::Client::GetAuthorizationHeader ( const Aws::Http::HttpRequest &  httpRequest)

GetCompressionAlgorithmId()

Aws::String AWS_CORE_API Aws::Client::GetCompressionAlgorithmId ( const CompressionAlgorithm &  algorithm)

Converts a compression Algorithms enum to String to be used as content-type header value when compressing a request.

Parameters

algorithm

Returns

string with HTTP content type algorithm id

InitRetryStrategy()

std::shared_ptr< RetryStrategy > Aws::Client::InitRetryStrategy ( Aws::String  retryMode = "")

A helper function to initialize a retry strategy. Default is DefaultRetryStrategy (i.e. exponential backoff)

MakeAsyncOperation() [1/2]

template<typename ClientT , typename HandlerT , typename HandlerContextT , typename OperationFuncT , typename ExecutorT >

void AWS_CORE_LOCAL Aws::Client::MakeAsyncOperation ( OperationFuncT &&  operationFunc,

const ClientT *  clientThis,

const HandlerT &  handler,

const HandlerContextT &  context,

ExecutorT *  pExecutor 

)

inline

A template function to create an Async Operation function body for AWS Operation without a request on input.

Definition at line 86 of file AWSAsyncOperationTemplate.h.

MakeAsyncOperation() [2/2]

template<typename ClientT , typename RequestT , typename HandlerT , typename HandlerContextT , typename OperationFuncT , typename ExecutorT >

void AWS_CORE_LOCAL Aws::Client::MakeAsyncOperation ( OperationFuncT &&  operationFunc,

const ClientT *  clientThis,

const RequestT &  request,

const HandlerT &  handler,

const HandlerContextT &  context,

ExecutorT *  pExecutor 

)

inline

A template function that is used to create an Async Operation function body for AWS Operations

Definition at line 28 of file AWSAsyncOperationTemplate.h.

MakeAsyncStreamingOperation()

template<typename ClientT , typename RequestT , typename HandlerT , typename HandlerContextT , typename OperationFuncT , typename ExecutorT >

void AWS_CORE_LOCAL Aws::Client::MakeAsyncStreamingOperation ( OperationFuncT &&  operationFunc,

const ClientT *  clientThis,

RequestT &  request,

const HandlerT &  handler,

const HandlerContextT &  context,

ExecutorT *  pExecutor 

)

inline

A template function that is used to create an Async Operation function body for AWS Streaming Operations The only difference compared to a regular non-streaming Operation is that the request is passed by non-const reference, therefore virtual copy constructor is not needed. However, caller code must ensure the life time of the request object is maintained during the Async execution.

Definition at line 59 of file AWSAsyncOperationTemplate.h.

MakeCallableOperation() [1/2]

template<typename ClientT , typename RequestT , typename OperationFuncT , typename ExecutorT >

auto AWS_CORE_LOCAL Aws::Client::MakeCallableOperation ( const char *  ALLOCATION_TAG,

OperationFuncT &&  operationFunc,

const ClientT *  clientThis,

const RequestT &  request,

ExecutorT *  pExecutor 

) -> std::future<decltype((clientThis->*operationFunc)(request))>

inline

A template function that is used to create a Callable Operation function body for AWS Operations

Definition at line 110 of file AWSAsyncOperationTemplate.h.

MakeCallableOperation() [2/2]

template<typename ClientT , typename OperationFuncT , typename ExecutorT >

auto AWS_CORE_LOCAL Aws::Client::MakeCallableOperation ( const char *  ALLOCATION_TAG,

OperationFuncT &&  operationFunc,

const ClientT *  clientThis,

ExecutorT *  pExecutor 

) -> std::future<decltype((clientThis->*operationFunc)())>

inline

A template function that is used to create a Callable Operation function body for AWS Operation without a request on input.

Definition at line 169 of file AWSAsyncOperationTemplate.h.

MakeCallableStreamingOperation()

template<typename ClientT , typename RequestT , typename OperationFuncT , typename ExecutorT >

auto AWS_CORE_LOCAL Aws::Client::MakeCallableStreamingOperation ( const char *  ALLOCATION_TAG,

OperationFuncT &&  operationFunc,

const ClientT *  clientThis,

RequestT &  request,

ExecutorT *  pExecutor 

) -> std::future<decltype((clientThis->*operationFunc)(request))>

inline

A template function that is used to create a Callable Operation function body for AWS Streaming Operations The only difference compared to a regular non-streaming Operation is that the request is passed by non-const reference, therefore virtual copy constructor is not needed. However, caller code must ensure the life time of the request object is maintained during the Async execution.

Definition at line 142 of file AWSAsyncOperationTemplate.h.

operator<<() [1/2]

AWS_CORE_API Aws::OStream & Aws::Client::operator<< ( Aws::OStream &  oStream,

CoreErrors  code 

)

Overload ostream operator<< for CoreErrors enum class for a prettier output such as "128"

operator<<() [2/2]

template<typename T >

Aws::OStream & Aws::Client::operator<< ( Aws::OStream &  s,

const AWSError< T > &  e 

)

Definition at line 265 of file AWSError.h.

Variable Documentation

NO_RETRY_INCREMENT

const int Aws::Client::NO_RETRY_INCREMENT = 1

static

Definition at line 27 of file RetryStrategy.h.