/** * 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 { template class AmazonWebServiceResult; namespace Utils { namespace Xml { class XmlDocument; } // namespace Xml } // namespace Utils namespace SNS { namespace Model { /** *

Response for GetTopicAttributes action.

See Also:

AWS * API Reference

*/ class AWS_SNS_API GetTopicAttributesResult { public: GetTopicAttributesResult(); GetTopicAttributesResult(const Aws::AmazonWebServiceResult& result); GetTopicAttributesResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

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

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

  • * DisplayName – The human-readable name used in the From * field for notifications to email and email-json * endpoints.

  • Owner – The AWS account ID of the * topic's owner.

  • Policy – The JSON serialization * of the topic's access control policy.

  • * SubscriptionsConfirmed – The number of confirmed subscriptions for * the topic.

  • SubscriptionsDeleted – The number of * deleted subscriptions for the topic.

  • * SubscriptionsPending – The number of subscriptions pending * confirmation for the topic.

  • TopicArn – The * topic's ARN.

  • EffectiveDeliveryPolicy – The JSON * serialization of the effective delivery policy, taking system defaults into * account.

The following attribute applies only to server-side-encryption:

*
  • KmsMasterKeyId - The ID of an AWS-managed customer * master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key * Terms. For more examples, see KeyId * in the AWS Key Management Service API Reference.

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

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

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

  • * DisplayName – The human-readable name used in the From * field for notifications to email and email-json * endpoints.

  • Owner – The AWS account ID of the * topic's owner.

  • Policy – The JSON serialization * of the topic's access control policy.

  • * SubscriptionsConfirmed – The number of confirmed subscriptions for * the topic.

  • SubscriptionsDeleted – The number of * deleted subscriptions for the topic.

  • * SubscriptionsPending – The number of subscriptions pending * confirmation for the topic.

  • TopicArn – The * topic's ARN.

  • EffectiveDeliveryPolicy – The JSON * serialization of the effective delivery policy, taking system defaults into * account.

The following attribute applies only to server-side-encryption:

*
  • KmsMasterKeyId - The ID of an AWS-managed customer * master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key * Terms. For more examples, see KeyId * in the AWS Key Management Service API Reference.

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

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

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

  • * DisplayName – The human-readable name used in the From * field for notifications to email and email-json * endpoints.

  • Owner – The AWS account ID of the * topic's owner.

  • Policy – The JSON serialization * of the topic's access control policy.

  • * SubscriptionsConfirmed – The number of confirmed subscriptions for * the topic.

  • SubscriptionsDeleted – The number of * deleted subscriptions for the topic.

  • * SubscriptionsPending – The number of subscriptions pending * confirmation for the topic.

  • TopicArn – The * topic's ARN.

  • EffectiveDeliveryPolicy – The JSON * serialization of the effective delivery policy, taking system defaults into * account.

The following attribute applies only to server-side-encryption:

*
  • KmsMasterKeyId - The ID of an AWS-managed customer * master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key * Terms. For more examples, see KeyId * in the AWS Key Management Service API Reference.

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

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

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

  • * DisplayName – The human-readable name used in the From * field for notifications to email and email-json * endpoints.

  • Owner – The AWS account ID of the * topic's owner.

  • Policy – The JSON serialization * of the topic's access control policy.

  • * SubscriptionsConfirmed – The number of confirmed subscriptions for * the topic.

  • SubscriptionsDeleted – The number of * deleted subscriptions for the topic.

  • * SubscriptionsPending – The number of subscriptions pending * confirmation for the topic.

  • TopicArn – The * topic's ARN.

  • EffectiveDeliveryPolicy – The JSON * serialization of the effective delivery policy, taking system defaults into * account.

The following attribute applies only to server-side-encryption:

*
  • KmsMasterKeyId - The ID of an AWS-managed customer * master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key * Terms. For more examples, see KeyId * in the AWS Key Management Service API Reference.

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

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

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

  • * DisplayName – The human-readable name used in the From * field for notifications to email and email-json * endpoints.

  • Owner – The AWS account ID of the * topic's owner.

  • Policy – The JSON serialization * of the topic's access control policy.

  • * SubscriptionsConfirmed – The number of confirmed subscriptions for * the topic.

  • SubscriptionsDeleted – The number of * deleted subscriptions for the topic.

  • * SubscriptionsPending – The number of subscriptions pending * confirmation for the topic.

  • TopicArn – The * topic's ARN.

  • EffectiveDeliveryPolicy – The JSON * serialization of the effective delivery policy, taking system defaults into * account.

The following attribute applies only to server-side-encryption:

*
  • KmsMasterKeyId - The ID of an AWS-managed customer * master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key * Terms. For more examples, see KeyId * in the AWS Key Management Service API Reference.

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

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

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

  • * DisplayName – The human-readable name used in the From * field for notifications to email and email-json * endpoints.

  • Owner – The AWS account ID of the * topic's owner.

  • Policy – The JSON serialization * of the topic's access control policy.

  • * SubscriptionsConfirmed – The number of confirmed subscriptions for * the topic.

  • SubscriptionsDeleted – The number of * deleted subscriptions for the topic.

  • * SubscriptionsPending – The number of subscriptions pending * confirmation for the topic.

  • TopicArn – The * topic's ARN.

  • EffectiveDeliveryPolicy – The JSON * serialization of the effective delivery policy, taking system defaults into * account.

The following attribute applies only to server-side-encryption:

*
  • KmsMasterKeyId - The ID of an AWS-managed customer * master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key * Terms. For more examples, see KeyId * in the AWS Key Management Service API Reference.

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

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

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

  • * DisplayName – The human-readable name used in the From * field for notifications to email and email-json * endpoints.

  • Owner – The AWS account ID of the * topic's owner.

  • Policy – The JSON serialization * of the topic's access control policy.

  • * SubscriptionsConfirmed – The number of confirmed subscriptions for * the topic.

  • SubscriptionsDeleted – The number of * deleted subscriptions for the topic.

  • * SubscriptionsPending – The number of subscriptions pending * confirmation for the topic.

  • TopicArn – The * topic's ARN.

  • EffectiveDeliveryPolicy – The JSON * serialization of the effective delivery policy, taking system defaults into * account.

The following attribute applies only to server-side-encryption:

*
  • KmsMasterKeyId - The ID of an AWS-managed customer * master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key * Terms. For more examples, see KeyId * in the AWS Key Management Service API Reference.

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

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

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

  • * DisplayName – The human-readable name used in the From * field for notifications to email and email-json * endpoints.

  • Owner – The AWS account ID of the * topic's owner.

  • Policy – The JSON serialization * of the topic's access control policy.

  • * SubscriptionsConfirmed – The number of confirmed subscriptions for * the topic.

  • SubscriptionsDeleted – The number of * deleted subscriptions for the topic.

  • * SubscriptionsPending – The number of subscriptions pending * confirmation for the topic.

  • TopicArn – The * topic's ARN.

  • EffectiveDeliveryPolicy – The JSON * serialization of the effective delivery policy, taking system defaults into * account.

The following attribute applies only to server-side-encryption:

*
  • KmsMasterKeyId - The ID of an AWS-managed customer * master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key * Terms. For more examples, see KeyId * in the AWS Key Management Service API Reference.

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

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

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

  • * DisplayName – The human-readable name used in the From * field for notifications to email and email-json * endpoints.

  • Owner – The AWS account ID of the * topic's owner.

  • Policy – The JSON serialization * of the topic's access control policy.

  • * SubscriptionsConfirmed – The number of confirmed subscriptions for * the topic.

  • SubscriptionsDeleted – The number of * deleted subscriptions for the topic.

  • * SubscriptionsPending – The number of subscriptions pending * confirmation for the topic.

  • TopicArn – The * topic's ARN.

  • EffectiveDeliveryPolicy – The JSON * serialization of the effective delivery policy, taking system defaults into * account.

The following attribute applies only to server-side-encryption:

*
  • KmsMasterKeyId - The ID of an AWS-managed customer * master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key * Terms. For more examples, see KeyId * in the AWS Key Management Service API Reference.

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

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

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

  • * DisplayName – The human-readable name used in the From * field for notifications to email and email-json * endpoints.

  • Owner – The AWS account ID of the * topic's owner.

  • Policy – The JSON serialization * of the topic's access control policy.

  • * SubscriptionsConfirmed – The number of confirmed subscriptions for * the topic.

  • SubscriptionsDeleted – The number of * deleted subscriptions for the topic.

  • * SubscriptionsPending – The number of subscriptions pending * confirmation for the topic.

  • TopicArn – The * topic's ARN.

  • EffectiveDeliveryPolicy – The JSON * serialization of the effective delivery policy, taking system defaults into * account.

The following attribute applies only to server-side-encryption:

*
  • KmsMasterKeyId - The ID of an AWS-managed customer * master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key * Terms. For more examples, see KeyId * in the AWS Key Management Service API Reference.

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

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

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

  • * DisplayName – The human-readable name used in the From * field for notifications to email and email-json * endpoints.

  • Owner – The AWS account ID of the * topic's owner.

  • Policy – The JSON serialization * of the topic's access control policy.

  • * SubscriptionsConfirmed – The number of confirmed subscriptions for * the topic.

  • SubscriptionsDeleted – The number of * deleted subscriptions for the topic.

  • * SubscriptionsPending – The number of subscriptions pending * confirmation for the topic.

  • TopicArn – The * topic's ARN.

  • EffectiveDeliveryPolicy – The JSON * serialization of the effective delivery policy, taking system defaults into * account.

The following attribute applies only to server-side-encryption:

*
  • KmsMasterKeyId - The ID of an AWS-managed customer * master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key * Terms. For more examples, see KeyId * in the AWS Key Management Service API Reference.

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

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

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

  • * DisplayName – The human-readable name used in the From * field for notifications to email and email-json * endpoints.

  • Owner – The AWS account ID of the * topic's owner.

  • Policy – The JSON serialization * of the topic's access control policy.

  • * SubscriptionsConfirmed – The number of confirmed subscriptions for * the topic.

  • SubscriptionsDeleted – The number of * deleted subscriptions for the topic.

  • * SubscriptionsPending – The number of subscriptions pending * confirmation for the topic.

  • TopicArn – The * topic's ARN.

  • EffectiveDeliveryPolicy – The JSON * serialization of the effective delivery policy, taking system defaults into * account.

The following attribute applies only to server-side-encryption:

*
  • KmsMasterKeyId - The ID of an AWS-managed customer * master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key * Terms. For more examples, see KeyId * in the AWS Key Management Service API Reference.

*/ inline GetTopicAttributesResult& AddAttributes(const char* key, const char* value) { m_attributes.emplace(key, value); return *this; } inline const ResponseMetadata& GetResponseMetadata() const{ return m_responseMetadata; } inline void SetResponseMetadata(const ResponseMetadata& value) { m_responseMetadata = value; } inline void SetResponseMetadata(ResponseMetadata&& value) { m_responseMetadata = std::move(value); } inline GetTopicAttributesResult& WithResponseMetadata(const ResponseMetadata& value) { SetResponseMetadata(value); return *this;} inline GetTopicAttributesResult& WithResponseMetadata(ResponseMetadata&& value) { SetResponseMetadata(std::move(value)); return *this;} private: Aws::Map m_attributes; ResponseMetadata m_responseMetadata; }; } // namespace Model } // namespace SNS } // namespace Aws