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

#include <SetSubscriptionAttributesRequest.h>

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

Public Member Functions

 SetSubscriptionAttributesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetSubscriptionArn () const
 
bool SubscriptionArnHasBeenSet () const
 
void SetSubscriptionArn (const Aws::String &value)
 
void SetSubscriptionArn (Aws::String &&value)
 
void SetSubscriptionArn (const char *value)
 
SetSubscriptionAttributesRequestWithSubscriptionArn (const Aws::String &value)
 
SetSubscriptionAttributesRequestWithSubscriptionArn (Aws::String &&value)
 
SetSubscriptionAttributesRequestWithSubscriptionArn (const char *value)
 
const Aws::StringGetAttributeName () const
 
bool AttributeNameHasBeenSet () const
 
void SetAttributeName (const Aws::String &value)
 
void SetAttributeName (Aws::String &&value)
 
void SetAttributeName (const char *value)
 
SetSubscriptionAttributesRequestWithAttributeName (const Aws::String &value)
 
SetSubscriptionAttributesRequestWithAttributeName (Aws::String &&value)
 
SetSubscriptionAttributesRequestWithAttributeName (const char *value)
 
const Aws::StringGetAttributeValue () const
 
bool AttributeValueHasBeenSet () const
 
void SetAttributeValue (const Aws::String &value)
 
void SetAttributeValue (Aws::String &&value)
 
void SetAttributeValue (const char *value)
 
SetSubscriptionAttributesRequestWithAttributeValue (const Aws::String &value)
 
SetSubscriptionAttributesRequestWithAttributeValue (Aws::String &&value)
 
