AWS SDK for C++  1.9.124
AWS SDK for C++
Public Member Functions | List of all members
Aws::SNS::Model::GetSubscriptionAttributesResult Class Reference

#include <GetSubscriptionAttributesResult.h>

Public Member Functions

 GetSubscriptionAttributesResult ()
 
 GetSubscriptionAttributesResult (const Aws::AmazonWebServiceResult< Aws::Utils::Xml::XmlDocument > &result)
 
GetSubscriptionAttributesResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Xml::XmlDocument > &result)
 
const Aws::Map< Aws::String, Aws::String > & GetAttributes () const
 
void SetAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
GetSubscriptionAttributesResultWithAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
GetSubscriptionAttributesResultWithAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
GetSubscriptionAttributesResultAddAttributes (const Aws::String &key, const Aws::String &value)
 
GetSubscriptionAttributesResultAddAttributes (Aws::String &&key, const Aws::String &value)
 
GetSubscriptionAttributesResultAddAttributes (const Aws::String &key, Aws::String &&value)
 
GetSubscriptionAttributesResultAddAttributes (Aws::String &&key, Aws::String &&value)
 
GetSubscriptionAttributesResultAddAttributes (const char *key, Aws::String &&value)
 
GetSubscriptionAttributesResultAddAttributes (Aws::String &&key, const char *value)
 
GetSubscriptionAttributesResultAddAttributes (const char *key, const char *value)
 
const ResponseMetadataGetResponseMetadata () const
 
void SetResponseMetadata (const ResponseMetadata &value)
 
void SetResponseMetadata (ResponseMetadata &&value)
 
GetSubscriptionAttributesResultWithResponseMetadata (const ResponseMetadata &value)
 
GetSubscriptionAttributesResultWithResponseMetadata (ResponseMetadata &&value)
 

Detailed Description

Response for GetSubscriptionAttributes action.

See Also:

AWS API Reference

Definition at line 34 of file GetSubscriptionAttributesResult.h.

Constructor & Destructor Documentation

◆ GetSubscriptionAttributesResult() [1/2]

Aws::SNS::Model::GetSubscriptionAttributesResult::GetSubscriptionAttributesResult ( )

◆ GetSubscriptionAttributesResult() [2/2]

Aws::SNS::Model::GetSubscriptionAttributesResult::GetSubscriptionAttributesResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Xml::XmlDocument > &  result)

Member Function Documentation

◆ AddAttributes() [1/7]

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

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • 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.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

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

Definition at line 400 of file GetSubscriptionAttributesResult.h.

◆ AddAttributes() [2/7]

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

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • 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.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

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

Definition at line 320 of file GetSubscriptionAttributesResult.h.

◆ AddAttributes() [3/7]

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

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • 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.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

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

Definition at line 480 of file GetSubscriptionAttributesResult.h.

◆ AddAttributes() [4/7]

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

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • 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.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

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

Definition at line 360 of file GetSubscriptionAttributesResult.h.

◆ AddAttributes() [5/7]

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

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • 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.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

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

Definition at line 280 of file GetSubscriptionAttributesResult.h.

◆ AddAttributes() [6/7]

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

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • 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.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

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

Definition at line 440 of file GetSubscriptionAttributesResult.h.

◆ AddAttributes() [7/7]

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

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • 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.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

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

Definition at line 520 of file GetSubscriptionAttributesResult.h.

◆ GetAttributes()

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

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • 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.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

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

Definition at line 80 of file GetSubscriptionAttributesResult.h.

◆ GetResponseMetadata()

const ResponseMetadata& Aws::SNS::Model::GetSubscriptionAttributesResult::GetResponseMetadata ( ) const
inline

Definition at line 524 of file GetSubscriptionAttributesResult.h.

◆ operator=()

GetSubscriptionAttributesResult& Aws::SNS::Model::GetSubscriptionAttributesResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Xml::XmlDocument > &  result)

◆ SetAttributes() [1/2]

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

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • 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.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

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

Definition at line 160 of file GetSubscriptionAttributesResult.h.

◆ SetAttributes() [2/2]

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

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • 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.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

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

Definition at line 120 of file GetSubscriptionAttributesResult.h.

◆ SetResponseMetadata() [1/2]

void Aws::SNS::Model::GetSubscriptionAttributesResult::SetResponseMetadata ( const ResponseMetadata value)
inline

Definition at line 527 of file GetSubscriptionAttributesResult.h.

◆ SetResponseMetadata() [2/2]

void Aws::SNS::Model::GetSubscriptionAttributesResult::SetResponseMetadata ( ResponseMetadata &&  value)
inline

Definition at line 530 of file GetSubscriptionAttributesResult.h.

◆ WithAttributes() [1/2]

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

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • 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.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

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

Definition at line 240 of file GetSubscriptionAttributesResult.h.

◆ WithAttributes() [2/2]

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

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The account ID of the subscription's owner.

  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • 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.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

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

Definition at line 200 of file GetSubscriptionAttributesResult.h.

◆ WithResponseMetadata() [1/2]

GetSubscriptionAttributesResult& Aws::SNS::Model::GetSubscriptionAttributesResult::WithResponseMetadata ( const ResponseMetadata value)
inline

Definition at line 533 of file GetSubscriptionAttributesResult.h.

◆ WithResponseMetadata() [2/2]

GetSubscriptionAttributesResult& Aws::SNS::Model::GetSubscriptionAttributesResult::WithResponseMetadata ( ResponseMetadata &&  value)
inline

Definition at line 536 of file GetSubscriptionAttributesResult.h.


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