AWS SDK for C++  1.9.155
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::SNS::Model::SetEndpointAttributesRequest Class Reference

#include <SetEndpointAttributesRequest.h>

+ Inheritance diagram for Aws::SNS::Model::SetEndpointAttributesRequest:

Public Member Functions

 SetEndpointAttributesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetEndpointArn () const
 
bool EndpointArnHasBeenSet () const
 
void SetEndpointArn (const Aws::String &value)
 
void SetEndpointArn (Aws::String &&value)
 
void SetEndpointArn (const char *value)
 
SetEndpointAttributesRequestWithEndpointArn (const Aws::String &value)
 
SetEndpointAttributesRequestWithEndpointArn (Aws::String &&value)
 
SetEndpointAttributesRequestWithEndpointArn (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetAttributes () const
 
bool AttributesHasBeenSet () const
 
void SetAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
SetEndpointAttributesRequestWithAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
SetEndpointAttributesRequestWithAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
SetEndpointAttributesRequestAddAttributes (const Aws::String &key, const Aws::String &value)
 
SetEndpointAttributesRequestAddAttributes (Aws::String &&key, const Aws::String &value)
 
SetEndpointAttributesRequestAddAttributes (const Aws::String &key, Aws::String &&value)
 
SetEndpointAttributesRequestAddAttributes (Aws::String &&key, Aws::String &&value)
 
SetEndpointAttributesRequestAddAttributes (const char *key, Aws::String &&value)
 
SetEndpointAttributesRequestAddAttributes (Aws::String &&key, const char *value)
 
SetEndpointAttributesRequestAddAttributes (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::SNS::SNSRequest
virtual ~SNSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::SNS::SNSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Input for SetEndpointAttributes action.

See Also:

AWS API Reference

Definition at line 25 of file SetEndpointAttributesRequest.h.

Constructor & Destructor Documentation

◆ SetEndpointAttributesRequest()

Aws::SNS::Model::SetEndpointAttributesRequest::SetEndpointAttributesRequest ( )

Member Function Documentation

◆ AddAttributes() [1/7]

SetEndpointAttributesRequest& Aws::SNS::Model::SetEndpointAttributesRequest::AddAttributes ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 232 of file SetEndpointAttributesRequest.h.

◆ AddAttributes() [2/7]

SetEndpointAttributesRequest& Aws::SNS::Model::SetEndpointAttributesRequest::AddAttributes ( Aws::String &&  key,
const Aws::String value 
)
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 202 of file SetEndpointAttributesRequest.h.

◆ AddAttributes() [3/7]

SetEndpointAttributesRequest& Aws::SNS::Model::SetEndpointAttributesRequest::AddAttributes ( Aws::String &&  key,
const char *  value 
)
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 262 of file SetEndpointAttributesRequest.h.

◆ AddAttributes() [4/7]

SetEndpointAttributesRequest& Aws::SNS::Model::SetEndpointAttributesRequest::AddAttributes ( const Aws::String key,
Aws::String &&  value 
)
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 217 of file SetEndpointAttributesRequest.h.

◆ AddAttributes() [5/7]

SetEndpointAttributesRequest& Aws::SNS::Model::SetEndpointAttributesRequest::AddAttributes ( const Aws::String key,
const Aws::String value 
)
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 187 of file SetEndpointAttributesRequest.h.

◆ AddAttributes() [6/7]

SetEndpointAttributesRequest& Aws::SNS::Model::SetEndpointAttributesRequest::AddAttributes ( const char *  key,
Aws::String &&  value 
)
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 247 of file SetEndpointAttributesRequest.h.

◆ AddAttributes() [7/7]

SetEndpointAttributesRequest& Aws::SNS::Model::SetEndpointAttributesRequest::AddAttributes ( const char *  key,
const char *  value 
)
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 277 of file SetEndpointAttributesRequest.h.

◆ AttributesHasBeenSet()

bool Aws::SNS::Model::SetEndpointAttributesRequest::AttributesHasBeenSet ( ) const
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 112 of file SetEndpointAttributesRequest.h.

◆ DumpBodyToUrl()

void Aws::SNS::Model::SetEndpointAttributesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EndpointArnHasBeenSet()

bool Aws::SNS::Model::SetEndpointAttributesRequest::EndpointArnHasBeenSet ( ) const
inline

EndpointArn used for SetEndpointAttributes action.

Definition at line 51 of file SetEndpointAttributesRequest.h.

◆ GetAttributes()

const Aws::Map<Aws::String, Aws::String>& Aws::SNS::Model::SetEndpointAttributesRequest::GetAttributes ( ) const
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 97 of file SetEndpointAttributesRequest.h.

◆ GetEndpointArn()

const Aws::String& Aws::SNS::Model::SetEndpointAttributesRequest::GetEndpointArn ( ) const
inline

EndpointArn used for SetEndpointAttributes action.

Definition at line 46 of file SetEndpointAttributesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SNS::Model::SetEndpointAttributesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file SetEndpointAttributesRequest.h.

◆ SerializePayload()

Aws::String Aws::SNS::Model::SetEndpointAttributesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributes() [1/2]

void Aws::SNS::Model::SetEndpointAttributesRequest::SetAttributes ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 142 of file SetEndpointAttributesRequest.h.

◆ SetAttributes() [2/2]

void Aws::SNS::Model::SetEndpointAttributesRequest::SetAttributes ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 127 of file SetEndpointAttributesRequest.h.

◆ SetEndpointArn() [1/3]

void Aws::SNS::Model::SetEndpointAttributesRequest::SetEndpointArn ( Aws::String &&  value)
inline

EndpointArn used for SetEndpointAttributes action.

Definition at line 61 of file SetEndpointAttributesRequest.h.

◆ SetEndpointArn() [2/3]

void Aws::SNS::Model::SetEndpointAttributesRequest::SetEndpointArn ( const Aws::String value)
inline

EndpointArn used for SetEndpointAttributes action.

Definition at line 56 of file SetEndpointAttributesRequest.h.

◆ SetEndpointArn() [3/3]

void Aws::SNS::Model::SetEndpointAttributesRequest::SetEndpointArn ( const char *  value)
inline

EndpointArn used for SetEndpointAttributes action.

Definition at line 66 of file SetEndpointAttributesRequest.h.

◆ WithAttributes() [1/2]

SetEndpointAttributesRequest& Aws::SNS::Model::SetEndpointAttributesRequest::WithAttributes ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 172 of file SetEndpointAttributesRequest.h.

◆ WithAttributes() [2/2]

SetEndpointAttributesRequest& Aws::SNS::Model::SetEndpointAttributesRequest::WithAttributes ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Definition at line 157 of file SetEndpointAttributesRequest.h.

◆ WithEndpointArn() [1/3]

SetEndpointAttributesRequest& Aws::SNS::Model::SetEndpointAttributesRequest::WithEndpointArn ( Aws::String &&  value)
inline

EndpointArn used for SetEndpointAttributes action.

Definition at line 76 of file SetEndpointAttributesRequest.h.

◆ WithEndpointArn() [2/3]

SetEndpointAttributesRequest& Aws::SNS::Model::SetEndpointAttributesRequest::WithEndpointArn ( const Aws::String value)
inline

EndpointArn used for SetEndpointAttributes action.

Definition at line 71 of file SetEndpointAttributesRequest.h.

◆ WithEndpointArn() [3/3]

SetEndpointAttributesRequest& Aws::SNS::Model::SetEndpointAttributesRequest::WithEndpointArn ( const char *  value)
inline

EndpointArn used for SetEndpointAttributes action.

Definition at line 81 of file SetEndpointAttributesRequest.h.


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