#include <AWSClient.h>

Inheritance diagram for Aws::Client::AWSClient:

Public Member Functions
	AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

	AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

virtual	~AWSClient ()

Aws::String	GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)

Aws::String	GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)

Aws::String	GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const

Aws::String	GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)

Aws::String	GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char region, const char serviceName, long long expirationInSeconds=0) const

Aws::String	GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char region, const char serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)

Aws::String	GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char region, const char serviceName, const char *signerName, long long expirationInSeconds=0) const

Aws::String	GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char region, const char serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)

Aws::String	GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const

Aws::String	GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char region, const char serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const

Aws::String	GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char region, const char serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const

Aws::String	GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const

void	DisableRequestProcessing ()

void	EnableRequestProcessing ()

virtual const char *	GetServiceClientName () const

virtual void	SetServiceClientName (const Aws::String &name)

Protected Member Functions
HttpResponseOutcome	AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char signerName, const char signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

HttpResponseOutcome	AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char signerName, const char requestName="", const char signerRegionOverride=nullptr, const char signerServiceNameOverride=nullptr) const

HttpResponseOutcome	AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char signerName, const char signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

HttpResponseOutcome	AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char signerName, const char requestName="", const char signerRegionOverride=nullptr, const char signerServiceNameOverride=nullptr) const

StreamOutcome	MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char signerName=Aws::Auth::SIGV4_SIGNER, const char signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

StreamOutcome	MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char signerName=Aws::Auth::SIGV4_SIGNER, const char requestName="", const char signerRegionOverride=nullptr, const char signerServiceNameOverride=nullptr) const

virtual AWSError< CoreErrors >	BuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const =0

virtual void	BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const

const std::shared_ptr< AWSErrorMarshaller > &	GetErrorMarshaller () const

Aws::Client::AWSAuthSigner *	GetSignerByName (const char *name) const

std::shared_ptr< Aws::Http::HttpRequest >	BuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const

std::shared_ptr< Aws::Http::HttpResponse >	MakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const

Protected Attributes
Aws::String	m_region

Detailed Description

Abstract AWS Client. Contains most of the functionality necessary to build an http request, get it signed, and send it accross the wire.

Definition at line 85 of file AWSClient.h.

Constructor & Destructor Documentation

◆ AWSClient() [1/2]

Aws::Client::AWSClient::AWSClient	(	const Aws::Client::ClientConfiguration &	configuration,
		const std::shared_ptr< Aws::Client::AWSAuthSigner > &	signer,
		const std::shared_ptr< AWSErrorMarshaller > &	errorMarshaller
	)

configuration will be used for http client settings, retry strategy, throttles, and signing information. supplied signer will be used for all requests, aws sdk clients will use default AuthV4Signer. errorMarshaller tells the client how to convert error payloads into AWSError objects.

◆ AWSClient() [2/2]

Aws::Client::AWSClient::AWSClient	(	const Aws::Client::ClientConfiguration &	configuration,
		const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &	signerProvider,
		const std::shared_ptr< AWSErrorMarshaller > &	errorMarshaller
	)

Configuration will be used for http client settings, retry strategy, throttles, and signing information. Pass a signer provider to determine the proper signer for a given request; AWS services will use SigV4 signer. errorMarshaller tells the client how to convert error payloads into AWSError objects.

◆ ~AWSClient()

virtual Aws::Client::AWSClient::~AWSClient ( )

inlinevirtual

Definition at line 106 of file AWSClient.h.

Member Function Documentation

◆ AttemptExhaustively() [1/2]

HttpResponseOutcome Aws::Client::AWSClient::AttemptExhaustively	(	const Aws::Http::URI &	uri,
		const Aws::AmazonWebServiceRequest &	request,
		Http::HttpMethod	httpMethod,
		const char *	signerName,
		const char *	signerRegionOverride = `nullptr`,
		const char *	signerServiceNameOverride = `nullptr`
	)		const

protected

Calls AttemptOneRequest until it either, succeeds, runs out of retries from the retry strategy, or encounters and error that is not retryable.

◆ AttemptExhaustively() [2/2]

HttpResponseOutcome Aws::Client::AWSClient::AttemptExhaustively	(	const Aws::Http::URI &	uri,
		Http::HttpMethod	httpMethod,
		const char *	signerName,
		const char *	requestName = `""`,
		const char *	signerRegionOverride = `nullptr`,
		const char *	signerServiceNameOverride = `nullptr`
	)		const

protected

