#include <AWSError.h>

Public Member Functions

AWSError ()

AWSError (ERROR_TYPE errorType, Aws::String exceptionName, Aws::String message, bool isRetryable)

AWSError (ERROR_TYPE errorType, bool isRetryable)

AWSError (ERROR_TYPE errorType, RetryableType retryableType, Aws::String exceptionName="", Aws::String message="")

AWSError (AWSError &&)=default

AWSError (const AWSError &)=default

template<typename OTHER_ERROR_TYPE >

AWSError (AWSError< OTHER_ERROR_TYPE > &&rhs)

template<typename OTHER_ERROR_TYPE >

AWSError (const AWSError< OTHER_ERROR_TYPE > &rhs)

AWSError & operator= (const AWSError< ERROR_TYPE > &)=default

AWSError & operator= (AWSError< ERROR_TYPE > &&)=default

const ERROR_TYPE GetErrorType () const

const Aws::String & GetExceptionName () const

void SetExceptionName (const Aws::String &exceptionName)

const Aws::String & GetMessage () const

void SetMessage (const Aws::String &message)

const Aws::String & GetRemoteHostIpAddress () const

void SetRemoteHostIpAddress (const Aws::String &remoteHostIpAddress)

const Aws::String & GetRequestId () const

void SetRequestId (const Aws::String &requestId)

bool ShouldRetry () const

const Aws::Http::HeaderValueCollection & GetResponseHeaders () const

void SetResponseHeaders (const Aws::Http::HeaderValueCollection &headers)

bool ResponseHeaderExists (const Aws::String &headerName) const

Aws::Http::HttpResponseCode GetResponseCode () const

void SetResponseCode (Aws::Http::HttpResponseCode responseCode)

bool ShouldThrottle () const

void SetRetryableType (const RetryableType retryableType)

Protected Member Functions

ErrorPayloadType GetErrorPayloadType ()

void SetXmlPayload (const Aws::Utils::Xml::XmlDocument &xmlPayload)

void SetXmlPayload (Aws::Utils::Xml::XmlDocument &&xmlPayload)

const Aws::Utils::Xml::XmlDocument & GetXmlPayload () const

void SetJsonPayload (const Aws::Utils::Json::JsonValue &jsonPayload)

void SetJsonPayload (Aws::Utils::Json::JsonValue &&jsonPayload)

const Aws::Utils::Json::JsonValue & GetJsonPayload () const

Friends

class XmlErrorMarshaller

class JsonErrorMarshaller

class JsonErrorMarshallerQueryCompatible

template<typename T >

class AWSError

Detailed Description

template<typename ERROR_TYPE>
class Aws::Client::AWSError< ERROR_TYPE >

Container for Error enumerations with additional exception information. Name, message, retryable etc....

Definition at line 41 of file AWSError.h.

Constructor & Destructor Documentation

◆ AWSError() [1/8]

template<typename ERROR_TYPE >

Aws::Client::AWSError< ERROR_TYPE >::AWSError ( )

inline

Initializes AWSError object as empty with the error not being retryable.

Definition at line 52 of file AWSError.h.

◆ AWSError() [2/8]

template<typename ERROR_TYPE >

Aws::Client::AWSError< ERROR_TYPE >::AWSError ( ERROR_TYPE errorType,

Aws::String exceptionName,

Aws::String message,

bool isRetryable

)

inline

Initializes AWSError object with errorType, exceptionName, message, and retryable type.

Definition at line 59 of file AWSError.h.

◆ AWSError() [3/8]

template<typename ERROR_TYPE >

Aws::Client::AWSError< ERROR_TYPE >::AWSError ( ERROR_TYPE errorType,

bool isRetryable

)

inline

Initializes AWSError object with errorType and retryable flag. ExceptionName and message are empty.

Definition at line 72 of file AWSError.h.

◆ AWSError() [4/8]

template<typename ERROR_TYPE >

Aws::Client::AWSError< ERROR_TYPE >::AWSError ( ERROR_TYPE errorType,

RetryableType retryableType,

Aws::String exceptionName = "",

Aws::String message = ""

)

inline

Initializes AWSError object with errorType and retryable type. ExceptionName and message are empty.

Definition at line 81 of file AWSError.h.

◆ AWSError() [5/8]

template<typename ERROR_TYPE >

Aws::Client::AWSError< ERROR_TYPE >::AWSError ( AWSError< ERROR_TYPE > && )

