Aws::Client::AWSXMLClient Class Reference

#include <AWSClient.h>

Inheritance diagram for Aws::Client::AWSXMLClient:

Public Types
typedef AWSClient	BASECLASS

Public Member Functions
	AWSXMLClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
	AWSXMLClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
virtual	~AWSXMLClient ()=default
Public Member Functions inherited from Aws::Client::AWSClient
	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
virtual AWSError< CoreErrors >	BuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
XmlOutcome	MakeRequest (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
XmlOutcome	MakeRequest (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
XmlOutcome	MakeRequestWithEventStream (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *singerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
XmlOutcome	MakeRequestWithEventStream (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 Member Functions inherited from Aws::Client::AWSClient
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 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

Additional Inherited Members
Protected Attributes inherited from Aws::Client::AWSClient
Aws::String	m_region

Detailed Description

AWSClient that handles marshalling xml response bodies. You would inherit from this class to create a client that uses Xml as its payload format.

Definition at line 402 of file AWSClient.h.

Member Typedef Documentation

BASECLASS

typedef AWSClient Aws::Client::AWSXMLClient::BASECLASS

Definition at line 406 of file AWSClient.h.

Constructor & Destructor Documentation

AWSXMLClient() [1/2]

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

AWSXMLClient() [2/2]

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

~AWSXMLClient()

virtual Aws::Client::AWSXMLClient::~AWSXMLClient ( )

virtualdefault

Member Function Documentation

BuildAWSError()

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

overrideprotectedvirtual

Converts/Parses an http response into a meaningful AWSError object. Using the XML message structure.

Implements Aws::Client::AWSClient.

MakeRequest() [1/2]

XmlOutcome Aws::Client::AWSXMLClient::MakeRequest ( 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

Returns an xml document or an error from the request. Does some marshalling xml and raw streams, then just calls AttemptExhaustively.

method defaults to POST

MakeRequest() [2/2]

XmlOutcome Aws::Client::AWSXMLClient::MakeRequest ( 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

Returns an xml document or an error from the request. Does some marshalling xml and raw streams, then just calls AttemptExhaustively.

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

method defaults to POST

MakeRequestWithEventStream() [1/2]

XmlOutcome Aws::Client::AWSXMLClient::MakeRequestWithEventStream ( const Aws::Http::URI &  uri, const Aws::AmazonWebServiceRequest &  request, Http::HttpMethod  method = Http::HttpMethod::HTTP_POST, const char *  singerName = Aws::Auth::SIGV4_SIGNER, const char *  signerRegionOverride = nullptr, const char *  signerServiceNameOverride = nullptr  ) const

protected

This is used for event stream response.

MakeRequestWithEventStream() [2/2]

XmlOutcome Aws::Client::AWSXMLClient::MakeRequestWithEventStream ( 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 event stream response. requestName is used for metrics and defaults to empty string, to avoid empty names in metrics provide a valid name.

---

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

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