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

#include <SubscribeRequest.h>

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

Public Member Functions

 SubscribeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetTopicArn () const
 
bool TopicArnHasBeenSet () const
 
void SetTopicArn (const Aws::String &value)
 
void SetTopicArn (Aws::String &&value)
 
void SetTopicArn (const char *value)
 
SubscribeRequestWithTopicArn (const Aws::String &value)
 
SubscribeRequestWithTopicArn (Aws::String &&value)
 
SubscribeRequestWithTopicArn (const char *value)
 
const Aws::StringGetProtocol () const
 
bool ProtocolHasBeenSet () const
 
void SetProtocol (const Aws::String &value)
 
void SetProtocol (Aws::String &&value)
 
void SetProtocol (const char *value)
 
SubscribeRequestWithProtocol (const Aws::String &value)
 
SubscribeRequestWithProtocol (Aws::String &&value)
 
SubscribeRequestWithProtocol (const char *value)
 
const Aws::StringGetEndpoint () const
 
bool EndpointHasBeenSet () const
 
void SetEndpoint (const Aws::String &value)
 
void SetEndpoint (Aws::String &&value)
 
void SetEndpoint (const char *value)
 
SubscribeRequestWithEndpoint (const Aws::String &value)
 
SubscribeRequestWithEndpoint (Aws::String &&value)
 
SubscribeRequestWithEndpoint (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)
 
SubscribeRequestWithAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
SubscribeRequestWithAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
SubscribeRequestAddAttributes (const Aws::String &key, const Aws::String &value)
 
SubscribeRequestAddAttributes (Aws::String &&key, const Aws::String &value)
 
SubscribeRequestAddAttributes (const Aws::String &key, Aws::String &&value)
 
SubscribeRequestAddAttributes (Aws::String &&key, Aws::String &&value)
 
SubscribeRequestAddAttributes (const char *key, Aws::String &&value)
 
SubscribeRequestAddAttributes (Aws::String &&key, const char *value)
 
SubscribeRequestAddAttributes (const char *key, const char *value)
 
bool GetReturnSubscriptionArn () const
 
bool ReturnSubscriptionArnHasBeenSet () const
 
void SetReturnSubscriptionArn (bool value)
 