default

◆ AWSError() [6/8]

template<typename ERROR_TYPE >

Aws::Client::AWSError< ERROR_TYPE >::AWSError ( const AWSError< ERROR_TYPE > & )

default

◆ AWSError() [7/8]

template<typename ERROR_TYPE >

template<typename OTHER_ERROR_TYPE >

Aws::Client::AWSError< ERROR_TYPE >::AWSError ( AWSError< OTHER_ERROR_TYPE > && rhs)

inline

Definition at line 95 of file AWSError.h.

◆ AWSError() [8/8]

template<typename ERROR_TYPE >

template<typename OTHER_ERROR_TYPE >

Aws::Client::AWSError< ERROR_TYPE >::AWSError ( const AWSError< OTHER_ERROR_TYPE > & rhs)

inline

Definition at line 110 of file AWSError.h.

Member Function Documentation

◆ GetErrorPayloadType()

template<typename ERROR_TYPE >

ErrorPayloadType Aws::Client::AWSError< ERROR_TYPE >::GetErrorPayloadType ( )

inlineprotected

Definition at line 218 of file AWSError.h.

◆ GetErrorType()

template<typename ERROR_TYPE >

const ERROR_TYPE Aws::Client::AWSError< ERROR_TYPE >::GetErrorType ( ) const

inline

Gets underlying errorType.

Definition at line 137 of file AWSError.h.

◆ GetExceptionName()

template<typename ERROR_TYPE >

const Aws::String & Aws::Client::AWSError< ERROR_TYPE >::GetExceptionName ( ) const

inline

Gets the underlying ExceptionName.

Definition at line 141 of file AWSError.h.

◆ GetJsonPayload()

template<typename ERROR_TYPE >

const Aws::Utils::Json::JsonValue & Aws::Client::AWSError< ERROR_TYPE >::GetJsonPayload ( ) const

inlineprotected

Definition at line 244 of file AWSError.h.

◆ GetMessage()

template<typename ERROR_TYPE >

const Aws::String & Aws::Client::AWSError< ERROR_TYPE >::GetMessage ( ) const

inline

Gets the error message.

Definition at line 158 of file AWSError.h.

◆ GetRemoteHostIpAddress()

template<typename ERROR_TYPE >

const Aws::String & Aws::Client::AWSError< ERROR_TYPE >::GetRemoteHostIpAddress ( ) const

inline

Gets the resolved remote host IP address. This value is only available after DNS resolution and with CURL http client right now. Otherwise an empty string is returned.

Definition at line 169 of file AWSError.h.

◆ GetRequestId()

template<typename ERROR_TYPE >

const Aws::String & Aws::Client::AWSError< ERROR_TYPE >::GetRequestId ( ) const

inline

Gets the request ID. This value is available after request is made and when services return it in response. Otherwise an empty string is returned.

Definition at line 179 of file AWSError.h.

◆ GetResponseCode()

template<typename ERROR_TYPE >

Aws::Http::HttpResponseCode Aws::Client::AWSError< ERROR_TYPE >::GetResponseCode ( ) const

inline

Gets the response code from the http response

Definition at line 203 of file AWSError.h.

◆ GetResponseHeaders()

template<typename ERROR_TYPE >

const Aws::Http::HeaderValueCollection & Aws::Client::AWSError< ERROR_TYPE >::GetResponseHeaders ( ) const

inline

Gets the response headers from the http response.

Definition at line 191 of file AWSError.h.

◆ GetXmlPayload()

template<typename ERROR_TYPE >

const Aws::Utils::Xml::XmlDocument & Aws::Client::AWSError< ERROR_TYPE >::GetXmlPayload ( ) const

inlineprotected

Definition at line 229 of file AWSError.h.

◆ operator=() [1/2]

template<typename ERROR_TYPE >

AWSError & Aws::Client::AWSError< ERROR_TYPE >::operator= ( AWSError< ERROR_TYPE > && )

default

Move assignment operator

◆ operator=() [2/2]

template<typename ERROR_TYPE >

AWSError & Aws::Client::AWSError< ERROR_TYPE >::operator= ( const AWSError< ERROR_TYPE > & )

default

Copy assignment operator

◆ ResponseHeaderExists()

template<typename ERROR_TYPE >

bool Aws::Client::AWSError< ERROR_TYPE >::ResponseHeaderExists ( const Aws::String & headerName) const