Calls AttemptOneRequest until it either, succeeds, runs out of retries from the retry strategy, or encounters and error that is not retryable. This method is for payloadless requests e.g. GET, DELETE, HEAD

requestName is used for metrics and defaults to empty string, to avoid empty names in metrics provide a valid name.

◆ AttemptOneRequest() [1/2]

HttpResponseOutcome Aws::Client::AWSClient::AttemptOneRequest	(	const std::shared_ptr< Http::HttpRequest > &	httpRequest,
		const Aws::AmazonWebServiceRequest &	request,
		const char *	signerName,
		const char *	signerRegionOverride = `nullptr`,
		const char *	signerServiceNameOverride = `nullptr`
	)		const

protected

Build an Http Request from the AmazonWebServiceRequest object. Signs the request, sends it accross the wire then reports the http response.

◆ AttemptOneRequest() [2/2]

HttpResponseOutcome Aws::Client::AWSClient::AttemptOneRequest	(	const std::shared_ptr< Http::HttpRequest > &	httpRequest,
		const char *	signerName,
		const char *	requestName = `""`,
		const char *	signerRegionOverride = `nullptr`,
		const char *	signerServiceNameOverride = `nullptr`
	)		const

protected

Signs an Http Request, sends it accross the wire then reports the http response. This method is for payloadless requests e.g. GET, DELETE, HEAD

requestName is used for metrics and defaults to empty string, to avoid empty names in metrics provide a valid name.

◆ BuildAndSignHttpRequest()

std::shared_ptr<Aws::Http::HttpRequest> Aws::Client::AWSClient::BuildAndSignHttpRequest	(	const Aws::Http::URI &	uri,
		const Aws::AmazonWebServiceRequest &	request,
		Http::HttpMethod	method,
		const char *	signerName
	)		const

protected

Creates an HttpRequest instance with the given URI and sets the proper headers from the AmazonWebRequest, and finally signs that request with the given the signer. The similar member function BuildHttpRequest() does not sign the request. This member function is used internally only by clients that perform requests (input operations) using event-streams.

◆ BuildAWSError()

virtual AWSError<CoreErrors> Aws::Client::AWSClient::BuildAWSError ( const std::shared_ptr< Aws::Http::HttpResponse > & response ) const

protectedpure virtual

Abstract. Subclassing clients should override this to tell the client how to marshall error payloads

Implemented in Aws::Client::AWSXMLClient, and Aws::Client::AWSJsonClient.

◆ BuildHttpRequest()

virtual void Aws::Client::AWSClient::BuildHttpRequest	(	const Aws::AmazonWebServiceRequest &	request,
		const std::shared_ptr< Aws::Http::HttpRequest > &	httpRequest
	)		const

protectedvirtual

Transforms the AmazonWebServicesResult object into an HttpRequest.

◆ DisableRequestProcessing()

void Aws::Client::AWSClient::DisableRequestProcessing ( )

Stop all requests immediately. In flight requests will likely fail.

◆ EnableRequestProcessing()

void Aws::Client::AWSClient::EnableRequestProcessing ( )

Enable/ReEnable requests.

◆ GeneratePresignedUrl() [1/12]

Aws::String Aws::Client::AWSClient::GeneratePresignedUrl	(	Aws::Http::URI &	uri,
		Aws::Http::HttpMethod	method,
		const Aws::Http::HeaderValueCollection &	customizedHeaders,
		long long	expirationInSeconds = `0`
	)

Generates a signed Uri using the injected signer. for the supplied uri, http method and customized headers. expirationInSeconds defaults to 0 which is the default 7 days. The implication of this function is using auth signer v4 to sign it.

◆ GeneratePresignedUrl() [2/12]

Aws::String Aws::Client::AWSClient::GeneratePresignedUrl	(	Aws::Http::URI &	uri,
		Aws::Http::HttpMethod	method,
		const char *	region,
		const Aws::Http::HeaderValueCollection &	customizedHeaders,
		long long	expirationInSeconds = `0`
	)

Generates a signed Uri using the injected signer. for the supplied uri, http method and customized headers. expirationInSeconds defaults to 0 which is the default 7 days.

◆ GeneratePresignedUrl() [3/12]

Aws::String Aws::Client::AWSClient::GeneratePresignedUrl	(	Aws::Http::URI &	uri,
		Aws::Http::HttpMethod	method,
		const char *	region,
		const char *	serviceName,
		const Aws::Http::HeaderValueCollection &	customizedHeaders,
		long long	expirationInSeconds = `0`
	)