SubscribeRequestWithReturnSubscriptionArn (bool 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 Subscribe action.

See Also:

AWS API Reference

Definition at line 25 of file SubscribeRequest.h.

Constructor & Destructor Documentation

◆ SubscribeRequest()

Aws::SNS::Model::SubscribeRequest::SubscribeRequest ( )

Member Function Documentation

◆ AddAttributes() [1/7]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::AddAttributes ( Aws::String &&  key,
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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 664 of file SubscribeRequest.h.

◆ AddAttributes() [2/7]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::AddAttributes ( Aws::String &&  key,
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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 604 of file SubscribeRequest.h.

◆ AddAttributes() [3/7]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::AddAttributes ( Aws::String &&  key,
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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 724 of file SubscribeRequest.h.

◆ AddAttributes() [4/7]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::AddAttributes ( const Aws::String key,
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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 634 of file SubscribeRequest.h.

◆ AddAttributes() [5/7]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::AddAttributes ( const Aws::String key,
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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 574 of file SubscribeRequest.h.

◆ AddAttributes() [6/7]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::AddAttributes ( const char *  key,
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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 694 of file SubscribeRequest.h.

◆ AddAttributes() [7/7]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::AddAttributes ( const char *  key,
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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 754 of file SubscribeRequest.h.

◆ AttributesHasBeenSet()

bool Aws::SNS::Model::SubscribeRequest::AttributesHasBeenSet ( ) 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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 424 of file SubscribeRequest.h.

◆ DumpBodyToUrl()

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

◆ EndpointHasBeenSet()

bool Aws::SNS::Model::SubscribeRequest::EndpointHasBeenSet ( ) const
inline

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the (public) endpoint is a URL beginning with http://.

  • For the https protocol, the (public) endpoint is a URL beginning with https://.

  • For the email protocol, the endpoint is an email address.

  • For the email-json protocol, the endpoint is an email address.

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Definition at line 249 of file SubscribeRequest.h.

◆ GetAttributes()

const Aws::Map<Aws::String, Aws::String>& Aws::SNS::Model::SubscribeRequest::GetAttributes ( ) 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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 394 of file SubscribeRequest.h.

◆ GetEndpoint()

const Aws::String& Aws::SNS::Model::SubscribeRequest::GetEndpoint ( ) const
inline

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the (public) endpoint is a URL beginning with http://.

  • For the https protocol, the (public) endpoint is a URL beginning with https://.

  • For the email protocol, the endpoint is an email address.

  • For the email-json protocol, the endpoint is an email address.

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Definition at line 230 of file SubscribeRequest.h.

◆ GetProtocol()

const Aws::String& Aws::SNS::Model::SubscribeRequest::GetProtocol ( ) const
inline

The protocol that you want to use. Supported protocols include:

  • http – delivery of JSON-encoded message via HTTP POST

  • https – delivery of JSON-encoded message via HTTPS POST

  • email – delivery of message via SMTP

  • email-json – delivery of JSON-encoded message via SMTP

  • sms – delivery of message via SMS

  • sqs – delivery of JSON-encoded message to an Amazon SQS queue

  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device

  • lambda – delivery of JSON-encoded message to an AWS Lambda function

  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

Definition at line 98 of file SubscribeRequest.h.

◆ GetReturnSubscriptionArn()

bool Aws::SNS::Model::SubscribeRequest::GetReturnSubscriptionArn ( ) const
inline

Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

The default value is false.

Definition at line 768 of file SubscribeRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file SubscribeRequest.h.

◆ GetTopicArn()

const Aws::String& Aws::SNS::Model::SubscribeRequest::GetTopicArn ( ) const
inline

The ARN of the topic you want to subscribe to.

Definition at line 46 of file SubscribeRequest.h.

◆ ProtocolHasBeenSet()

bool Aws::SNS::Model::SubscribeRequest::ProtocolHasBeenSet ( ) const
inline

The protocol that you want to use. Supported protocols include:

  • http – delivery of JSON-encoded message via HTTP POST

  • https – delivery of JSON-encoded message via HTTPS POST

  • email – delivery of message via SMTP

  • email-json – delivery of JSON-encoded message via SMTP

  • sms – delivery of message via SMS

  • sqs – delivery of JSON-encoded message to an Amazon SQS queue

  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device

  • lambda – delivery of JSON-encoded message to an AWS Lambda function

  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

Definition at line 114 of file SubscribeRequest.h.

◆ ReturnSubscriptionArnHasBeenSet()

bool Aws::SNS::Model::SubscribeRequest::ReturnSubscriptionArnHasBeenSet ( ) const
inline

Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

The default value is false.

Definition at line 781 of file SubscribeRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributes() [1/2]

void Aws::SNS::Model::SubscribeRequest::SetAttributes ( Aws::Map< Aws::String, 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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 484 of file SubscribeRequest.h.

◆ SetAttributes() [2/2]

void Aws::SNS::Model::SubscribeRequest::SetAttributes ( const Aws::Map< Aws::String, 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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 454 of file SubscribeRequest.h.

◆ SetEndpoint() [1/3]

void Aws::SNS::Model::SubscribeRequest::SetEndpoint ( Aws::String &&  value)
inline

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the (public) endpoint is a URL beginning with http://.

  • For the https protocol, the (public) endpoint is a URL beginning with https://.

  • For the email protocol, the endpoint is an email address.

  • For the email-json protocol, the endpoint is an email address.

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Definition at line 287 of file SubscribeRequest.h.

◆ SetEndpoint() [2/3]

void Aws::SNS::Model::SubscribeRequest::SetEndpoint ( const Aws::String value)
inline

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the (public) endpoint is a URL beginning with http://.

  • For the https protocol, the (public) endpoint is a URL beginning with https://.

  • For the email protocol, the endpoint is an email address.

  • For the email-json protocol, the endpoint is an email address.

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Definition at line 268 of file SubscribeRequest.h.

◆ SetEndpoint() [3/3]

void Aws::SNS::Model::SubscribeRequest::SetEndpoint ( const char *  value)
inline

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the (public) endpoint is a URL beginning with http://.

  • For the https protocol, the (public) endpoint is a URL beginning with https://.

  • For the email protocol, the endpoint is an email address.

  • For the email-json protocol, the endpoint is an email address.

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Definition at line 306 of file SubscribeRequest.h.

◆ SetProtocol() [1/3]

void Aws::SNS::Model::SubscribeRequest::SetProtocol ( Aws::String &&  value)
inline

The protocol that you want to use. Supported protocols include:

  • http – delivery of JSON-encoded message via HTTP POST

  • https – delivery of JSON-encoded message via HTTPS POST

  • email – delivery of message via SMTP

  • email-json – delivery of JSON-encoded message via SMTP

  • sms – delivery of message via SMS

  • sqs – delivery of JSON-encoded message to an Amazon SQS queue

  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device

  • lambda – delivery of JSON-encoded message to an AWS Lambda function

  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

Definition at line 146 of file SubscribeRequest.h.

◆ SetProtocol() [2/3]

void Aws::SNS::Model::SubscribeRequest::SetProtocol ( const Aws::String value)
inline

The protocol that you want to use. Supported protocols include:

  • http – delivery of JSON-encoded message via HTTP POST

  • https – delivery of JSON-encoded message via HTTPS POST

  • email – delivery of message via SMTP

  • email-json – delivery of JSON-encoded message via SMTP

  • sms – delivery of message via SMS

  • sqs – delivery of JSON-encoded message to an Amazon SQS queue

  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device

  • lambda – delivery of JSON-encoded message to an AWS Lambda function

  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

Definition at line 130 of file SubscribeRequest.h.

◆ SetProtocol() [3/3]

void Aws::SNS::Model::SubscribeRequest::SetProtocol ( const char *  value)
inline

The protocol that you want to use. Supported protocols include:

  • http – delivery of JSON-encoded message via HTTP POST

  • https – delivery of JSON-encoded message via HTTPS POST

  • email – delivery of message via SMTP

  • email-json – delivery of JSON-encoded message via SMTP

  • sms – delivery of message via SMS

  • sqs – delivery of JSON-encoded message to an Amazon SQS queue

  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device

  • lambda – delivery of JSON-encoded message to an AWS Lambda function

  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

Definition at line 162 of file SubscribeRequest.h.

◆ SetReturnSubscriptionArn()

void Aws::SNS::Model::SubscribeRequest::SetReturnSubscriptionArn ( bool  value)
inline

Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

The default value is false.

Definition at line 794 of file SubscribeRequest.h.

◆ SetTopicArn() [1/3]

void Aws::SNS::Model::SubscribeRequest::SetTopicArn ( Aws::String &&  value)
inline

The ARN of the topic you want to subscribe to.

Definition at line 61 of file SubscribeRequest.h.

◆ SetTopicArn() [2/3]

void Aws::SNS::Model::SubscribeRequest::SetTopicArn ( const Aws::String value)
inline

The ARN of the topic you want to subscribe to.

Definition at line 56 of file SubscribeRequest.h.

◆ SetTopicArn() [3/3]

void Aws::SNS::Model::SubscribeRequest::SetTopicArn ( const char *  value)
inline

The ARN of the topic you want to subscribe to.

Definition at line 66 of file SubscribeRequest.h.

◆ TopicArnHasBeenSet()

bool Aws::SNS::Model::SubscribeRequest::TopicArnHasBeenSet ( ) const
inline

The ARN of the topic you want to subscribe to.

Definition at line 51 of file SubscribeRequest.h.

◆ WithAttributes() [1/2]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::WithAttributes ( Aws::Map< Aws::String, 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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 544 of file SubscribeRequest.h.

◆ WithAttributes() [2/2]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::WithAttributes ( const Aws::Map< Aws::String, 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.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

Definition at line 514 of file SubscribeRequest.h.

◆ WithEndpoint() [1/3]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::WithEndpoint ( Aws::String &&  value)
inline

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the (public) endpoint is a URL beginning with http://.

  • For the https protocol, the (public) endpoint is a URL beginning with https://.

  • For the email protocol, the endpoint is an email address.

  • For the email-json protocol, the endpoint is an email address.

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Definition at line 344 of file SubscribeRequest.h.

◆ WithEndpoint() [2/3]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::WithEndpoint ( const Aws::String value)
inline

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the (public) endpoint is a URL beginning with http://.

  • For the https protocol, the (public) endpoint is a URL beginning with https://.

  • For the email protocol, the endpoint is an email address.

  • For the email-json protocol, the endpoint is an email address.

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Definition at line 325 of file SubscribeRequest.h.

◆ WithEndpoint() [3/3]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::WithEndpoint ( const char *  value)
inline

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the (public) endpoint is a URL beginning with http://.

  • For the https protocol, the (public) endpoint is a URL beginning with https://.

  • For the email protocol, the endpoint is an email address.

  • For the email-json protocol, the endpoint is an email address.

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

Definition at line 363 of file SubscribeRequest.h.

◆ WithProtocol() [1/3]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::WithProtocol ( Aws::String &&  value)
inline

The protocol that you want to use. Supported protocols include:

  • http – delivery of JSON-encoded message via HTTP POST

  • https – delivery of JSON-encoded message via HTTPS POST

  • email – delivery of message via SMTP

  • email-json – delivery of JSON-encoded message via SMTP

  • sms – delivery of message via SMS

  • sqs – delivery of JSON-encoded message to an Amazon SQS queue

  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device

  • lambda – delivery of JSON-encoded message to an AWS Lambda function

  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

Definition at line 194 of file SubscribeRequest.h.

◆ WithProtocol() [2/3]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::WithProtocol ( const Aws::String value)
inline

The protocol that you want to use. Supported protocols include:

  • http – delivery of JSON-encoded message via HTTP POST

  • https – delivery of JSON-encoded message via HTTPS POST

  • email – delivery of message via SMTP

  • email-json – delivery of JSON-encoded message via SMTP

  • sms – delivery of message via SMS

  • sqs – delivery of JSON-encoded message to an Amazon SQS queue

  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device

  • lambda – delivery of JSON-encoded message to an AWS Lambda function

  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

Definition at line 178 of file SubscribeRequest.h.

◆ WithProtocol() [3/3]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::WithProtocol ( const char *  value)
inline

The protocol that you want to use. Supported protocols include:

  • http – delivery of JSON-encoded message via HTTP POST

  • https – delivery of JSON-encoded message via HTTPS POST

  • email – delivery of message via SMTP

  • email-json – delivery of JSON-encoded message via SMTP

  • sms – delivery of message via SMS

  • sqs – delivery of JSON-encoded message to an Amazon SQS queue

  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device

  • lambda – delivery of JSON-encoded message to an AWS Lambda function

  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

Definition at line 210 of file SubscribeRequest.h.

◆ WithReturnSubscriptionArn()

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::WithReturnSubscriptionArn ( bool  value)
inline

Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

The default value is false.

Definition at line 807 of file SubscribeRequest.h.

◆ WithTopicArn() [1/3]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::WithTopicArn ( Aws::String &&  value)
inline

The ARN of the topic you want to subscribe to.

Definition at line 76 of file SubscribeRequest.h.

◆ WithTopicArn() [2/3]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::WithTopicArn ( const Aws::String value)
inline

The ARN of the topic you want to subscribe to.

Definition at line 71 of file SubscribeRequest.h.

◆ WithTopicArn() [3/3]

SubscribeRequest& Aws::SNS::Model::SubscribeRequest::WithTopicArn ( const char *  value)
inline

The ARN of the topic you want to subscribe to.

Definition at line 81 of file SubscribeRequest.h.


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