inline

Tests whether or not a header exists.

Definition at line 199 of file AWSError.h.

◆ SetExceptionName()

template<typename ERROR_TYPE >

void Aws::Client::AWSError< ERROR_TYPE >::SetExceptionName ( const Aws::String & exceptionName)

inline

Sets the underlying ExceptionName.

Definition at line 145 of file AWSError.h.

◆ SetJsonPayload() [1/2]

template<typename ERROR_TYPE >

void Aws::Client::AWSError< ERROR_TYPE >::SetJsonPayload ( Aws::Utils::Json::JsonValue && jsonPayload)

inlineprotected

Definition at line 239 of file AWSError.h.

◆ SetJsonPayload() [2/2]

template<typename ERROR_TYPE >

void Aws::Client::AWSError< ERROR_TYPE >::SetJsonPayload ( const Aws::Utils::Json::JsonValue & jsonPayload)

inlineprotected

Definition at line 234 of file AWSError.h.

◆ SetMessage()

template<typename ERROR_TYPE >

void Aws::Client::AWSError< ERROR_TYPE >::SetMessage ( const Aws::String & message)

inline

Sets the error message

Definition at line 163 of file AWSError.h.

◆ SetRemoteHostIpAddress()

template<typename ERROR_TYPE >

void Aws::Client::AWSError< ERROR_TYPE >::SetRemoteHostIpAddress ( const Aws::String & remoteHostIpAddress)

inline

Sets the resolved remote host IP address.

Definition at line 173 of file AWSError.h.

◆ SetRequestId()

template<typename ERROR_TYPE >

void Aws::Client::AWSError< ERROR_TYPE >::SetRequestId ( const Aws::String & requestId)

inline

Sets the request ID.

Definition at line 183 of file AWSError.h.

◆ SetResponseCode()

template<typename ERROR_TYPE >

void Aws::Client::AWSError< ERROR_TYPE >::SetResponseCode ( Aws::Http::HttpResponseCode responseCode)

inline

Sets the response code from the http response

Definition at line 207 of file AWSError.h.

◆ SetResponseHeaders()

template<typename ERROR_TYPE >

void Aws::Client::AWSError< ERROR_TYPE >::SetResponseHeaders ( const Aws::Http::HeaderValueCollection & headers)

inline

Sets the response headers from the http response.

Definition at line 195 of file AWSError.h.

◆ SetRetryableType()

template<typename ERROR_TYPE >

void Aws::Client::AWSError< ERROR_TYPE >::SetRetryableType ( const RetryableType retryableType)

inline

Sets the response code from the http response

Definition at line 215 of file AWSError.h.

◆ SetXmlPayload() [1/2]

template<typename ERROR_TYPE >

void Aws::Client::AWSError< ERROR_TYPE >::SetXmlPayload ( Aws::Utils::Xml::XmlDocument && xmlPayload)

inlineprotected

Definition at line 224 of file AWSError.h.

◆ SetXmlPayload() [2/2]

template<typename ERROR_TYPE >

void Aws::Client::AWSError< ERROR_TYPE >::SetXmlPayload ( const Aws::Utils::Xml::XmlDocument & xmlPayload)

inlineprotected

Definition at line 219 of file AWSError.h.

◆ ShouldRetry()

template<typename ERROR_TYPE >

bool Aws::Client::AWSError< ERROR_TYPE >::ShouldRetry ( ) const

inline

Returns whether or not this error is eligible for retry.

Definition at line 187 of file AWSError.h.

◆ ShouldThrottle()

template<typename ERROR_TYPE >

bool Aws::Client::AWSError< ERROR_TYPE >::ShouldThrottle ( ) const

inline

Return whether or not the error should throttle retry strategies.

Definition at line 211 of file AWSError.h.

Friends And Related Symbol Documentation

◆ AWSError

template<typename ERROR_TYPE >

template<typename T >

friend class AWSError

friend

Definition at line 47 of file AWSError.h.

◆ JsonErrorMarshaller

template<typename ERROR_TYPE >

friend class JsonErrorMarshaller

friend

Definition at line 45 of file AWSError.h.

◆ JsonErrorMarshallerQueryCompatible

template<typename ERROR_TYPE >

friend class JsonErrorMarshallerQueryCompatible

friend

Definition at line 46 of file AWSError.h.

◆ XmlErrorMarshaller

template<typename ERROR_TYPE >