Generates a signed Uri using the injected signer. for the supplied uri, http method and customized headers. expirationInSeconds defaults to 0 which is the default 7 days.

◆ GeneratePresignedUrl() [4/12]

Aws::String Aws::Client::AWSClient::GeneratePresignedUrl	(	Aws::Http::URI &	uri,
		Aws::Http::HttpMethod	method,
		const char *	region,
		const char *	serviceName,
		const char *	signerName,
		const Aws::Http::HeaderValueCollection &	customizedHeaders,
		long long	expirationInSeconds = `0`
	)

Generates a signed Uri using the injected signer. for the supplied uri, http method, region, service name, signer name and customized headers. expirationInSeconds defaults to 0 which is the default 7 days.

◆ GeneratePresignedUrl() [5/12]

Aws::String Aws::Client::AWSClient::GeneratePresignedUrl	(	Aws::Http::URI &	uri,
		Aws::Http::HttpMethod	method,
		const char *	region,
		const char *	serviceName,
		const char *	signerName,
		long long	expirationInSeconds = `0`
	)		const

Generates a signed Uri using the injected signer. for the supplied uri and http method, region, service name and signer name. expirationInSeconds defaults to 0 which is the default 7 days.

◆ GeneratePresignedUrl() [6/12]

Aws::String Aws::Client::AWSClient::GeneratePresignedUrl	(	Aws::Http::URI &	uri,
		Aws::Http::HttpMethod	method,
		const char *	region,
		const char *	serviceName,
		long long	expirationInSeconds = `0`
	)		const

Generates a signed Uri using the injected signer. for the supplied uri and http method, region, and service name. expirationInSeconds defaults to 0 which is the default 7 days.

◆ GeneratePresignedUrl() [7/12]

Aws::String Aws::Client::AWSClient::GeneratePresignedUrl	(	Aws::Http::URI &	uri,
		Aws::Http::HttpMethod	method,
		const char *	region,
		long long	expirationInSeconds = `0`
	)		const

Generates a signed Uri using the injected signer. for the supplied uri and http method and region. expirationInSeconds defaults to 0 which is the default 7 days.

◆ GeneratePresignedUrl() [8/12]

Aws::String Aws::Client::AWSClient::GeneratePresignedUrl	(	Aws::Http::URI &	uri,
		Aws::Http::HttpMethod	method,
		long long	expirationInSeconds = `0`
	)

Generates a signed Uri using the injected signer. for the supplied uri and http method. expirationInSeconds defaults to 0 which is the default 7 days. The implication of this function is using auth signer v4 to sign it.

◆ GeneratePresignedUrl() [9/12]

Aws::String Aws::Client::AWSClient::GeneratePresignedUrl	(	const Aws::AmazonWebServiceRequest &	request,
		Aws::Http::URI &	uri,
		Aws::Http::HttpMethod	method,
		const Aws::Http::QueryStringParameterCollection &	extraParams = `Aws::Http::QueryStringParameterCollection()`,
		long long	expirationInSeconds = `0`
	)		const

◆ GeneratePresignedUrl() [10/12]

Aws::String Aws::Client::AWSClient::GeneratePresignedUrl	(	const Aws::AmazonWebServiceRequest &	request,
		Aws::Http::URI &	uri,
		Aws::Http::HttpMethod	method,
		const char *	region,
		const Aws::Http::QueryStringParameterCollection &	extraParams = `Aws::Http::QueryStringParameterCollection()`,
		long long	expirationInSeconds = `0`
	)		const

◆ GeneratePresignedUrl() [11/12]

Aws::String Aws::Client::AWSClient::GeneratePresignedUrl	(	const Aws::AmazonWebServiceRequest &	request,
		Aws::Http::URI &	uri,
		Aws::Http::HttpMethod	method,
		const char *	region,
		const char *	serviceName,
		const Aws::Http::QueryStringParameterCollection &	extraParams = `Aws::Http::QueryStringParameterCollection()`,
		long long	expirationInSeconds = `0`
	)		const

◆ GeneratePresignedUrl() [12/12]

Aws::String Aws::Client::AWSClient::GeneratePresignedUrl	(	const Aws::AmazonWebServiceRequest &	request,
		Aws::Http::URI &	uri,
		Aws::Http::HttpMethod	method,
		const char *	region,
		const char *	serviceName,
		const char *	signerName,
		const Aws::Http::QueryStringParameterCollection &	extraParams = `Aws::Http::QueryStringParameterCollection()`,
		long long	expirationInSeconds = `0`
	)		const