SetSubscriptionAttributesRequestWithAttributeValue (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 SetSubscriptionAttributes action.

See Also:

AWS API Reference

Definition at line 24 of file SetSubscriptionAttributesRequest.h.

Constructor & Destructor Documentation

◆ SetSubscriptionAttributesRequest()

Aws::SNS::Model::SetSubscriptionAttributesRequest::SetSubscriptionAttributesRequest ( )

Member Function Documentation

◆ AttributeNameHasBeenSet()

bool Aws::SNS::Model::SetSubscriptionAttributesRequest::AttributeNameHasBeenSet ( ) const
inline

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

Definition at line 123 of file SetSubscriptionAttributesRequest.h.

◆ AttributeValueHasBeenSet()

bool Aws::SNS::Model::SetSubscriptionAttributesRequest::AttributeValueHasBeenSet ( ) const
inline

The new value for the attribute in JSON format.

Definition at line 260 of file SetSubscriptionAttributesRequest.h.

◆ DumpBodyToUrl()

void Aws::SNS::Model::SetSubscriptionAttributesRequest::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.

◆ GetAttributeName()

const Aws::String& Aws::SNS::Model::SetSubscriptionAttributesRequest::GetAttributeName ( ) const
inline

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

Definition at line 102 of file SetSubscriptionAttributesRequest.h.

◆ GetAttributeValue()

const Aws::String& Aws::SNS::Model::SetSubscriptionAttributesRequest::GetAttributeValue ( ) const
inline

The new value for the attribute in JSON format.

Definition at line 255 of file SetSubscriptionAttributesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file SetSubscriptionAttributesRequest.h.

◆ GetSubscriptionArn()

const Aws::String& Aws::SNS::Model::SetSubscriptionAttributesRequest::GetSubscriptionArn ( ) const
inline

The ARN of the subscription to modify.

Definition at line 45 of file SetSubscriptionAttributesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributeName() [1/3]

void Aws::SNS::Model::SetSubscriptionAttributesRequest::SetAttributeName ( const Aws::String value)
inline

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

Definition at line 144 of file SetSubscriptionAttributesRequest.h.

◆ SetAttributeName() [2/3]

void Aws::SNS::Model::SetSubscriptionAttributesRequest::SetAttributeName ( Aws::String &&  value)
inline

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

Definition at line 165 of file SetSubscriptionAttributesRequest.h.

◆ SetAttributeName() [3/3]

void Aws::SNS::Model::SetSubscriptionAttributesRequest::SetAttributeName ( const char *  value)
inline

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

Definition at line 186 of file SetSubscriptionAttributesRequest.h.

◆ SetAttributeValue() [1/3]

void Aws::SNS::Model::SetSubscriptionAttributesRequest::SetAttributeValue ( const Aws::String value)
inline

The new value for the attribute in JSON format.

Definition at line 265 of file SetSubscriptionAttributesRequest.h.

◆ SetAttributeValue() [2/3]

void Aws::SNS::Model::SetSubscriptionAttributesRequest::SetAttributeValue ( Aws::String &&  value)
inline

The new value for the attribute in JSON format.

Definition at line 270 of file SetSubscriptionAttributesRequest.h.

◆ SetAttributeValue() [3/3]

void Aws::SNS::Model::SetSubscriptionAttributesRequest::SetAttributeValue ( const char *  value)
inline

The new value for the attribute in JSON format.

Definition at line 275 of file SetSubscriptionAttributesRequest.h.

◆ SetSubscriptionArn() [1/3]

void Aws::SNS::Model::SetSubscriptionAttributesRequest::SetSubscriptionArn ( const Aws::String value)
inline

The ARN of the subscription to modify.

Definition at line 55 of file SetSubscriptionAttributesRequest.h.

◆ SetSubscriptionArn() [2/3]

void Aws::SNS::Model::SetSubscriptionAttributesRequest::SetSubscriptionArn ( Aws::String &&  value)
inline

The ARN of the subscription to modify.

Definition at line 60 of file SetSubscriptionAttributesRequest.h.

◆ SetSubscriptionArn() [3/3]

void Aws::SNS::Model::SetSubscriptionAttributesRequest::SetSubscriptionArn ( const char *  value)
inline

The ARN of the subscription to modify.

Definition at line 65 of file SetSubscriptionAttributesRequest.h.

◆ SubscriptionArnHasBeenSet()

bool Aws::SNS::Model::SetSubscriptionAttributesRequest::SubscriptionArnHasBeenSet ( ) const
inline

The ARN of the subscription to modify.

Definition at line 50 of file SetSubscriptionAttributesRequest.h.

◆ WithAttributeName() [1/3]

SetSubscriptionAttributesRequest& Aws::SNS::Model::SetSubscriptionAttributesRequest::WithAttributeName ( const Aws::String value)
inline

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

Definition at line 207 of file SetSubscriptionAttributesRequest.h.

◆ WithAttributeName() [2/3]

SetSubscriptionAttributesRequest& Aws::SNS::Model::SetSubscriptionAttributesRequest::WithAttributeName ( Aws::String &&  value)
inline

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

Definition at line 228 of file SetSubscriptionAttributesRequest.h.

◆ WithAttributeName() [3/3]

SetSubscriptionAttributesRequest& Aws::SNS::Model::SetSubscriptionAttributesRequest::WithAttributeName ( const char *  value)
inline

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

Definition at line 249 of file SetSubscriptionAttributesRequest.h.

◆ WithAttributeValue() [1/3]

SetSubscriptionAttributesRequest& Aws::SNS::Model::SetSubscriptionAttributesRequest::WithAttributeValue ( const Aws::String value)
inline

The new value for the attribute in JSON format.

Definition at line 280 of file SetSubscriptionAttributesRequest.h.

◆ WithAttributeValue() [2/3]

SetSubscriptionAttributesRequest& Aws::SNS::Model::SetSubscriptionAttributesRequest::WithAttributeValue ( Aws::String &&  value)
inline

The new value for the attribute in JSON format.

Definition at line 285 of file SetSubscriptionAttributesRequest.h.

◆ WithAttributeValue() [3/3]

SetSubscriptionAttributesRequest& Aws::SNS::Model::SetSubscriptionAttributesRequest::WithAttributeValue ( const char *  value)
inline

The new value for the attribute in JSON format.

Definition at line 290 of file SetSubscriptionAttributesRequest.h.

◆ WithSubscriptionArn() [1/3]

SetSubscriptionAttributesRequest& Aws::SNS::Model::SetSubscriptionAttributesRequest::WithSubscriptionArn ( const Aws::String value)
inline

The ARN of the subscription to modify.

Definition at line 70 of file SetSubscriptionAttributesRequest.h.

◆ WithSubscriptionArn() [2/3]

SetSubscriptionAttributesRequest& Aws::SNS::Model::SetSubscriptionAttributesRequest::WithSubscriptionArn ( Aws::String &&  value)
inline

The ARN of the subscription to modify.

Definition at line 75 of file SetSubscriptionAttributesRequest.h.

◆ WithSubscriptionArn() [3/3]

SetSubscriptionAttributesRequest& Aws::SNS::Model::SetSubscriptionAttributesRequest::WithSubscriptionArn ( const char *  value)
inline

The ARN of the subscription to modify.

Definition at line 80 of file SetSubscriptionAttributesRequest.h.


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