friend class XmlErrorMarshaller

friend

Definition at line 44 of file AWSError.h.

Member Data Documentation

◆ m_errorPayloadType

template<typename ERROR_TYPE >

ErrorPayloadType Aws::Client::AWSError< ERROR_TYPE >::m_errorPayloadType = ErrorPayloadType::NOT_SET

protected

Definition at line 258 of file AWSError.h.

◆ m_errorType

template<typename ERROR_TYPE >

ERROR_TYPE Aws::Client::AWSError< ERROR_TYPE >::m_errorType

protected

Definition at line 250 of file AWSError.h.

◆ m_exceptionName

template<typename ERROR_TYPE >

Aws::String Aws::Client::AWSError< ERROR_TYPE >::m_exceptionName

protected

Definition at line 251 of file AWSError.h.

◆ m_jsonPayload

template<typename ERROR_TYPE >

Aws::Utils::Json::JsonValue Aws::Client::AWSError< ERROR_TYPE >::m_jsonPayload

protected

Definition at line 260 of file AWSError.h.

◆ m_message

template<typename ERROR_TYPE >

Aws::String Aws::Client::AWSError< ERROR_TYPE >::m_message

protected

Definition at line 252 of file AWSError.h.

◆ m_remoteHostIpAddress

template<typename ERROR_TYPE >

Aws::String Aws::Client::AWSError< ERROR_TYPE >::m_remoteHostIpAddress

protected

Definition at line 253 of file AWSError.h.

◆ m_requestId

template<typename ERROR_TYPE >

Aws::String Aws::Client::AWSError< ERROR_TYPE >::m_requestId

protected

Definition at line 254 of file AWSError.h.

◆ m_responseCode

template<typename ERROR_TYPE >

Aws::Http::HttpResponseCode Aws::Client::AWSError< ERROR_TYPE >::m_responseCode = Aws::Http::HttpResponseCode::REQUEST_NOT_MADE

protected

Definition at line 256 of file AWSError.h.

◆ m_responseHeaders

template<typename ERROR_TYPE >

Aws::Http::HeaderValueCollection Aws::Client::AWSError< ERROR_TYPE >::m_responseHeaders

protected

Definition at line 255 of file AWSError.h.

◆ m_retryableType

template<typename ERROR_TYPE >

RetryableType Aws::Client::AWSError< ERROR_TYPE >::m_retryableType

protected

Definition at line 261 of file AWSError.h.

◆ m_xmlPayload

template<typename ERROR_TYPE >

Aws::Utils::Xml::XmlDocument Aws::Client::AWSError< ERROR_TYPE >::m_xmlPayload

protected

Definition at line 259 of file AWSError.h.

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

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

AWS SDK for C++

AWS SDK for C++ Version 1.11.788

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ AWSError() [1/8]

◆ AWSError() [2/8]

◆ AWSError() [3/8]

◆ AWSError() [4/8]

◆ AWSError() [5/8]

◆ AWSError() [6/8]

◆ AWSError() [7/8]

◆ AWSError() [8/8]

Member Function Documentation

◆ GetErrorPayloadType()

◆ GetErrorType()

◆ GetExceptionName()

◆ GetJsonPayload()

◆ GetMessage()

◆ GetRemoteHostIpAddress()

◆ GetRequestId()

◆ GetResponseCode()

◆ GetResponseHeaders()

◆ GetXmlPayload()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ResponseHeaderExists()

◆ SetExceptionName()

◆ SetJsonPayload() [1/2]

◆ SetJsonPayload() [2/2]

◆ SetMessage()

◆ SetRemoteHostIpAddress()

◆ SetRequestId()

◆ SetResponseCode()

◆ SetResponseHeaders()

◆ SetRetryableType()

◆ SetXmlPayload() [1/2]

◆ SetXmlPayload() [2/2]

◆ ShouldRetry()

◆ ShouldThrottle()

Friends And Related Symbol Documentation

◆ AWSError

◆ JsonErrorMarshaller

◆ JsonErrorMarshallerQueryCompatible

◆ XmlErrorMarshaller

Member Data Documentation

◆ m_errorPayloadType

◆ m_errorType

◆ m_exceptionName

◆ m_jsonPayload

◆ m_message

◆ m_remoteHostIpAddress

◆ m_requestId

◆ m_responseCode

◆ m_responseHeaders

◆ m_retryableType

◆ m_xmlPayload