◆ GetErrorMarshaller()

const std::shared_ptr<AWSErrorMarshaller>& Aws::Client::AWSClient::GetErrorMarshaller ( ) const

inlineprotected

Gets the underlying ErrorMarshaller for subclasses to use.

Definition at line 275 of file AWSClient.h.

◆ GetServiceClientName()

virtual const char* Aws::Client::AWSClient::GetServiceClientName ( ) const

inlinevirtual

Definition at line 179 of file AWSClient.h.

◆ GetSignerByName()

Aws::Client::AWSAuthSigner* Aws::Client::AWSClient::GetSignerByName ( const char * name ) const

protected

Gets the corresponding signer from the signers map by name.

◆ MakeHttpRequest()

std::shared_ptr<Aws::Http::HttpResponse> Aws::Client::AWSClient::MakeHttpRequest ( std::shared_ptr< Aws::Http::HttpRequest > & request ) const

protected

Performs the HTTP request via the HTTP client while enforcing rate limiters

◆ MakeRequestWithUnparsedResponse() [1/2]

StreamOutcome Aws::Client::AWSClient::MakeRequestWithUnparsedResponse	(	const Aws::Http::URI &	uri,
		const Aws::AmazonWebServiceRequest &	request,
		Http::HttpMethod	method = `Http::HttpMethod::HTTP_POST`,
		const char *	signerName = `Aws::Auth::SIGV4_SIGNER`,
		const char *	signerRegionOverride = `nullptr`,
		const char *	signerServiceNameOverride = `nullptr`
	)		const

protected

This is used for structureless response payloads (file streams, binary data etc...). It calls AttemptExhaustively, but upon return transfers ownership of the underlying stream for the http response to the caller.

◆ MakeRequestWithUnparsedResponse() [2/2]

StreamOutcome Aws::Client::AWSClient::MakeRequestWithUnparsedResponse	(	const Aws::Http::URI &	uri,
		Http::HttpMethod	method = `Http::HttpMethod::HTTP_POST`,
		const char *	signerName = `Aws::Auth::SIGV4_SIGNER`,
		const char *	requestName = `""`,
		const char *	signerRegionOverride = `nullptr`,
		const char *	signerServiceNameOverride = `nullptr`
	)		const

protected

This is used for structureless response payloads (file streams, binary data etc...). It calls AttemptExhaustively, but upon return transfers ownership of the underlying stream for the http response to the caller.

requestName is used for metrics and defaults to empty string, to avoid empty names in metrics provide a valid name.

◆ SetServiceClientName()

virtual void Aws::Client::AWSClient::SetServiceClientName ( const Aws::String & name )

virtual

service client name is part of userAgent. We need to update userAgent after setting this name if it's not pre-set by customer. Note: this API should only be called in your extended class constructors.

Member Data Documentation

◆ m_region

Aws::String Aws::Client::AWSClient::m_region

protected

Definition at line 301 of file AWSClient.h.

The documentation for this class was generated from the following file:

aws-cpp-sdk-core/include/aws/core/client/AWSClient.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AWSClient() [1/2]

◆ AWSClient() [2/2]

◆ ~AWSClient()

Member Function Documentation

◆ AttemptExhaustively() [1/2]

◆ AttemptExhaustively() [2/2]

◆ AttemptOneRequest() [1/2]

◆ AttemptOneRequest() [2/2]

◆ BuildAndSignHttpRequest()

◆ BuildAWSError()

◆ BuildHttpRequest()

◆ DisableRequestProcessing()

◆ EnableRequestProcessing()

◆ GeneratePresignedUrl() [1/12]

◆ GeneratePresignedUrl() [2/12]

◆ GeneratePresignedUrl() [3/12]

◆ GeneratePresignedUrl() [4/12]

◆ GeneratePresignedUrl() [5/12]

◆ GeneratePresignedUrl() [6/12]

◆ GeneratePresignedUrl() [7/12]

◆ GeneratePresignedUrl() [8/12]

◆ GeneratePresignedUrl() [9/12]

◆ GeneratePresignedUrl() [10/12]

◆ GeneratePresignedUrl() [11/12]

◆ GeneratePresignedUrl() [12/12]

◆ GetErrorMarshaller()

◆ GetServiceClientName()

◆ GetSignerByName()

◆ MakeHttpRequest()

◆ MakeRequestWithUnparsedResponse() [1/2]

◆ MakeRequestWithUnparsedResponse() [2/2]

◆ SetServiceClientName()

Member Data Documentation

◆ m_region