/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace SNS { namespace Model { /** *

Input for Subscribe action.

See Also:

AWS * API Reference

*/ class SubscribeRequest : public SNSRequest { public: AWS_SNS_API SubscribeRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "Subscribe"; } AWS_SNS_API Aws::String SerializePayload() const override; protected: AWS_SNS_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The ARN of the topic you want to subscribe to.

*/ inline const Aws::String& GetTopicArn() const{ return m_topicArn; } /** *

The ARN of the topic you want to subscribe to.

*/ inline bool TopicArnHasBeenSet() const { return m_topicArnHasBeenSet; } /** *

The ARN of the topic you want to subscribe to.

*/ inline void SetTopicArn(const Aws::String& value) { m_topicArnHasBeenSet = true; m_topicArn = value; } /** *

The ARN of the topic you want to subscribe to.

*/ inline void SetTopicArn(Aws::String&& value) { m_topicArnHasBeenSet = true; m_topicArn = std::move(value); } /** *

The ARN of the topic you want to subscribe to.

*/ inline void SetTopicArn(const char* value) { m_topicArnHasBeenSet = true; m_topicArn.assign(value); } /** *

The ARN of the topic you want to subscribe to.

*/ inline SubscribeRequest& WithTopicArn(const Aws::String& value) { SetTopicArn(value); return *this;} /** *

The ARN of the topic you want to subscribe to.

*/ inline SubscribeRequest& WithTopicArn(Aws::String&& value) { SetTopicArn(std::move(value)); return *this;} /** *

The ARN of the topic you want to subscribe to.

*/ inline SubscribeRequest& WithTopicArn(const char* value) { SetTopicArn(value); return *this;} /** *

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 Lambda function

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

*/ inline const Aws::String& GetProtocol() const{ return m_protocol; } /** *

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 Lambda function

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

*/ inline bool ProtocolHasBeenSet() const { return m_protocolHasBeenSet; } /** *

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 Lambda function

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

*/ inline void SetProtocol(const Aws::String& value) { m_protocolHasBeenSet = true; m_protocol = value; } /** *

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 Lambda function

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

*/ inline void SetProtocol(Aws::String&& value) { m_protocolHasBeenSet = true; m_protocol = std::move(value); } /** *

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 Lambda function

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

*/ inline void SetProtocol(const char* value) { m_protocolHasBeenSet = true; m_protocol.assign(value); } /** *

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 Lambda function

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

*/ inline SubscribeRequest& WithProtocol(const Aws::String& value) { SetProtocol(value); return *this;} /** *

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 Lambda function

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

*/ inline SubscribeRequest& WithProtocol(Aws::String&& value) { SetProtocol(std::move(value)); return *this;} /** *

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 Lambda function

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

*/ inline SubscribeRequest& WithProtocol(const char* value) { SetProtocol(value); return *this;} /** *

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 Lambda function.

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

*/ inline const Aws::String& GetEndpoint() const{ return m_endpoint; } /** *

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 Lambda function.

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

*/ inline bool EndpointHasBeenSet() const { return m_endpointHasBeenSet; } /** *

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 Lambda function.

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

*/ inline void SetEndpoint(const Aws::String& value) { m_endpointHasBeenSet = true; m_endpoint = value; } /** *

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 Lambda function.

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

*/ inline void SetEndpoint(Aws::String&& value) { m_endpointHasBeenSet = true; m_endpoint = std::move(value); } /** *

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 Lambda function.

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

*/ inline void SetEndpoint(const char* value) { m_endpointHasBeenSet = true; m_endpoint.assign(value); } /** *

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 Lambda function.

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

*/ inline SubscribeRequest& WithEndpoint(const Aws::String& value) { SetEndpoint(value); return *this;} /** *

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 Lambda function.

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

*/ inline SubscribeRequest& WithEndpoint(Aws::String&& value) { SetEndpoint(std::move(value)); return *this;} /** *

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 Lambda function.

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

*/ inline SubscribeRequest& WithEndpoint(const char* value) { SetEndpoint(value); return *this;} /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline const Aws::Map& GetAttributes() const{ return m_attributes; } /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline bool AttributesHasBeenSet() const { return m_attributesHasBeenSet; } /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline void SetAttributes(const Aws::Map& value) { m_attributesHasBeenSet = true; m_attributes = value; } /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline void SetAttributes(Aws::Map&& value) { m_attributesHasBeenSet = true; m_attributes = std::move(value); } /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline SubscribeRequest& WithAttributes(const Aws::Map& value) { SetAttributes(value); return *this;} /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline SubscribeRequest& WithAttributes(Aws::Map&& value) { SetAttributes(std::move(value)); return *this;} /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline SubscribeRequest& AddAttributes(const Aws::String& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline SubscribeRequest& AddAttributes(Aws::String&& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline SubscribeRequest& AddAttributes(const Aws::String& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline SubscribeRequest& AddAttributes(Aws::String&& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), std::move(value)); return *this; } /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline SubscribeRequest& AddAttributes(const char* key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline SubscribeRequest& AddAttributes(Aws::String&& key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

A map of attributes with their corresponding values.

The following * lists the names, descriptions, and values of the special request parameters that * the Subscribe 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.

  • FilterPolicyScope – This attribute * lets you choose the filtering scope by using one of the following string value * types:

    • MessageAttributes (default) – The filter * is applied on the message attributes.

    • * MessageBody – The filter is applied on the message body.

    • *
  • 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:

  • * SubscriptionRoleArn – The ARN of the IAM role that has the * following:

    • Permission to write to the Kinesis Data Firehose * delivery stream

    • Amazon SNS listed as a trusted entity

      *

    Specifying a valid ARN for this attribute is required for Kinesis * Data Firehose delivery stream subscriptions. For more information, see Fanout * to Kinesis Data Firehose delivery streams in the Amazon SNS Developer * Guide.

The following attributes apply only to FIFO * topics:

  • ReplayPolicy – Adds or updates an * inline policy document for a subscription to replay messages stored in the * specified Amazon SNS topic.

  • ReplayStatus – * Retrieves the status of the subscription message replay, which can be one of the * following:

    • Completed – The replay has * successfully redelivered all messages, and is now delivering newly published * messages. If an ending point was specified in the ReplayPolicy then * the subscription will no longer receive newly published messages.

    • *

      In progress – The replay is currently replaying the selected * messages.

    • Failed – The replay was unable to * complete.

    • Pending – The default state while the * replay initiates.

*/ inline SubscribeRequest& AddAttributes(const char* key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } /** *

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.

*/ inline bool GetReturnSubscriptionArn() const{ return m_returnSubscriptionArn; } /** *

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.

*/ inline bool ReturnSubscriptionArnHasBeenSet() const { return m_returnSubscriptionArnHasBeenSet; } /** *

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.

*/ inline void SetReturnSubscriptionArn(bool value) { m_returnSubscriptionArnHasBeenSet = true; m_returnSubscriptionArn = value; } /** *

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.

*/ inline SubscribeRequest& WithReturnSubscriptionArn(bool value) { SetReturnSubscriptionArn(value); return *this;} private: Aws::String m_topicArn; bool m_topicArnHasBeenSet = false; Aws::String m_protocol; bool m_protocolHasBeenSet = false; Aws::String m_endpoint; bool m_endpointHasBeenSet = false; Aws::Map m_attributes; bool m_attributesHasBeenSet = false; bool m_returnSubscriptionArn; bool m_returnSubscriptionArnHasBeenSet = false; }; } // namespace Model } // namespace SNS } // namespace Aws