SNS *** Client ====== class SNS.Client A low-level client representing Amazon Simple Notification Service (SNS) Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide. For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the *Amazon SNS Developer Guide.* We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services. import boto3 client = boto3.client('sns') These are the available methods: * add_permission * can_paginate * check_if_phone_number_is_opted_out * close * confirm_subscription * create_platform_application * create_platform_endpoint * create_sms_sandbox_phone_number * create_topic * delete_endpoint * delete_platform_application * delete_sms_sandbox_phone_number * delete_topic * get_data_protection_policy * get_endpoint_attributes * get_paginator * get_platform_application_attributes * get_sms_attributes * get_sms_sandbox_account_status * get_subscription_attributes * get_topic_attributes * get_waiter * list_endpoints_by_platform_application * list_origination_numbers * list_phone_numbers_opted_out * list_platform_applications * list_sms_sandbox_phone_numbers * list_subscriptions * list_subscriptions_by_topic * list_tags_for_resource * list_topics * opt_in_phone_number * publish * publish_batch * put_data_protection_policy * remove_permission * set_endpoint_attributes * set_platform_application_attributes * set_sms_attributes * set_subscription_attributes * set_topic_attributes * subscribe * tag_resource * unsubscribe * untag_resource * verify_sms_sandbox_phone_number Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListEndpointsByPlatformApplication * ListOriginationNumbers * ListPhoneNumbersOptedOut * ListPlatformApplications * ListSMSSandboxPhoneNumbers * ListSubscriptions * ListSubscriptionsByTopic * ListTopics Resources ========= Resources are available in boto3 via the "resource" method. For more detailed instructions and examples on the usage of resources, see the resources user guide. The available resources are: * Service Resource * PlatformApplication * PlatformEndpoint * Subscription * Topic PlatformEndpoint / Action / get_available_subresources get_available_subresources ************************** SNS.PlatformEndpoint.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str PlatformEndpoint / Action / set_attributes set_attributes ************** SNS.PlatformEndpoint.set_attributes(**kwargs) Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications. See also: AWS API Documentation **Request Syntax** response = platform_endpoint.set_attributes( Attributes={ 'string': 'string' } ) Parameters: **Attributes** (*dict*) -- **[REQUIRED]** A map of the endpoint attributes. Attributes in this map include the following: * "CustomUserData" – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. * "Enabled" – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token. * "Token" – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service. * *(string) --* * *(string) --* Returns: None PlatformEndpoint / Action / load load **** SNS.PlatformEndpoint.load() Calls "SNS.Client.get_endpoint_attributes()" to update the attributes of the PlatformEndpoint resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** platform_endpoint.load() Returns: None SNS / Resource / PlatformEndpoint PlatformEndpoint **************** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class SNS.PlatformEndpoint(arn) A resource representing an Amazon Simple Notification Service (SNS) PlatformEndpoint: import boto3 sns = boto3.resource('sns') platform_endpoint = sns.PlatformEndpoint('arn') Parameters: **arn** (*string*) -- The PlatformEndpoint's arn identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * arn Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * attributes Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * delete * get_available_subresources * load * publish * reload * set_attributes PlatformEndpoint / Attribute / attributes attributes ********** SNS.PlatformEndpoint.attributes * *(dict) --* Attributes include the following: * "CustomUserData" – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. * "Enabled" – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token. * "Token" – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service. Note: The device token for the iOS platform is returned in lowercase. * *(string) --* * *(string) --* PlatformEndpoint / Identifier / arn arn *** SNS.PlatformEndpoint.arn *(string)* The PlatformEndpoint's arn identifier. This **must** be set. PlatformEndpoint / Action / publish publish ******* SNS.PlatformEndpoint.publish(**kwargs) Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the "TargetArn"). If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint. When a "messageId" is returned, the message is saved and Amazon SNS immediately delivers it to subscribers. To use the "Publish" action for publishing a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the "CreatePlatformEndpoint" action. For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices. Warning: You can publish messages only to topics and endpoints in the same Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = platform_endpoint.publish( TopicArn='string', PhoneNumber='string', Message='string', Subject='string', MessageStructure='string', MessageAttributes={ 'string': { 'DataType': 'string', 'StringValue': 'string', 'BinaryValue': b'bytes' } }, MessageDeduplicationId='string', MessageGroupId='string' ) Parameters: * **TopicArn** (*string*) -- The topic you want to publish to. If you don't specify a value for the "TopicArn" parameter, you must specify a value for the "PhoneNumber" or "TargetArn" parameters. * **PhoneNumber** (*string*) -- The phone number to which you want to deliver an SMS message. Use E.164 format. If you don't specify a value for the "PhoneNumber" parameter, you must specify a value for the "TargetArn" or "TopicArn" parameters. * **Message** (*string*) -- **[REQUIRED]** The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the "MessageStructure" parameter to "json" and use a JSON object for the "Message" parameter. Constraints: * With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters). * For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole- word boundaries. The total size limit for a single SMS "Publish" action is 1,600 characters. JSON-specific constraints: * Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. * The values will be parsed (unescaped) before they are used in outgoing messages. * Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending). * Values have a minimum length of 0 (the empty string, "", is allowed). * Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes). * Non-string values will cause the key to be ignored. * Keys that do not correspond to supported transport protocols are ignored. * Duplicate keys are not allowed. * Failure to parse or validate any key or value in the message will cause the "Publish" call to return an error (no partial delivery). * **Subject** (*string*) -- Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long. * **MessageStructure** (*string*) -- Set "MessageStructure" to "json" if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set "MessageStructure" to "json", the value of the "Message" parameter must: * be a syntactically valid JSON object; and * contain at least a top-level JSON key of "default" with a value that is a string. You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). Valid value: "json" * **MessageAttributes** (*dict*) -- Message attributes for Publish action. * *(string) --* * *(dict) --* The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish. Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Amazon SNS message attributes and Publishing to a mobile phone in the *Amazon SNS Developer Guide.* * **DataType** *(string) --* **[REQUIRED]** Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types. * **StringValue** *(string) --* Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters. * **BinaryValue** *(bytes) --* Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images. * **MessageDeduplicationId** (*string*) -- * This parameter applies only to FIFO (first-in-first-out) topics. The "MessageDeduplicationId" can contain up to 128 alphanumeric characters "(a-z, A-Z, 0-9)" and punctuation "(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)". * Every message must have a unique "MessageDeduplicationId", which is a token used for deduplication of sent messages within the 5 minute minimum deduplication interval. * The scope of deduplication depends on the "FifoThroughputScope" attribute, when set to "Topic" the message deduplication scope is across the entire topic, when set to "MessageGroup" the message deduplication scope is within each individual message group. * If a message with a particular "MessageDeduplicationId" is sent successfully, subsequent messages within the deduplication scope and interval, with the same "MessageDeduplicationId", are accepted successfully but aren't delivered. * Every message must have a unique "MessageDeduplicationId": * You may provide a "MessageDeduplicationId" explicitly. * If you aren't able to provide a "MessageDeduplicationId" and you enable "ContentBasedDeduplication" for your topic, Amazon SNS uses a SHA-256 hash to generate the "MessageDeduplicationId" using the body of the message (but not the attributes of the message). * If you don't provide a "MessageDeduplicationId" and the topic doesn't have "ContentBasedDeduplication" set, the action fails with an error. * If the topic has a "ContentBasedDeduplication" set, your "MessageDeduplicationId" overrides the generated one. * When "ContentBasedDeduplication" is in effect, messages with identical content sent within the deduplication scope and interval are treated as duplicates and only one copy of the message is delivered. * If you send one message with "ContentBasedDeduplication" enabled, and then another message with a "MessageDeduplicationId" that is the same as the one generated for the first "MessageDeduplicationId", the two messages are treated as duplicates, within the deduplication scope and interval, and only one copy of the message is delivered. * **MessageGroupId** (*string*) -- The "MessageGroupId" can contain up to 128 alphanumeric characters "(a-z, A-Z, 0-9)" and punctuation "(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)". For FIFO topics: The "MessageGroupId" is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a "MessageGroupId". For standard topics: The "MessageGroupId" is optional and is forwarded only to Amazon SQS standard subscriptions to activate fair queues. The "MessageGroupId" is not used for, or sent to, any other endpoint types. When provided, the same validation rules apply as for FIFO topics. Return type: dict Returns: **Response Syntax** { 'MessageId': 'string', 'SequenceNumber': 'string' } **Response Structure** * *(dict) --* Response for Publish action. * **MessageId** *(string) --* Unique identifier assigned to the published message. Length Constraint: Maximum 100 characters * **SequenceNumber** *(string) --* This response element applies only to FIFO (first-in-first- out) topics. The sequence number is a large, non-consecutive number that Amazon SNS assigns to each message. The length of "SequenceNumber" is 128 bits. "SequenceNumber" continues to increase for each "MessageGroupId". PlatformEndpoint / Action / reload reload ****** SNS.PlatformEndpoint.reload() Calls "SNS.Client.get_endpoint_attributes()" to update the attributes of the PlatformEndpoint resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** platform_endpoint.reload() Returns: None PlatformEndpoint / Action / delete delete ****** SNS.PlatformEndpoint.delete() Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications. When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic. See also: AWS API Documentation **Request Syntax** response = platform_endpoint.delete() Returns: None Topic / Action / get_available_subresources get_available_subresources ************************** SNS.Topic.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str Topic / Action / confirm_subscription confirm_subscription ******************** SNS.Topic.confirm_subscription(**kwargs) Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier "Subscribe" action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the "AuthenticateOnUnsubscribe" flag is set to "true". See also: AWS API Documentation **Request Syntax** subscription = topic.confirm_subscription( Token='string', AuthenticateOnUnsubscribe='string' ) Parameters: * **Token** (*string*) -- **[REQUIRED]** Short-lived token sent to an endpoint during the "Subscribe" action. * **AuthenticateOnUnsubscribe** (*string*) -- Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is "true" and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication. Return type: "sns.Subscription" Returns: Subscription resource Topic / Collection / subscriptions subscriptions ************* SNS.Topic.subscriptions A collection of Subscription resources.A Subscription Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all Subscription resources in the collection. See also: AWS API Documentation **Request Syntax** subscription_iterator = topic.subscriptions.all() Return type: list("sns.Subscription") Returns: A list of Subscription resources filter(**kwargs) Creates an iterable of all Subscription resources in the collection filtered by kwargs passed to method. A Subscription collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** subscription_iterator = topic.subscriptions.filter( NextToken='string' ) Parameters: **NextToken** (*string*) -- Token returned by the previous "ListSubscriptionsByTopic" request. Return type: list("sns.Subscription") Returns: A list of Subscription resources limit(**kwargs) Creates an iterable up to a specified amount of Subscription resources in the collection. See also: AWS API Documentation **Request Syntax** subscription_iterator = topic.subscriptions.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("sns.Subscription") Returns: A list of Subscription resources page_size(**kwargs) Creates an iterable of all Subscription resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** subscription_iterator = topic.subscriptions.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("sns.Subscription") Returns: A list of Subscription resources Topic / Action / set_attributes set_attributes ************** SNS.Topic.set_attributes(**kwargs) Allows a topic owner to set an attribute of the topic to a new value. Note: To remove the ability to change topic permissions, you must deny permissions to the "AddPermission", "RemovePermission", and "SetTopicAttributes" actions in your IAM policy. See also: AWS API Documentation **Request Syntax** response = topic.set_attributes( AttributeName='string', AttributeValue='string' ) Parameters: * **AttributeName** (*string*) -- **[REQUIRED]** A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the "SetTopicAttributes" action uses: * "DeliveryPolicy" – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints. * "DisplayName" – The display name to use for a topic with SMS subscriptions. * "Policy" – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic. * "TracingConfig" – Tracing mode of an Amazon SNS topic. By default "TracingConfig" is set to "PassThrough", and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to "Active", Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics. * HTTP * "HTTPSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint. * "HTTPSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint. * "HTTPFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint. * Amazon Data Firehose * "FirehoseSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. * "FirehoseSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. * "FirehoseFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. * Lambda * "LambdaSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint. * "LambdaSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint. * "LambdaFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint. * Platform application endpoint * "ApplicationSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an platform application endpoint. * "ApplicationSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an platform application endpoint. * "ApplicationFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an platform application endpoint. Note: In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status. * Amazon SQS * "SQSSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. * "SQSSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. * "SQSFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. Note: The SuccessFeedbackRoleArn and FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. The following attribute applies only to server-side- encryption: * "KmsMasterKeyId" – The ID of an Amazon Web Services 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 *Key Management Service API Reference*. * "SignatureVersion" – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, "SignatureVersion" is set to "1". The following attribute applies only to FIFO topics: * "ArchivePolicy" – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic. * "ContentBasedDeduplication" – Enables content-based deduplication for FIFO topics. * By default, "ContentBasedDeduplication" is set to "false". If you create a FIFO topic and this attribute is "false", you must specify a value for the "MessageDeduplicationId" parameter for the Publish action. * When you set "ContentBasedDeduplication" to "true", Amazon SNS uses a SHA-256 hash to generate the "MessageDeduplicationId" using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the "MessageDeduplicationId" parameter for the "Publish" action. * "FifoThroughputScope" – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values: * "Topic" – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first. * "MessageGroup" – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference. * **AttributeValue** (*string*) -- The new value for the attribute. Returns: None Topic / Action / load load **** SNS.Topic.load() Calls "SNS.Client.get_topic_attributes()" to update the attributes of the Topic resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** topic.load() Returns: None SNS / Resource / Topic Topic ***** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class SNS.Topic(arn) A resource representing an Amazon Simple Notification Service (SNS) Topic: import boto3 sns = boto3.resource('sns') topic = sns.Topic('arn') Parameters: **arn** (*string*) -- The Topic's arn identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * arn Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * attributes Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * add_permission * confirm_subscription * delete * get_available_subresources * load * publish * reload * remove_permission * set_attributes * subscribe Collections =========== Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide. These are the resource's available collections: * subscriptions Topic / Attribute / attributes attributes ********** SNS.Topic.attributes * *(dict) --* 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. * "EffectiveDeliveryPolicy" – The JSON serialization of the effective delivery policy, taking system defaults into account. * "Owner" – The Amazon Web Services account ID of the topic's owner. * "Policy" – The JSON serialization of the topic's access control policy. * "SignatureVersion" – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. * By default, "SignatureVersion" is set to **1**. The signature is a Base64-encoded **SHA1withRSA** signature. * When you set "SignatureVersion" to **2**. Amazon SNS uses a Base64-encoded **SHA256withRSA** signature. Note: If the API response does not include the "SignatureVersion" attribute, it means that the "SignatureVersion" for the topic has value **1**. * "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. * "TracingConfig" – Tracing mode of an Amazon SNS topic. By default "TracingConfig" is set to "PassThrough", and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to "Active", Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics. The following attribute applies only to server-side-encryption: * "KmsMasterKeyId" - The ID of an Amazon Web Services 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 *Key Management Service API Reference*. The following attributes apply only to FIFO topics: * "ArchivePolicy" – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic. * "BeginningArchiveTime" – The earliest starting point at which a message in the topic’s archive can be replayed from. This point in time is based on the configured message retention period set by the topic’s message archiving policy. * "ContentBasedDeduplication" – Enables content-based deduplication for FIFO topics. * By default, "ContentBasedDeduplication" is set to "false". If you create a FIFO topic and this attribute is "false", you must specify a value for the "MessageDeduplicationId" parameter for the Publish action. * When you set "ContentBasedDeduplication" to "true", Amazon SNS uses a SHA-256 hash to generate the "MessageDeduplicationId" using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the "MessageDeduplicationId" parameter for the "Publish" action. * "FifoTopic" – When this is set to "true", a FIFO topic is created. * *(string) --* * *(string) --* Topic / Identifier / arn arn *** SNS.Topic.arn *(string)* The Topic's arn identifier. This **must** be set. Topic / Action / subscribe subscribe ********* SNS.Topic.subscribe(**kwargs) Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must run the "ConfirmSubscription" action to confirm the subscription. You call the "ConfirmSubscription" action with the token from the subscription response. Confirmation tokens are valid for two days. This action is throttled at 100 transactions per second (TPS). See also: AWS API Documentation **Request Syntax** subscription = topic.subscribe( Protocol='string', Endpoint='string', Attributes={ 'string': 'string' }, ReturnSubscriptionArn=True|False ) Parameters: * **Protocol** (*string*) -- **[REQUIRED]** 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 Data Firehose delivery stream. * **Endpoint** (*string*) -- 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 Data Firehose delivery stream. * **Attributes** (*dict*) -- 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 Data Firehose delivery stream subscriptions: * "SubscriptionRoleArn" – The ARN of the IAM role that has the following: * Permission to write to the Firehose delivery stream * Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to 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. * *(string) --* * *(string) --* * **ReturnSubscriptionArn** (*boolean*) -- 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". Return type: "sns.Subscription" Returns: Subscription resource Topic / Action / remove_permission remove_permission ***************** SNS.Topic.remove_permission(**kwargs) Removes a statement from a topic's access control policy. Note: To remove the ability to change topic permissions, you must deny permissions to the "AddPermission", "RemovePermission", and "SetTopicAttributes" actions in your IAM policy. See also: AWS API Documentation **Request Syntax** response = topic.remove_permission( Label='string' ) Parameters: **Label** (*string*) -- **[REQUIRED]** The unique label of the statement you want to remove. Returns: None Topic / Action / publish publish ******* SNS.Topic.publish(**kwargs) Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the "TargetArn"). If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint. When a "messageId" is returned, the message is saved and Amazon SNS immediately delivers it to subscribers. To use the "Publish" action for publishing a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the "CreatePlatformEndpoint" action. For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices. Warning: You can publish messages only to topics and endpoints in the same Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = topic.publish( TargetArn='string', PhoneNumber='string', Message='string', Subject='string', MessageStructure='string', MessageAttributes={ 'string': { 'DataType': 'string', 'StringValue': 'string', 'BinaryValue': b'bytes' } }, MessageDeduplicationId='string', MessageGroupId='string' ) Parameters: * **TargetArn** (*string*) -- If you don't specify a value for the "TargetArn" parameter, you must specify a value for the "PhoneNumber" or "TopicArn" parameters. * **PhoneNumber** (*string*) -- The phone number to which you want to deliver an SMS message. Use E.164 format. If you don't specify a value for the "PhoneNumber" parameter, you must specify a value for the "TargetArn" or "TopicArn" parameters. * **Message** (*string*) -- **[REQUIRED]** The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the "MessageStructure" parameter to "json" and use a JSON object for the "Message" parameter. Constraints: * With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters). * For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole- word boundaries. The total size limit for a single SMS "Publish" action is 1,600 characters. JSON-specific constraints: * Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. * The values will be parsed (unescaped) before they are used in outgoing messages. * Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending). * Values have a minimum length of 0 (the empty string, "", is allowed). * Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes). * Non-string values will cause the key to be ignored. * Keys that do not correspond to supported transport protocols are ignored. * Duplicate keys are not allowed. * Failure to parse or validate any key or value in the message will cause the "Publish" call to return an error (no partial delivery). * **Subject** (*string*) -- Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long. * **MessageStructure** (*string*) -- Set "MessageStructure" to "json" if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set "MessageStructure" to "json", the value of the "Message" parameter must: * be a syntactically valid JSON object; and * contain at least a top-level JSON key of "default" with a value that is a string. You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). Valid value: "json" * **MessageAttributes** (*dict*) -- Message attributes for Publish action. * *(string) --* * *(dict) --* The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish. Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Amazon SNS message attributes and Publishing to a mobile phone in the *Amazon SNS Developer Guide.* * **DataType** *(string) --* **[REQUIRED]** Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types. * **StringValue** *(string) --* Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters. * **BinaryValue** *(bytes) --* Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images. * **MessageDeduplicationId** (*string*) -- * This parameter applies only to FIFO (first-in-first-out) topics. The "MessageDeduplicationId" can contain up to 128 alphanumeric characters "(a-z, A-Z, 0-9)" and punctuation "(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)". * Every message must have a unique "MessageDeduplicationId", which is a token used for deduplication of sent messages within the 5 minute minimum deduplication interval. * The scope of deduplication depends on the "FifoThroughputScope" attribute, when set to "Topic" the message deduplication scope is across the entire topic, when set to "MessageGroup" the message deduplication scope is within each individual message group. * If a message with a particular "MessageDeduplicationId" is sent successfully, subsequent messages within the deduplication scope and interval, with the same "MessageDeduplicationId", are accepted successfully but aren't delivered. * Every message must have a unique "MessageDeduplicationId": * You may provide a "MessageDeduplicationId" explicitly. * If you aren't able to provide a "MessageDeduplicationId" and you enable "ContentBasedDeduplication" for your topic, Amazon SNS uses a SHA-256 hash to generate the "MessageDeduplicationId" using the body of the message (but not the attributes of the message). * If you don't provide a "MessageDeduplicationId" and the topic doesn't have "ContentBasedDeduplication" set, the action fails with an error. * If the topic has a "ContentBasedDeduplication" set, your "MessageDeduplicationId" overrides the generated one. * When "ContentBasedDeduplication" is in effect, messages with identical content sent within the deduplication scope and interval are treated as duplicates and only one copy of the message is delivered. * If you send one message with "ContentBasedDeduplication" enabled, and then another message with a "MessageDeduplicationId" that is the same as the one generated for the first "MessageDeduplicationId", the two messages are treated as duplicates, within the deduplication scope and interval, and only one copy of the message is delivered. * **MessageGroupId** (*string*) -- The "MessageGroupId" can contain up to 128 alphanumeric characters "(a-z, A-Z, 0-9)" and punctuation "(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)". For FIFO topics: The "MessageGroupId" is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a "MessageGroupId". For standard topics: The "MessageGroupId" is optional and is forwarded only to Amazon SQS standard subscriptions to activate fair queues. The "MessageGroupId" is not used for, or sent to, any other endpoint types. When provided, the same validation rules apply as for FIFO topics. Return type: dict Returns: **Response Syntax** { 'MessageId': 'string', 'SequenceNumber': 'string' } **Response Structure** * *(dict) --* Response for Publish action. * **MessageId** *(string) --* Unique identifier assigned to the published message. Length Constraint: Maximum 100 characters * **SequenceNumber** *(string) --* This response element applies only to FIFO (first-in-first- out) topics. The sequence number is a large, non-consecutive number that Amazon SNS assigns to each message. The length of "SequenceNumber" is 128 bits. "SequenceNumber" continues to increase for each "MessageGroupId". Topic / Action / reload reload ****** SNS.Topic.reload() Calls "SNS.Client.get_topic_attributes()" to update the attributes of the Topic resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** topic.reload() Returns: None Topic / Action / add_permission add_permission ************** SNS.Topic.add_permission(**kwargs) Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions. Note: To remove the ability to change topic permissions, you must deny permissions to the "AddPermission", "RemovePermission", and "SetTopicAttributes" actions in your IAM policy. See also: AWS API Documentation **Request Syntax** response = topic.add_permission( Label='string', AWSAccountId=[ 'string', ], ActionName=[ 'string', ] ) Parameters: * **Label** (*string*) -- **[REQUIRED]** A unique identifier for the new policy statement. * **AWSAccountId** (*list*) -- **[REQUIRED]** The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service. * *(string) --* * **ActionName** (*list*) -- **[REQUIRED]** The action you want to allow for the specified principal(s). Valid values: Any Amazon SNS action name, for example "Publish". * *(string) --* Returns: None Topic / Action / delete delete ****** SNS.Topic.delete() Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. See also: AWS API Documentation **Request Syntax** response = topic.delete() Returns: None Subscription / Action / get_available_subresources get_available_subresources ************************** SNS.Subscription.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str Subscription / Action / set_attributes set_attributes ************** SNS.Subscription.set_attributes(**kwargs) Allows a subscription owner to set an attribute of the subscription to a new value. See also: AWS API Documentation **Request Syntax** response = subscription.set_attributes( AttributeName='string', AttributeValue='string' ) Parameters: * **AttributeName** (*string*) -- **[REQUIRED]** A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that this 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 Data Firehose delivery stream subscriptions: * "SubscriptionRoleArn" – The ARN of the IAM role that has the following: * Permission to write to the Firehose delivery stream * Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the *Amazon SNS Developer Guide*. * **AttributeValue** (*string*) -- The new value for the attribute in JSON format. Returns: None Subscription / Action / load load **** SNS.Subscription.load() Calls "SNS.Client.get_subscription_attributes()" to update the attributes of the Subscription resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** subscription.load() Returns: None SNS / Resource / Subscription Subscription ************ Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class SNS.Subscription(arn) A resource representing an Amazon Simple Notification Service (SNS) Subscription: import boto3 sns = boto3.resource('sns') subscription = sns.Subscription('arn') Parameters: **arn** (*string*) -- The Subscription's arn identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * arn Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * attributes Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * delete * get_available_subresources * load * reload * set_attributes Subscription / Attribute / attributes attributes ********** SNS.Subscription.attributes * *(dict) --* A map of the subscription's attributes. Attributes in this map include the following: * "ConfirmationWasAuthenticated" – "true" 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*. * "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. * "Owner" – The Amazon Web Services account ID of the subscription's owner. * "PendingConfirmation" – "true" if the subscription hasn't been confirmed. To confirm a pending subscription, call the "ConfirmSubscription" action with a confirmation token. * "RawMessageDelivery" – "true" 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 Data Firehose delivery stream subscriptions: * "SubscriptionRoleArn" – The ARN of the IAM role that has the following: * Permission to write to the Firehose delivery stream * Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the *Amazon SNS Developer Guide*. * *(string) --* * *(string) --* Subscription / Identifier / arn arn *** SNS.Subscription.arn *(string)* The Subscription's arn identifier. This **must** be set. Subscription / Action / reload reload ****** SNS.Subscription.reload() Calls "SNS.Client.get_subscription_attributes()" to update the attributes of the Subscription resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** subscription.reload() Returns: None Subscription / Action / delete delete ****** SNS.Subscription.delete() Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature is required. If the "Unsubscribe" call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the "Unsubscribe" request was unintended. This action is throttled at 100 transactions per second (TPS). See also: AWS API Documentation **Request Syntax** response = subscription.delete() Returns: None PlatformApplication / Collection / endpoints endpoints ********* SNS.PlatformApplication.endpoints A collection of PlatformEndpoint resources.A PlatformEndpoint Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all PlatformEndpoint resources in the collection. See also: AWS API Documentation **Request Syntax** platform_endpoint_iterator = platform_application.endpoints.all() Return type: list("sns.PlatformEndpoint") Returns: A list of PlatformEndpoint resources filter(**kwargs) Creates an iterable of all PlatformEndpoint resources in the collection filtered by kwargs passed to method. A PlatformEndpoint collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** platform_endpoint_iterator = platform_application.endpoints.filter( NextToken='string' ) Parameters: **NextToken** (*string*) -- "NextToken" string is used when calling "ListEndpointsByPlatformApplication" action to retrieve additional records that are available after the first page results. Return type: list("sns.PlatformEndpoint") Returns: A list of PlatformEndpoint resources limit(**kwargs) Creates an iterable up to a specified amount of PlatformEndpoint resources in the collection. See also: AWS API Documentation **Request Syntax** platform_endpoint_iterator = platform_application.endpoints.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("sns.PlatformEndpoint") Returns: A list of PlatformEndpoint resources page_size(**kwargs) Creates an iterable of all PlatformEndpoint resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** platform_endpoint_iterator = platform_application.endpoints.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("sns.PlatformEndpoint") Returns: A list of PlatformEndpoint resources PlatformApplication / Action / get_available_subresources get_available_subresources ************************** SNS.PlatformApplication.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str PlatformApplication / Action / set_attributes set_attributes ************** SNS.PlatformApplication.set_attributes(**kwargs) Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status. See also: AWS API Documentation **Request Syntax** response = platform_application.set_attributes( Attributes={ 'string': 'string' } ) Parameters: **Attributes** (*dict*) -- **[REQUIRED]** A map of the platform application attributes. Attributes in this map include the following: * "PlatformCredential" – The credential received from the notification service. * For ADM, >>``<>``<SuccessFeedbackRoleArn and FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. The following attribute applies only to server-side encryption: * "KmsMasterKeyId" – The ID of an Amazon Web Services 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 *Key Management Service API Reference*. The following attributes apply only to FIFO topics: * "ArchivePolicy" – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic. * "ContentBasedDeduplication" – Enables content-based deduplication for FIFO topics. * By default, "ContentBasedDeduplication" is set to "false". If you create a FIFO topic and this attribute is "false", you must specify a value for the "MessageDeduplicationId" parameter for the Publish action. * When you set "ContentBasedDeduplication" to "true", Amazon SNS uses a SHA-256 hash to generate the "MessageDeduplicationId" using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the "MessageDeduplicationId" parameter for the "Publish" action. * "FifoThroughputScope" – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values: * "Topic" – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first. * "MessageGroup" – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference. * *(string) --* * *(string) --* * **Tags** (*list*) -- The list of tags to add to a new topic. Note: To be able to tag a topic on creation, you must have the "sns:CreateTopic" and "sns:TagResource" permissions. * *(dict) --* The list of tags to be added to the specified topic. * **Key** *(string) --* **[REQUIRED]** The required key portion of the tag. * **Value** *(string) --* **[REQUIRED]** The optional value portion of the tag. * **DataProtectionPolicy** (*string*) -- The body of the policy document you want to use for this topic. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720. Return type: "sns.Topic" Returns: Topic resource ServiceResource / Sub-Resource / PlatformApplication PlatformApplication ******************* SNS.ServiceResource.PlatformApplication(arn) Creates a PlatformApplication resource.: platform_application = sns.PlatformApplication('arn') Parameters: **arn** (*string*) -- The PlatformApplication's arn identifier. This **must** be set. Return type: "SNS.PlatformApplication" Returns: A PlatformApplication resource SNS / Resource / ServiceResource Service Resource **************** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class SNS.ServiceResource A resource representing Amazon Simple Notification Service (SNS): import boto3 sns = boto3.resource('sns') Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * create_platform_application * create_topic * get_available_subresources Sub-resources ============= Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide. These are the resource's available sub-resources: * PlatformApplication * PlatformEndpoint * Subscription * Topic Collections =========== Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide. These are the resource's available collections: * platform_applications * subscriptions * topics ServiceResource / Sub-Resource / Topic Topic ***** SNS.ServiceResource.Topic(arn) Creates a Topic resource.: topic = sns.Topic('arn') Parameters: **arn** (*string*) -- The Topic's arn identifier. This **must** be set. Return type: "SNS.Topic" Returns: A Topic resource ServiceResource / Collection / platform_applications platform_applications ********************* SNS.ServiceResource.platform_applications A collection of PlatformApplication resources.A PlatformApplication Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all PlatformApplication resources in the collection. See also: AWS API Documentation **Request Syntax** platform_application_iterator = sns.platform_applications.all() Return type: list("sns.PlatformApplication") Returns: A list of PlatformApplication resources filter(**kwargs) Creates an iterable of all PlatformApplication resources in the collection filtered by kwargs passed to method. A PlatformApplication collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** platform_application_iterator = sns.platform_applications.filter( NextToken='string' ) Parameters: **NextToken** (*string*) -- "NextToken" string is used when calling "ListPlatformApplications" action to retrieve additional records that are available after the first page results. Return type: list("sns.PlatformApplication") Returns: A list of PlatformApplication resources limit(**kwargs) Creates an iterable up to a specified amount of PlatformApplication resources in the collection. See also: AWS API Documentation **Request Syntax** platform_application_iterator = sns.platform_applications.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("sns.PlatformApplication") Returns: A list of PlatformApplication resources page_size(**kwargs) Creates an iterable of all PlatformApplication resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** platform_application_iterator = sns.platform_applications.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("sns.PlatformApplication") Returns: A list of PlatformApplication resources ServiceResource / Sub-Resource / PlatformEndpoint PlatformEndpoint **************** SNS.ServiceResource.PlatformEndpoint(arn) Creates a PlatformEndpoint resource.: platform_endpoint = sns.PlatformEndpoint('arn') Parameters: **arn** (*string*) -- The PlatformEndpoint's arn identifier. This **must** be set. Return type: "SNS.PlatformEndpoint" Returns: A PlatformEndpoint resource ServiceResource / Action / create_platform_application create_platform_application *************************** SNS.ServiceResource.create_platform_application(**kwargs) Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify "PlatformPrincipal" and "PlatformCredential" attributes when using the "CreatePlatformApplication" action. "PlatformPrincipal" and "PlatformCredential" are received from the notification service. * For ADM, "PlatformPrincipal" is "client id" and "PlatformCredential" is "client secret". * For APNS and "APNS_SANDBOX" using certificate credentials, "PlatformPrincipal" is "SSL certificate" and "PlatformCredential" is "private key". * For APNS and "APNS_SANDBOX" using token credentials, "PlatformPrincipal" is "signing key ID" and "PlatformCredential" is "signing key". * For Baidu, "PlatformPrincipal" is "API key" and "PlatformCredential" is "secret key". * For GCM (Firebase Cloud Messaging) using key credentials, there is no "PlatformPrincipal". The "PlatformCredential" is "API key". * For GCM (Firebase Cloud Messaging) using token credentials, there is no "PlatformPrincipal". The "PlatformCredential" is a JSON formatted private key file. When using the Amazon Web Services CLI or Amazon Web Services SDKs, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: "SERVICE_JSON=$(jq @json < service.json)". * For MPNS, "PlatformPrincipal" is "TLS certificate" and "PlatformCredential" is "private key". * For WNS, "PlatformPrincipal" is "Package Security Identifier" and "PlatformCredential" is "secret key". You can use the returned "PlatformApplicationArn" as an attribute for the "CreatePlatformEndpoint" action. See also: AWS API Documentation **Request Syntax** platform_application = sns.create_platform_application( Name='string', Platform='string', Attributes={ 'string': 'string' } ) Parameters: * **Name** (*string*) -- **[REQUIRED]** Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long. * **Platform** (*string*) -- **[REQUIRED]** The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging). * **Attributes** (*dict*) -- **[REQUIRED]** For a list of attributes, see SetPlatformApplicationAttributes. * *(string) --* * *(string) --* Return type: "sns.PlatformApplication" Returns: PlatformApplication resource SNS / Paginator / ListSubscriptions ListSubscriptions ***************** class SNS.Paginator.ListSubscriptions paginator = client.get_paginator('list_subscriptions') paginate(**kwargs) Creates an iterator that will paginate through responses from "SNS.Client.list_subscriptions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Subscriptions': [ { 'SubscriptionArn': 'string', 'Owner': 'string', 'Protocol': 'string', 'Endpoint': 'string', 'TopicArn': 'string' }, ], } **Response Structure** * *(dict) --* Response for ListSubscriptions action * **Subscriptions** *(list) --* A list of subscriptions. * *(dict) --* A wrapper type for the attributes of an Amazon SNS subscription. * **SubscriptionArn** *(string) --* The subscription's ARN. * **Owner** *(string) --* The subscription's owner. * **Protocol** *(string) --* The subscription's protocol. * **Endpoint** *(string) --* The subscription's endpoint (format depends on the protocol). * **TopicArn** *(string) --* The ARN of the subscription's topic. SNS / Paginator / ListEndpointsByPlatformApplication ListEndpointsByPlatformApplication ********************************** class SNS.Paginator.ListEndpointsByPlatformApplication paginator = client.get_paginator('list_endpoints_by_platform_application') paginate(**kwargs) Creates an iterator that will paginate through responses from "SNS.Client.list_endpoints_by_platform_application()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PlatformApplicationArn='string', PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: * **PlatformApplicationArn** (*string*) -- **[REQUIRED]** "PlatformApplicationArn" for "ListEndpointsByPlatformApplicationInput" action. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Endpoints': [ { 'EndpointArn': 'string', 'Attributes': { 'string': 'string' } }, ], } **Response Structure** * *(dict) --* Response for "ListEndpointsByPlatformApplication" action. * **Endpoints** *(list) --* Endpoints returned for "ListEndpointsByPlatformApplication" action. * *(dict) --* The endpoint for mobile app and device. * **EndpointArn** *(string) --* The "EndpointArn" for mobile app and device. * **Attributes** *(dict) --* Attributes for endpoint. * *(string) --* * *(string) --* SNS / Paginator / ListSubscriptionsByTopic ListSubscriptionsByTopic ************************ class SNS.Paginator.ListSubscriptionsByTopic paginator = client.get_paginator('list_subscriptions_by_topic') paginate(**kwargs) Creates an iterator that will paginate through responses from "SNS.Client.list_subscriptions_by_topic()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TopicArn='string', PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: * **TopicArn** (*string*) -- **[REQUIRED]** The ARN of the topic for which you wish to find subscriptions. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Subscriptions': [ { 'SubscriptionArn': 'string', 'Owner': 'string', 'Protocol': 'string', 'Endpoint': 'string', 'TopicArn': 'string' }, ], } **Response Structure** * *(dict) --* Response for ListSubscriptionsByTopic action. * **Subscriptions** *(list) --* A list of subscriptions. * *(dict) --* A wrapper type for the attributes of an Amazon SNS subscription. * **SubscriptionArn** *(string) --* The subscription's ARN. * **Owner** *(string) --* The subscription's owner. * **Protocol** *(string) --* The subscription's protocol. * **Endpoint** *(string) --* The subscription's endpoint (format depends on the protocol). * **TopicArn** *(string) --* The ARN of the subscription's topic. SNS / Paginator / ListTopics ListTopics ********** class SNS.Paginator.ListTopics paginator = client.get_paginator('list_topics') paginate(**kwargs) Creates an iterator that will paginate through responses from "SNS.Client.list_topics()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Topics': [ { 'TopicArn': 'string' }, ], } **Response Structure** * *(dict) --* Response for ListTopics action. * **Topics** *(list) --* A list of topic ARNs. * *(dict) --* A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use "GetTopicAttributes". * **TopicArn** *(string) --* The topic's ARN. SNS / Paginator / ListPhoneNumbersOptedOut ListPhoneNumbersOptedOut ************************ class SNS.Paginator.ListPhoneNumbersOptedOut paginator = client.get_paginator('list_phone_numbers_opted_out') paginate(**kwargs) Creates an iterator that will paginate through responses from "SNS.Client.list_phone_numbers_opted_out()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'phoneNumbers': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* The response from the "ListPhoneNumbersOptedOut" action. * **phoneNumbers** *(list) --* A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. SNS / Paginator / ListPlatformApplications ListPlatformApplications ************************ class SNS.Paginator.ListPlatformApplications paginator = client.get_paginator('list_platform_applications') paginate(**kwargs) Creates an iterator that will paginate through responses from "SNS.Client.list_platform_applications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PlatformApplications': [ { 'PlatformApplicationArn': 'string', 'Attributes': { 'string': 'string' } }, ], } **Response Structure** * *(dict) --* Response for "ListPlatformApplications" action. * **PlatformApplications** *(list) --* Platform applications returned when calling "ListPlatformApplications" action. * *(dict) --* Platform application object. * **PlatformApplicationArn** *(string) --* PlatformApplicationArn for platform application object. * **Attributes** *(dict) --* Attributes for platform application object. * *(string) --* * *(string) --* SNS / Paginator / ListOriginationNumbers ListOriginationNumbers ********************** class SNS.Paginator.ListOriginationNumbers paginator = client.get_paginator('list_origination_numbers') paginate(**kwargs) Creates an iterator that will paginate through responses from "SNS.Client.list_origination_numbers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PhoneNumbers': [ { 'CreatedAt': datetime(2015, 1, 1), 'PhoneNumber': 'string', 'Status': 'string', 'Iso2CountryCode': 'string', 'RouteType': 'Transactional'|'Promotional'|'Premium', 'NumberCapabilities': [ 'SMS'|'MMS'|'VOICE', ] }, ] } **Response Structure** * *(dict) --* * **PhoneNumbers** *(list) --* A list of the calling account's verified and pending origination numbers. * *(dict) --* A list of phone numbers and their metadata. * **CreatedAt** *(datetime) --* The date and time when the phone number was created. * **PhoneNumber** *(string) --* The phone number. * **Status** *(string) --* The status of the phone number. * **Iso2CountryCode** *(string) --* The two-character code for the country or region, in ISO 3166-1 alpha-2 format. * **RouteType** *(string) --* The list of supported routes. * **NumberCapabilities** *(list) --* The capabilities of each phone number. * *(string) --* Enum listing out all supported number capabilities. SNS / Paginator / ListSMSSandboxPhoneNumbers ListSMSSandboxPhoneNumbers ************************** class SNS.Paginator.ListSMSSandboxPhoneNumbers paginator = client.get_paginator('list_sms_sandbox_phone_numbers') paginate(**kwargs) Creates an iterator that will paginate through responses from "SNS.Client.list_sms_sandbox_phone_numbers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PhoneNumbers': [ { 'PhoneNumber': 'string', 'Status': 'Pending'|'Verified' }, ], } **Response Structure** * *(dict) --* * **PhoneNumbers** *(list) --* A list of the calling account's pending and verified phone numbers. * *(dict) --* A verified or pending destination phone number in the SMS sandbox. When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the *SMS sandbox*. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the *Amazon SNS Developer Guide*. * **PhoneNumber** *(string) --* The destination phone number. * **Status** *(string) --* The destination phone number's verification status. SNS / Client / get_paginator get_paginator ************* SNS.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. SNS / Client / get_topic_attributes get_topic_attributes ******************** SNS.Client.get_topic_attributes(**kwargs) Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. See also: AWS API Documentation **Request Syntax** response = client.get_topic_attributes( TopicArn='string' ) Parameters: **TopicArn** (*string*) -- **[REQUIRED]** The ARN of the topic whose properties you want to get. Return type: dict Returns: **Response Syntax** { 'Attributes': { 'string': 'string' } } **Response Structure** * *(dict) --* Response for GetTopicAttributes action. * **Attributes** *(dict) --* 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. * "EffectiveDeliveryPolicy" – The JSON serialization of the effective delivery policy, taking system defaults into account. * "Owner" – The Amazon Web Services account ID of the topic's owner. * "Policy" – The JSON serialization of the topic's access control policy. * "SignatureVersion" – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. * By default, "SignatureVersion" is set to **1**. The signature is a Base64-encoded **SHA1withRSA** signature. * When you set "SignatureVersion" to **2**. Amazon SNS uses a Base64-encoded **SHA256withRSA** signature. Note: If the API response does not include the "SignatureVersion" attribute, it means that the "SignatureVersion" for the topic has value **1**. * "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. * "TracingConfig" – Tracing mode of an Amazon SNS topic. By default "TracingConfig" is set to "PassThrough", and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to "Active", Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics. The following attribute applies only to server-side- encryption: * "KmsMasterKeyId" - The ID of an Amazon Web Services 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 *Key Management Service API Reference*. The following attributes apply only to FIFO topics: * "ArchivePolicy" – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic. * "BeginningArchiveTime" – The earliest starting point at which a message in the topic’s archive can be replayed from. This point in time is based on the configured message retention period set by the topic’s message archiving policy. * "ContentBasedDeduplication" – Enables content-based deduplication for FIFO topics. * By default, "ContentBasedDeduplication" is set to "false". If you create a FIFO topic and this attribute is "false", you must specify a value for the "MessageDeduplicationId" parameter for the Publish action. * When you set "ContentBasedDeduplication" to "true", Amazon SNS uses a SHA-256 hash to generate the "MessageDeduplicationId" using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the "MessageDeduplicationId" parameter for the "Publish" action. * "FifoTopic" – When this is set to "true", a FIFO topic is created. * *(string) --* * *(string) --* **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InvalidSecurityException" SNS / Client / publish_batch publish_batch ************* SNS.Client.publish_batch(**kwargs) Publishes up to 10 messages to the specified topic in a single batch. This is a batch version of the "Publish" API. If you try to send more than 10 messages in a single batch request, you will receive a "TooManyEntriesInBatchRequest" exception. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for five minutes. The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes). Warning: The "PublishBatch" API can send up to 10 messages at a time. If you attempt to send more than 10 messages in one request, you will encounter a "TooManyEntriesInBatchRequest" exception. In such cases, split your messages into multiple requests, each containing no more than 10 messages. Some actions take lists of parameters. These lists are specified using the "param.n" notation. Values of "n" are integers starting from **1**. For example, a parameter list with two elements looks like this: "&AttributeName.1=first" "&AttributeName.2=second" If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint. When a "messageId" is returned, the batch message is saved, and Amazon SNS immediately delivers the message to subscribers. See also: AWS API Documentation **Request Syntax** response = client.publish_batch( TopicArn='string', PublishBatchRequestEntries=[ { 'Id': 'string', 'Message': 'string', 'Subject': 'string', 'MessageStructure': 'string', 'MessageAttributes': { 'string': { 'DataType': 'string', 'StringValue': 'string', 'BinaryValue': b'bytes' } }, 'MessageDeduplicationId': 'string', 'MessageGroupId': 'string' }, ] ) Parameters: * **TopicArn** (*string*) -- **[REQUIRED]** The Amazon resource name (ARN) of the topic you want to batch publish to. * **PublishBatchRequestEntries** (*list*) -- **[REQUIRED]** A list of "PublishBatch" request entries to be sent to the SNS topic. * *(dict) --* Contains the details of a single Amazon SNS message along with an "Id" that identifies a message within the batch. * **Id** *(string) --* **[REQUIRED]** An identifier for the message in this batch. Note: The "Ids" of a batch request must be unique within a request.This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_). * **Message** *(string) --* **[REQUIRED]** The body of the message. * **Subject** *(string) --* The subject of the batch message. * **MessageStructure** *(string) --* Set "MessageStructure" to "json" if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set "MessageStructure" to "json", the value of the "Message" parameter must: * be a syntactically valid JSON object; and * contain at least a top-level JSON key of "default" with a value that is a string. You can define other top-level keys that define the message you want to send to a specific transport protocol (for example, http). * **MessageAttributes** *(dict) --* Each message attribute consists of a "Name", "Type", and "Value". For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide. * *(string) --* * *(dict) --* The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish. Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Amazon SNS message attributes and Publishing to a mobile phone in the *Amazon SNS Developer Guide.* * **DataType** *(string) --* **[REQUIRED]** Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types. * **StringValue** *(string) --* Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters. * **BinaryValue** *(bytes) --* Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images. * **MessageDeduplicationId** *(string) --* This parameter applies only to FIFO (first-in-first-out) topics. * This parameter applies only to FIFO (first-in-first-out) topics. The "MessageDeduplicationId" can contain up to 128 alphanumeric characters "(a-z, A-Z, 0-9)" and punctuation "(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)". * Every message must have a unique "MessageDeduplicationId", which is a token used for deduplication of sent messages within the 5 minute minimum deduplication interval. * The scope of deduplication depends on the "FifoThroughputScope" attribute, when set to "Topic" the message deduplication scope is across the entire topic, when set to "MessageGroup" the message deduplication scope is within each individual message group. * If a message with a particular "MessageDeduplicationId" is sent successfully, subsequent messages within the deduplication scope and interval, with the same "MessageDeduplicationId", are accepted successfully but aren't delivered. * Every message must have a unique "MessageDeduplicationId". * You may provide a "MessageDeduplicationId" explicitly. * If you aren't able to provide a "MessageDeduplicationId" and you enable "ContentBasedDeduplication" for your topic, Amazon SNS uses a SHA-256 hash to generate the "MessageDeduplicationId" using the body of the message (but not the attributes of the message). * If you don't provide a "MessageDeduplicationId" and the topic doesn't have "ContentBasedDeduplication" set, the action fails with an error. * If the topic has a "ContentBasedDeduplication" set, your "MessageDeduplicationId" overrides the generated one. * When "ContentBasedDeduplication" is in effect, messages with identical content sent within the deduplication scope and interval are treated as duplicates and only one copy of the message is delivered. * If you send one message with "ContentBasedDeduplication" enabled, and then another message with a "MessageDeduplicationId" that is the same as the one generated for the first "MessageDeduplicationId", the two messages are treated as duplicates, within the deduplication scope and interval, and only one copy of the message is delivered. Note: The "MessageDeduplicationId" is available to the consumer of the message (this can be useful for troubleshooting delivery issues).If a message is sent successfully but the acknowledgement is lost and the message is resent with the same "MessageDeduplicationId" after the deduplication interval, Amazon SNS can't detect duplicate messages.Amazon SNS continues to keep track of the message deduplication ID even after the message is received and deleted. * **MessageGroupId** *(string) --* FIFO topics: The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single topic, use "MessageGroupId" values (for example, session data for multiple users). In this scenario, multiple consumers can process the topic, but the session data of each user is processed in a FIFO fashion. You must associate a non-empty "MessageGroupId" with a message. If you do not provide a "MessageGroupId", the action fails. Standard topics: The "MessageGroupId" is optional and is forwarded only to Amazon SQS standard subscriptions to activate fair queues. The "MessageGroupId" is not used for, or sent to, any other endpoint types. The length of "MessageGroupId" is 128 characters. "MessageGroupId" can contain alphanumeric characters "(a-z, A-Z, 0-9)" and punctuation "(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)". Return type: dict Returns: **Response Syntax** { 'Successful': [ { 'Id': 'string', 'MessageId': 'string', 'SequenceNumber': 'string' }, ], 'Failed': [ { 'Id': 'string', 'Code': 'string', 'Message': 'string', 'SenderFault': True|False }, ] } **Response Structure** * *(dict) --* * **Successful** *(list) --* A list of successful "PublishBatch" responses. * *(dict) --* Encloses data related to a successful message in a batch request for topic. * **Id** *(string) --* The "Id" of an entry in a batch request. * **MessageId** *(string) --* An identifier for the message. * **SequenceNumber** *(string) --* This parameter applies only to FIFO (first-in-first-out) topics. The large, non-consecutive number that Amazon SNS assigns to each message. The length of "SequenceNumber" is 128 bits. "SequenceNumber" continues to increase for a particular "MessageGroupId". * **Failed** *(list) --* A list of failed "PublishBatch" responses. * *(dict) --* Gives a detailed description of failed messages in the batch. * **Id** *(string) --* The "Id" of an entry in a batch request * **Code** *(string) --* An error code representing why the action failed on this entry. * **Message** *(string) --* A message explaining why the action failed on this entry. * **SenderFault** *(boolean) --* Specifies whether the error happened due to the caller of the batch API action. **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InvalidParameterValueException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.EndpointDisabledException" * "SNS.Client.exceptions.PlatformApplicationDisabledException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.BatchEntryIdsNotDistinctException" * "SNS.Client.exceptions.BatchRequestTooLongException" * "SNS.Client.exceptions.EmptyBatchRequestException" * "SNS.Client.exceptions.InvalidBatchEntryIdException" * "SNS.Client.exceptions.TooManyEntriesInBatchRequestException" * "SNS.Client.exceptions.KMSDisabledException" * "SNS.Client.exceptions.KMSInvalidStateException" * "SNS.Client.exceptions.KMSNotFoundException" * "SNS.Client.exceptions.KMSOptInRequired" * "SNS.Client.exceptions.KMSThrottlingException" * "SNS.Client.exceptions.KMSAccessDeniedException" * "SNS.Client.exceptions.InvalidSecurityException" * "SNS.Client.exceptions.ValidationException" SNS / Client / can_paginate can_paginate ************ SNS.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. SNS / Client / list_subscriptions list_subscriptions ****************** SNS.Client.list_subscriptions(**kwargs) Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a "NextToken" is also returned. Use the "NextToken" parameter in a new "ListSubscriptions" call to get further results. This action is throttled at 30 transactions per second (TPS). See also: AWS API Documentation **Request Syntax** response = client.list_subscriptions( NextToken='string' ) Parameters: **NextToken** (*string*) -- Token returned by the previous "ListSubscriptions" request. Return type: dict Returns: **Response Syntax** { 'Subscriptions': [ { 'SubscriptionArn': 'string', 'Owner': 'string', 'Protocol': 'string', 'Endpoint': 'string', 'TopicArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Response for ListSubscriptions action * **Subscriptions** *(list) --* A list of subscriptions. * *(dict) --* A wrapper type for the attributes of an Amazon SNS subscription. * **SubscriptionArn** *(string) --* The subscription's ARN. * **Owner** *(string) --* The subscription's owner. * **Protocol** *(string) --* The subscription's protocol. * **Endpoint** *(string) --* The subscription's endpoint (format depends on the protocol). * **TopicArn** *(string) --* The ARN of the subscription's topic. * **NextToken** *(string) --* Token to pass along to the next "ListSubscriptions" request. This element is returned if there are more subscriptions to retrieve. **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" SNS / Client / confirm_subscription confirm_subscription ******************** SNS.Client.confirm_subscription(**kwargs) Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier "Subscribe" action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the "AuthenticateOnUnsubscribe" flag is set to "true". See also: AWS API Documentation **Request Syntax** response = client.confirm_subscription( TopicArn='string', Token='string', AuthenticateOnUnsubscribe='string' ) Parameters: * **TopicArn** (*string*) -- **[REQUIRED]** The ARN of the topic for which you wish to confirm a subscription. * **Token** (*string*) -- **[REQUIRED]** Short-lived token sent to an endpoint during the "Subscribe" action. * **AuthenticateOnUnsubscribe** (*string*) -- Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is "true" and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication. Return type: dict Returns: **Response Syntax** { 'SubscriptionArn': 'string' } **Response Structure** * *(dict) --* Response for ConfirmSubscriptions action. * **SubscriptionArn** *(string) --* The ARN of the created subscription. **Exceptions** * "SNS.Client.exceptions.SubscriptionLimitExceededException" * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.FilterPolicyLimitExceededException" * "SNS.Client.exceptions.ReplayLimitExceededException" SNS / Client / list_topics list_topics *********** SNS.Client.list_topics(**kwargs) Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a "NextToken" is also returned. Use the "NextToken" parameter in a new "ListTopics" call to get further results. This action is throttled at 30 transactions per second (TPS). See also: AWS API Documentation **Request Syntax** response = client.list_topics( NextToken='string' ) Parameters: **NextToken** (*string*) -- Token returned by the previous "ListTopics" request. Return type: dict Returns: **Response Syntax** { 'Topics': [ { 'TopicArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Response for ListTopics action. * **Topics** *(list) --* A list of topic ARNs. * *(dict) --* A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use "GetTopicAttributes". * **TopicArn** *(string) --* The topic's ARN. * **NextToken** *(string) --* Token to pass along to the next "ListTopics" request. This element is returned if there are additional topics to retrieve. **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" SNS / Client / put_data_protection_policy put_data_protection_policy ************************** SNS.Client.put_data_protection_policy(**kwargs) Adds or updates an inline policy document that is stored in the specified Amazon SNS topic. See also: AWS API Documentation **Request Syntax** response = client.put_data_protection_policy( ResourceArn='string', DataProtectionPolicy='string' ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the topic whose "DataProtectionPolicy" you want to add or update. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. * **DataProtectionPolicy** (*string*) -- **[REQUIRED]** The JSON serialization of the topic's "DataProtectionPolicy". The "DataProtectionPolicy" must be in JSON string format. Length Constraints: Maximum length of 30,720. Returns: None **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InvalidSecurityException" SNS / Client / get_sms_sandbox_account_status get_sms_sandbox_account_status ****************************** SNS.Client.get_sms_sandbox_account_status() Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region. When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the *SMS sandbox*. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the *Amazon SNS Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_sms_sandbox_account_status() Return type: dict Returns: **Response Syntax** { 'IsInSandbox': True|False } **Response Structure** * *(dict) --* * **IsInSandbox** *(boolean) --* Indicates whether the calling Amazon Web Services account is in the SMS sandbox. **Exceptions** * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.ThrottledException" SNS / Client / create_topic create_topic ************ SNS.Client.create_topic(**kwargs) Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic in the *Amazon SNS Developer Guide*. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. See also: AWS API Documentation **Request Syntax** response = client.create_topic( Name='string', Attributes={ 'string': 'string' }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], DataProtectionPolicy='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the ".fifo" suffix. * **Attributes** (*dict*) -- A map of attributes with their corresponding values. The following lists names, descriptions, and values of the special request parameters that the "CreateTopic" action uses: * "DeliveryPolicy" – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints. * "DisplayName" – The display name to use for a topic with SMS subscriptions. * "Policy" – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic. * "TracingConfig" – Tracing mode of an Amazon SNS topic. By default "TracingConfig" is set to "PassThrough", and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to "Active", Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics. * HTTP * "HTTPSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint. * "HTTPSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint. * "HTTPFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint. * Amazon Data Firehose * "FirehoseSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. * "FirehoseSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. * "FirehoseFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. * Lambda * "LambdaSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint. * "LambdaSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint. * "LambdaFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint. * Platform application endpoint * "ApplicationSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint. * "ApplicationSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an platform application endpoint. * "ApplicationFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an platform application endpoint. Note: In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status. * Amazon SQS * "SQSSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. * "SQSSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. * "SQSFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. Note: The SuccessFeedbackRoleArn and FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. The following attribute applies only to server-side encryption: * "KmsMasterKeyId" – The ID of an Amazon Web Services 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 *Key Management Service API Reference*. The following attributes apply only to FIFO topics: * "ArchivePolicy" – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic. * "ContentBasedDeduplication" – Enables content-based deduplication for FIFO topics. * By default, "ContentBasedDeduplication" is set to "false". If you create a FIFO topic and this attribute is "false", you must specify a value for the "MessageDeduplicationId" parameter for the Publish action. * When you set "ContentBasedDeduplication" to "true", Amazon SNS uses a SHA-256 hash to generate the "MessageDeduplicationId" using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the "MessageDeduplicationId" parameter for the "Publish" action. * "FifoThroughputScope" – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values: * "Topic" – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first. * "MessageGroup" – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference. * *(string) --* * *(string) --* * **Tags** (*list*) -- The list of tags to add to a new topic. Note: To be able to tag a topic on creation, you must have the "sns:CreateTopic" and "sns:TagResource" permissions. * *(dict) --* The list of tags to be added to the specified topic. * **Key** *(string) --* **[REQUIRED]** The required key portion of the tag. * **Value** *(string) --* **[REQUIRED]** The optional value portion of the tag. * **DataProtectionPolicy** (*string*) -- The body of the policy document you want to use for this topic. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720. Return type: dict Returns: **Response Syntax** { 'TopicArn': 'string' } **Response Structure** * *(dict) --* Response from CreateTopic action. * **TopicArn** *(string) --* The Amazon Resource Name (ARN) assigned to the created topic. **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.TopicLimitExceededException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InvalidSecurityException" * "SNS.Client.exceptions.TagLimitExceededException" * "SNS.Client.exceptions.StaleTagException" * "SNS.Client.exceptions.TagPolicyException" * "SNS.Client.exceptions.ConcurrentAccessException" SNS / Client / create_sms_sandbox_phone_number create_sms_sandbox_phone_number ******************************* SNS.Client.create_sms_sandbox_phone_number(**kwargs) Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number. When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the *SMS sandbox*. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the *Amazon SNS Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_sms_sandbox_phone_number( PhoneNumber='string', LanguageCode='en-US'|'en-GB'|'es-419'|'es-ES'|'de-DE'|'fr-CA'|'fr-FR'|'it-IT'|'ja-JP'|'pt-BR'|'kr-KR'|'zh-CN'|'zh-TW' ) Parameters: * **PhoneNumber** (*string*) -- **[REQUIRED]** The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to. * **LanguageCode** (*string*) -- The language to use for sending the OTP. The default value is "en-US". Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.OptedOutException" * "SNS.Client.exceptions.UserErrorException" * "SNS.Client.exceptions.ThrottledException" SNS / Client / list_phone_numbers_opted_out list_phone_numbers_opted_out **************************** SNS.Client.list_phone_numbers_opted_out(**kwargs) Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them. The results for "ListPhoneNumbersOptedOut" are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a "NextToken" string will be returned. To receive the next page, you call "ListPhoneNumbersOptedOut" again using the "NextToken" string received from the previous call. When there are no more records to return, "NextToken" will be null. See also: AWS API Documentation **Request Syntax** response = client.list_phone_numbers_opted_out( nextToken='string' ) Parameters: **nextToken** (*string*) -- A "NextToken" string is used when you call the "ListPhoneNumbersOptedOut" action to retrieve additional records that are available after the first page of results. Return type: dict Returns: **Response Syntax** { 'phoneNumbers': [ 'string', ], 'nextToken': 'string' } **Response Structure** * *(dict) --* The response from the "ListPhoneNumbersOptedOut" action. * **phoneNumbers** *(list) --* A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers. * *(string) --* * **nextToken** *(string) --* A "NextToken" string is returned when you call the "ListPhoneNumbersOptedOut" action if additional records are available after the first page of results. **Exceptions** * "SNS.Client.exceptions.ThrottledException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InvalidParameterException" SNS / Client / list_tags_for_resource list_tags_for_resource ********************** SNS.Client.list_tags_for_resource(**kwargs) List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the *Amazon Simple Notification Service Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the topic for which to list tags. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Tags** *(list) --* The tags associated with the specified topic. * *(dict) --* The list of tags to be added to the specified topic. * **Key** *(string) --* The required key portion of the tag. * **Value** *(string) --* The optional value portion of the tag. **Exceptions** * "SNS.Client.exceptions.ResourceNotFoundException" * "SNS.Client.exceptions.TagPolicyException" * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.ConcurrentAccessException" SNS / Client / opt_in_phone_number opt_in_phone_number ******************* SNS.Client.opt_in_phone_number(**kwargs) Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number. You can opt in a phone number only once every 30 days. See also: AWS API Documentation **Request Syntax** response = client.opt_in_phone_number( phoneNumber='string' ) Parameters: **phoneNumber** (*string*) -- **[REQUIRED]** The phone number to opt in. Use E.164 format. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* The response for the OptInPhoneNumber action. **Exceptions** * "SNS.Client.exceptions.ThrottledException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InvalidParameterException" SNS / Client / check_if_phone_number_is_opted_out check_if_phone_number_is_opted_out ********************************** SNS.Client.check_if_phone_number_is_opted_out(**kwargs) Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out. To resume sending messages, you can opt in the number by using the "OptInPhoneNumber" action. See also: AWS API Documentation **Request Syntax** response = client.check_if_phone_number_is_opted_out( phoneNumber='string' ) Parameters: **phoneNumber** (*string*) -- **[REQUIRED]** The phone number for which you want to check the opt out status. Return type: dict Returns: **Response Syntax** { 'isOptedOut': True|False } **Response Structure** * *(dict) --* The response from the "CheckIfPhoneNumberIsOptedOut" action. * **isOptedOut** *(boolean) --* Indicates whether the phone number is opted out: * "true" – The phone number is opted out, meaning you cannot publish SMS messages to it. * "false" – The phone number is opted in, meaning you can publish SMS messages to it. **Exceptions** * "SNS.Client.exceptions.ThrottledException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InvalidParameterException" SNS / Client / untag_resource untag_resource ************** SNS.Client.untag_resource(**kwargs) Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the *Amazon SNS Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the topic from which to remove tags. * **TagKeys** (*list*) -- **[REQUIRED]** The list of tag keys to remove from the specified topic. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SNS.Client.exceptions.ResourceNotFoundException" * "SNS.Client.exceptions.TagLimitExceededException" * "SNS.Client.exceptions.StaleTagException" * "SNS.Client.exceptions.TagPolicyException" * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.ConcurrentAccessException" SNS / Client / list_platform_applications list_platform_applications ************************** SNS.Client.list_platform_applications(**kwargs) Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for "ListPlatformApplications" are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call "ListPlatformApplications" using the NextToken string received from the previous call. When there are no more records to return, "NextToken" will be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at 15 transactions per second (TPS). See also: AWS API Documentation **Request Syntax** response = client.list_platform_applications( NextToken='string' ) Parameters: **NextToken** (*string*) -- "NextToken" string is used when calling "ListPlatformApplications" action to retrieve additional records that are available after the first page results. Return type: dict Returns: **Response Syntax** { 'PlatformApplications': [ { 'PlatformApplicationArn': 'string', 'Attributes': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Response for "ListPlatformApplications" action. * **PlatformApplications** *(list) --* Platform applications returned when calling "ListPlatformApplications" action. * *(dict) --* Platform application object. * **PlatformApplicationArn** *(string) --* PlatformApplicationArn for platform application object. * **Attributes** *(dict) --* Attributes for platform application object. * *(string) --* * *(string) --* * **NextToken** *(string) --* "NextToken" string is returned when calling "ListPlatformApplications" action if additional records are available after the first page results. **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" SNS / Client / list_sms_sandbox_phone_numbers list_sms_sandbox_phone_numbers ****************************** SNS.Client.list_sms_sandbox_phone_numbers(**kwargs) Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox. When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the *SMS sandbox*. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the *Amazon SNS Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_sms_sandbox_phone_numbers( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- Token that the previous "ListSMSSandboxPhoneNumbersInput" request returns. * **MaxResults** (*integer*) -- The maximum number of phone numbers to return. Return type: dict Returns: **Response Syntax** { 'PhoneNumbers': [ { 'PhoneNumber': 'string', 'Status': 'Pending'|'Verified' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **PhoneNumbers** *(list) --* A list of the calling account's pending and verified phone numbers. * *(dict) --* A verified or pending destination phone number in the SMS sandbox. When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the *SMS sandbox*. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the *Amazon SNS Developer Guide*. * **PhoneNumber** *(string) --* The destination phone number. * **Status** *(string) --* The destination phone number's verification status. * **NextToken** *(string) --* A "NextToken" string is returned when you call the "ListSMSSandboxPhoneNumbersInput" operation if additional pages of records are available. **Exceptions** * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.ResourceNotFoundException" * "SNS.Client.exceptions.ThrottledException" SNS / Client / get_platform_application_attributes get_platform_application_attributes *********************************** SNS.Client.get_platform_application_attributes(**kwargs) Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. See also: AWS API Documentation **Request Syntax** response = client.get_platform_application_attributes( PlatformApplicationArn='string' ) Parameters: **PlatformApplicationArn** (*string*) -- **[REQUIRED]** "PlatformApplicationArn" for GetPlatformApplicationAttributesInput. Return type: dict Returns: **Response Syntax** { 'Attributes': { 'string': 'string' } } **Response Structure** * *(dict) --* Response for "GetPlatformApplicationAttributes" action. * **Attributes** *(dict) --* Attributes include the following: * "AppleCertificateExpiryDate" – The expiry date of the SSL certificate used to configure certificate-based authentication. * "ApplePlatformTeamID" – The Apple developer account ID used to configure token-based authentication. * "ApplePlatformBundleID" – The app identifier used to configure token-based authentication. * "AuthenticationMethod" – Returns the credential type used when sending push notifications from application to APNS/APNS_Sandbox, or application to GCM. * APNS – Returns the token or certificate. * GCM – Returns the token or key. * "EventEndpointCreated" – Topic ARN to which EndpointCreated event notifications should be sent. * "EventEndpointDeleted" – Topic ARN to which EndpointDeleted event notifications should be sent. * "EventEndpointUpdated" – Topic ARN to which EndpointUpdate event notifications should be sent. * "EventDeliveryFailure" – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints. * *(string) --* * *(string) --* **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.NotFoundException" SNS / Client / delete_endpoint delete_endpoint *************** SNS.Client.delete_endpoint(**kwargs) Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications. When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic. See also: AWS API Documentation **Request Syntax** response = client.delete_endpoint( EndpointArn='string' ) Parameters: **EndpointArn** (*string*) -- **[REQUIRED]** "EndpointArn" of endpoint to delete. Returns: None **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" SNS / Client / get_waiter get_waiter ********** SNS.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" SNS / Client / subscribe subscribe ********* SNS.Client.subscribe(**kwargs) Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must run the "ConfirmSubscription" action to confirm the subscription. You call the "ConfirmSubscription" action with the token from the subscription response. Confirmation tokens are valid for two days. This action is throttled at 100 transactions per second (TPS). See also: AWS API Documentation **Request Syntax** response = client.subscribe( TopicArn='string', Protocol='string', Endpoint='string', Attributes={ 'string': 'string' }, ReturnSubscriptionArn=True|False ) Parameters: * **TopicArn** (*string*) -- **[REQUIRED]** The ARN of the topic you want to subscribe to. * **Protocol** (*string*) -- **[REQUIRED]** 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 Data Firehose delivery stream. * **Endpoint** (*string*) -- 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 Data Firehose delivery stream. * **Attributes** (*dict*) -- 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 Data Firehose delivery stream subscriptions: * "SubscriptionRoleArn" – The ARN of the IAM role that has the following: * Permission to write to the Firehose delivery stream * Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to 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. * *(string) --* * *(string) --* * **ReturnSubscriptionArn** (*boolean*) -- 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". Return type: dict Returns: **Response Syntax** { 'SubscriptionArn': 'string' } **Response Structure** * *(dict) --* Response for Subscribe action. * **SubscriptionArn** *(string) --* The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires confirmation. However, if the API request parameter "ReturnSubscriptionArn" is true, then the value is always the subscription ARN, even if the subscription requires confirmation. **Exceptions** * "SNS.Client.exceptions.SubscriptionLimitExceededException" * "SNS.Client.exceptions.FilterPolicyLimitExceededException" * "SNS.Client.exceptions.ReplayLimitExceededException" * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InvalidSecurityException" SNS / Client / delete_sms_sandbox_phone_number delete_sms_sandbox_phone_number ******************************* SNS.Client.delete_sms_sandbox_phone_number(**kwargs) Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox. When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the *SMS sandbox*. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the *Amazon SNS Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.delete_sms_sandbox_phone_number( PhoneNumber='string' ) Parameters: **PhoneNumber** (*string*) -- **[REQUIRED]** The destination phone number to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.ResourceNotFoundException" * "SNS.Client.exceptions.UserErrorException" * "SNS.Client.exceptions.ThrottledException" SNS / Client / unsubscribe unsubscribe *********** SNS.Client.unsubscribe(**kwargs) Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature is required. If the "Unsubscribe" call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the "Unsubscribe" request was unintended. This action is throttled at 100 transactions per second (TPS). See also: AWS API Documentation **Request Syntax** response = client.unsubscribe( SubscriptionArn='string' ) Parameters: **SubscriptionArn** (*string*) -- **[REQUIRED]** The ARN of the subscription to be deleted. Returns: None **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.InvalidSecurityException" SNS / Client / create_platform_endpoint create_platform_endpoint ************************ SNS.Client.create_platform_endpoint(**kwargs) Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. "CreatePlatformEndpoint" requires the "PlatformApplicationArn" that is returned from "CreatePlatformApplication". You can use the returned "EndpointArn" to send a message to a mobile app or by the "Subscribe" action for subscription to a topic. The "CreatePlatformEndpoint" action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications. When using "CreatePlatformEndpoint" with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu. See also: AWS API Documentation **Request Syntax** response = client.create_platform_endpoint( PlatformApplicationArn='string', Token='string', CustomUserData='string', Attributes={ 'string': 'string' } ) Parameters: * **PlatformApplicationArn** (*string*) -- **[REQUIRED]** "PlatformApplicationArn" returned from CreatePlatformApplication is used to create a an endpoint. * **Token** (*string*) -- **[REQUIRED]** Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID. * **CustomUserData** (*string*) -- Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. * **Attributes** (*dict*) -- For a list of attributes, see SetEndpointAttributes. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'EndpointArn': 'string' } **Response Structure** * *(dict) --* Response from CreateEndpoint action. * **EndpointArn** *(string) --* EndpointArn returned from CreateEndpoint action. **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.NotFoundException" SNS / Client / delete_topic delete_topic ************ SNS.Client.delete_topic(**kwargs) Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. See also: AWS API Documentation **Request Syntax** response = client.delete_topic( TopicArn='string' ) Parameters: **TopicArn** (*string*) -- **[REQUIRED]** The ARN of the topic you want to delete. Returns: None **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InvalidStateException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.StaleTagException" * "SNS.Client.exceptions.TagPolicyException" * "SNS.Client.exceptions.ConcurrentAccessException" SNS / Client / list_origination_numbers list_origination_numbers ************************ SNS.Client.list_origination_numbers(**kwargs) Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the *Amazon SNS Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_origination_numbers( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- Token that the previous "ListOriginationNumbers" request returns. * **MaxResults** (*integer*) -- The maximum number of origination numbers to return. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'PhoneNumbers': [ { 'CreatedAt': datetime(2015, 1, 1), 'PhoneNumber': 'string', 'Status': 'string', 'Iso2CountryCode': 'string', 'RouteType': 'Transactional'|'Promotional'|'Premium', 'NumberCapabilities': [ 'SMS'|'MMS'|'VOICE', ] }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* A "NextToken" string is returned when you call the "ListOriginationNumbers" operation if additional pages of records are available. * **PhoneNumbers** *(list) --* A list of the calling account's verified and pending origination numbers. * *(dict) --* A list of phone numbers and their metadata. * **CreatedAt** *(datetime) --* The date and time when the phone number was created. * **PhoneNumber** *(string) --* The phone number. * **Status** *(string) --* The status of the phone number. * **Iso2CountryCode** *(string) --* The two-character code for the country or region, in ISO 3166-1 alpha-2 format. * **RouteType** *(string) --* The list of supported routes. * **NumberCapabilities** *(list) --* The capabilities of each phone number. * *(string) --* Enum listing out all supported number capabilities. **Exceptions** * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.ThrottledException" * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.ValidationException" SNS / Client / remove_permission remove_permission ***************** SNS.Client.remove_permission(**kwargs) Removes a statement from a topic's access control policy. Note: To remove the ability to change topic permissions, you must deny permissions to the "AddPermission", "RemovePermission", and "SetTopicAttributes" actions in your IAM policy. See also: AWS API Documentation **Request Syntax** response = client.remove_permission( TopicArn='string', Label='string' ) Parameters: * **TopicArn** (*string*) -- **[REQUIRED]** The ARN of the topic whose access control policy you wish to modify. * **Label** (*string*) -- **[REQUIRED]** The unique label of the statement you want to remove. Returns: None **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.NotFoundException" SNS / Client / publish publish ******* SNS.Client.publish(**kwargs) Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the "TargetArn"). If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint. When a "messageId" is returned, the message is saved and Amazon SNS immediately delivers it to subscribers. To use the "Publish" action for publishing a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the "CreatePlatformEndpoint" action. For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices. Warning: You can publish messages only to topics and endpoints in the same Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = client.publish( TopicArn='string', TargetArn='string', PhoneNumber='string', Message='string', Subject='string', MessageStructure='string', MessageAttributes={ 'string': { 'DataType': 'string', 'StringValue': 'string', 'BinaryValue': b'bytes' } }, MessageDeduplicationId='string', MessageGroupId='string' ) Parameters: * **TopicArn** (*string*) -- The topic you want to publish to. If you don't specify a value for the "TopicArn" parameter, you must specify a value for the "PhoneNumber" or "TargetArn" parameters. * **TargetArn** (*string*) -- If you don't specify a value for the "TargetArn" parameter, you must specify a value for the "PhoneNumber" or "TopicArn" parameters. * **PhoneNumber** (*string*) -- The phone number to which you want to deliver an SMS message. Use E.164 format. If you don't specify a value for the "PhoneNumber" parameter, you must specify a value for the "TargetArn" or "TopicArn" parameters. * **Message** (*string*) -- **[REQUIRED]** The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the "MessageStructure" parameter to "json" and use a JSON object for the "Message" parameter. Constraints: * With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters). * For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole- word boundaries. The total size limit for a single SMS "Publish" action is 1,600 characters. JSON-specific constraints: * Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. * The values will be parsed (unescaped) before they are used in outgoing messages. * Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending). * Values have a minimum length of 0 (the empty string, "", is allowed). * Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes). * Non-string values will cause the key to be ignored. * Keys that do not correspond to supported transport protocols are ignored. * Duplicate keys are not allowed. * Failure to parse or validate any key or value in the message will cause the "Publish" call to return an error (no partial delivery). * **Subject** (*string*) -- Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long. * **MessageStructure** (*string*) -- Set "MessageStructure" to "json" if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set "MessageStructure" to "json", the value of the "Message" parameter must: * be a syntactically valid JSON object; and * contain at least a top-level JSON key of "default" with a value that is a string. You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). Valid value: "json" * **MessageAttributes** (*dict*) -- Message attributes for Publish action. * *(string) --* * *(dict) --* The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish. Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Amazon SNS message attributes and Publishing to a mobile phone in the *Amazon SNS Developer Guide.* * **DataType** *(string) --* **[REQUIRED]** Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types. * **StringValue** *(string) --* Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters. * **BinaryValue** *(bytes) --* Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images. * **MessageDeduplicationId** (*string*) -- * This parameter applies only to FIFO (first-in-first-out) topics. The "MessageDeduplicationId" can contain up to 128 alphanumeric characters "(a-z, A-Z, 0-9)" and punctuation "(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)". * Every message must have a unique "MessageDeduplicationId", which is a token used for deduplication of sent messages within the 5 minute minimum deduplication interval. * The scope of deduplication depends on the "FifoThroughputScope" attribute, when set to "Topic" the message deduplication scope is across the entire topic, when set to "MessageGroup" the message deduplication scope is within each individual message group. * If a message with a particular "MessageDeduplicationId" is sent successfully, subsequent messages within the deduplication scope and interval, with the same "MessageDeduplicationId", are accepted successfully but aren't delivered. * Every message must have a unique "MessageDeduplicationId": * You may provide a "MessageDeduplicationId" explicitly. * If you aren't able to provide a "MessageDeduplicationId" and you enable "ContentBasedDeduplication" for your topic, Amazon SNS uses a SHA-256 hash to generate the "MessageDeduplicationId" using the body of the message (but not the attributes of the message). * If you don't provide a "MessageDeduplicationId" and the topic doesn't have "ContentBasedDeduplication" set, the action fails with an error. * If the topic has a "ContentBasedDeduplication" set, your "MessageDeduplicationId" overrides the generated one. * When "ContentBasedDeduplication" is in effect, messages with identical content sent within the deduplication scope and interval are treated as duplicates and only one copy of the message is delivered. * If you send one message with "ContentBasedDeduplication" enabled, and then another message with a "MessageDeduplicationId" that is the same as the one generated for the first "MessageDeduplicationId", the two messages are treated as duplicates, within the deduplication scope and interval, and only one copy of the message is delivered. * **MessageGroupId** (*string*) -- The "MessageGroupId" can contain up to 128 alphanumeric characters "(a-z, A-Z, 0-9)" and punctuation "(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)". For FIFO topics: The "MessageGroupId" is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a "MessageGroupId". For standard topics: The "MessageGroupId" is optional and is forwarded only to Amazon SQS standard subscriptions to activate fair queues. The "MessageGroupId" is not used for, or sent to, any other endpoint types. When provided, the same validation rules apply as for FIFO topics. Return type: dict Returns: **Response Syntax** { 'MessageId': 'string', 'SequenceNumber': 'string' } **Response Structure** * *(dict) --* Response for Publish action. * **MessageId** *(string) --* Unique identifier assigned to the published message. Length Constraint: Maximum 100 characters * **SequenceNumber** *(string) --* This response element applies only to FIFO (first-in-first- out) topics. The sequence number is a large, non-consecutive number that Amazon SNS assigns to each message. The length of "SequenceNumber" is 128 bits. "SequenceNumber" continues to increase for each "MessageGroupId". **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InvalidParameterValueException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.EndpointDisabledException" * "SNS.Client.exceptions.PlatformApplicationDisabledException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.KMSDisabledException" * "SNS.Client.exceptions.KMSInvalidStateException" * "SNS.Client.exceptions.KMSNotFoundException" * "SNS.Client.exceptions.KMSOptInRequired" * "SNS.Client.exceptions.KMSThrottlingException" * "SNS.Client.exceptions.KMSAccessDeniedException" * "SNS.Client.exceptions.InvalidSecurityException" * "SNS.Client.exceptions.ValidationException" SNS / Client / set_topic_attributes set_topic_attributes ******************** SNS.Client.set_topic_attributes(**kwargs) Allows a topic owner to set an attribute of the topic to a new value. Note: To remove the ability to change topic permissions, you must deny permissions to the "AddPermission", "RemovePermission", and "SetTopicAttributes" actions in your IAM policy. See also: AWS API Documentation **Request Syntax** response = client.set_topic_attributes( TopicArn='string', AttributeName='string', AttributeValue='string' ) Parameters: * **TopicArn** (*string*) -- **[REQUIRED]** The ARN of the topic to modify. * **AttributeName** (*string*) -- **[REQUIRED]** A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the "SetTopicAttributes" action uses: * "DeliveryPolicy" – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints. * "DisplayName" – The display name to use for a topic with SMS subscriptions. * "Policy" – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic. * "TracingConfig" – Tracing mode of an Amazon SNS topic. By default "TracingConfig" is set to "PassThrough", and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to "Active", Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics. * HTTP * "HTTPSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint. * "HTTPSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint. * "HTTPFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint. * Amazon Data Firehose * "FirehoseSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. * "FirehoseSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. * "FirehoseFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. * Lambda * "LambdaSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint. * "LambdaSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint. * "LambdaFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint. * Platform application endpoint * "ApplicationSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an platform application endpoint. * "ApplicationSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an platform application endpoint. * "ApplicationFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an platform application endpoint. Note: In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status. * Amazon SQS * "SQSSuccessFeedbackRoleArn" – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. * "SQSSuccessFeedbackSampleRate" – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. * "SQSFailureFeedbackRoleArn" – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. Note: The SuccessFeedbackRoleArn and FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. The following attribute applies only to server-side- encryption: * "KmsMasterKeyId" – The ID of an Amazon Web Services 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 *Key Management Service API Reference*. * "SignatureVersion" – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, "SignatureVersion" is set to "1". The following attribute applies only to FIFO topics: * "ArchivePolicy" – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic. * "ContentBasedDeduplication" – Enables content-based deduplication for FIFO topics. * By default, "ContentBasedDeduplication" is set to "false". If you create a FIFO topic and this attribute is "false", you must specify a value for the "MessageDeduplicationId" parameter for the Publish action. * When you set "ContentBasedDeduplication" to "true", Amazon SNS uses a SHA-256 hash to generate the "MessageDeduplicationId" using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the "MessageDeduplicationId" parameter for the "Publish" action. * "FifoThroughputScope" – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values: * "Topic" – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first. * "MessageGroup" – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference. * **AttributeValue** (*string*) -- The new value for the attribute. Returns: None **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InvalidSecurityException" SNS / Client / list_endpoints_by_platform_application list_endpoints_by_platform_application ************************************** SNS.Client.list_endpoints_by_platform_application(**kwargs) Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for "ListEndpointsByPlatformApplication" are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call "ListEndpointsByPlatformApplication" again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at 30 transactions per second (TPS). See also: AWS API Documentation **Request Syntax** response = client.list_endpoints_by_platform_application( PlatformApplicationArn='string', NextToken='string' ) Parameters: * **PlatformApplicationArn** (*string*) -- **[REQUIRED]** "PlatformApplicationArn" for "ListEndpointsByPlatformApplicationInput" action. * **NextToken** (*string*) -- "NextToken" string is used when calling "ListEndpointsByPlatformApplication" action to retrieve additional records that are available after the first page results. Return type: dict Returns: **Response Syntax** { 'Endpoints': [ { 'EndpointArn': 'string', 'Attributes': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Response for "ListEndpointsByPlatformApplication" action. * **Endpoints** *(list) --* Endpoints returned for "ListEndpointsByPlatformApplication" action. * *(dict) --* The endpoint for mobile app and device. * **EndpointArn** *(string) --* The "EndpointArn" for mobile app and device. * **Attributes** *(dict) --* Attributes for endpoint. * *(string) --* * *(string) --* * **NextToken** *(string) --* "NextToken" string is returned when calling "ListEndpointsByPlatformApplication" action if additional records are available after the first page results. **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.NotFoundException" SNS / Client / close close ***** SNS.Client.close() Closes underlying endpoint connections. SNS / Client / get_endpoint_attributes get_endpoint_attributes *********************** SNS.Client.get_endpoint_attributes(**kwargs) Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications. See also: AWS API Documentation **Request Syntax** response = client.get_endpoint_attributes( EndpointArn='string' ) Parameters: **EndpointArn** (*string*) -- **[REQUIRED]** "EndpointArn" for "GetEndpointAttributes" input. Return type: dict Returns: **Response Syntax** { 'Attributes': { 'string': 'string' } } **Response Structure** * *(dict) --* Response from "GetEndpointAttributes" of the "EndpointArn". * **Attributes** *(dict) --* Attributes include the following: * "CustomUserData" – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. * "Enabled" – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token. * "Token" – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service. Note: The device token for the iOS platform is returned in lowercase. * *(string) --* * *(string) --* **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.NotFoundException" SNS / Client / delete_platform_application delete_platform_application *************************** SNS.Client.delete_platform_application(**kwargs) Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. See also: AWS API Documentation **Request Syntax** response = client.delete_platform_application( PlatformApplicationArn='string' ) Parameters: **PlatformApplicationArn** (*string*) -- **[REQUIRED]** "PlatformApplicationArn" of platform application object to delete. Returns: None **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" SNS / Client / get_data_protection_policy get_data_protection_policy ************************** SNS.Client.get_data_protection_policy(**kwargs) Retrieves the specified inline "DataProtectionPolicy" document that is stored in the specified Amazon SNS topic. See also: AWS API Documentation **Request Syntax** response = client.get_data_protection_policy( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the topic whose "DataProtectionPolicy" you want to get. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. Return type: dict Returns: **Response Syntax** { 'DataProtectionPolicy': 'string' } **Response Structure** * *(dict) --* * **DataProtectionPolicy** *(string) --* Retrieves the "DataProtectionPolicy" in JSON string format. **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InvalidSecurityException" SNS / Client / get_subscription_attributes get_subscription_attributes *************************** SNS.Client.get_subscription_attributes(**kwargs) Returns all of the properties of a subscription. See also: AWS API Documentation **Request Syntax** response = client.get_subscription_attributes( SubscriptionArn='string' ) Parameters: **SubscriptionArn** (*string*) -- **[REQUIRED]** The ARN of the subscription whose properties you want to get. Return type: dict Returns: **Response Syntax** { 'Attributes': { 'string': 'string' } } **Response Structure** * *(dict) --* Response for GetSubscriptionAttributes action. * **Attributes** *(dict) --* A map of the subscription's attributes. Attributes in this map include the following: * "ConfirmationWasAuthenticated" – "true" 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*. * "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. * "Owner" – The Amazon Web Services account ID of the subscription's owner. * "PendingConfirmation" – "true" if the subscription hasn't been confirmed. To confirm a pending subscription, call the "ConfirmSubscription" action with a confirmation token. * "RawMessageDelivery" – "true" 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 Data Firehose delivery stream subscriptions: * "SubscriptionRoleArn" – The ARN of the IAM role that has the following: * Permission to write to the Firehose delivery stream * Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the *Amazon SNS Developer Guide*. * *(string) --* * *(string) --* **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.AuthorizationErrorException" SNS / Client / get_sms_attributes get_sms_attributes ****************** SNS.Client.get_sms_attributes(**kwargs) Returns the settings for sending SMS messages from your Amazon Web Services account. These settings are set with the "SetSMSAttributes" action. See also: AWS API Documentation **Request Syntax** response = client.get_sms_attributes( attributes=[ 'string', ] ) Parameters: **attributes** (*list*) -- A list of the individual attribute names, such as "MonthlySpendLimit", for which you want values. For all attribute names, see SetSMSAttributes. If you don't use this parameter, Amazon SNS returns all SMS attributes. * *(string) --* Return type: dict Returns: **Response Syntax** { 'attributes': { 'string': 'string' } } **Response Structure** * *(dict) --* The response from the "GetSMSAttributes" request. * **attributes** *(dict) --* The SMS attribute names and their values. * *(string) --* * *(string) --* **Exceptions** * "SNS.Client.exceptions.ThrottledException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.InvalidParameterException" SNS / Client / set_subscription_attributes set_subscription_attributes *************************** SNS.Client.set_subscription_attributes(**kwargs) Allows a subscription owner to set an attribute of the subscription to a new value. See also: AWS API Documentation **Request Syntax** response = client.set_subscription_attributes( SubscriptionArn='string', AttributeName='string', AttributeValue='string' ) Parameters: * **SubscriptionArn** (*string*) -- **[REQUIRED]** The ARN of the subscription to modify. * **AttributeName** (*string*) -- **[REQUIRED]** A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that this 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 Data Firehose delivery stream subscriptions: * "SubscriptionRoleArn" – The ARN of the IAM role that has the following: * Permission to write to the Firehose delivery stream * Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the *Amazon SNS Developer Guide*. * **AttributeValue** (*string*) -- The new value for the attribute in JSON format. Returns: None **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.FilterPolicyLimitExceededException" * "SNS.Client.exceptions.ReplayLimitExceededException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.AuthorizationErrorException" SNS / Client / add_permission add_permission ************** SNS.Client.add_permission(**kwargs) Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions. Note: To remove the ability to change topic permissions, you must deny permissions to the "AddPermission", "RemovePermission", and "SetTopicAttributes" actions in your IAM policy. See also: AWS API Documentation **Request Syntax** response = client.add_permission( TopicArn='string', Label='string', AWSAccountId=[ 'string', ], ActionName=[ 'string', ] ) Parameters: * **TopicArn** (*string*) -- **[REQUIRED]** The ARN of the topic whose access control policy you wish to modify. * **Label** (*string*) -- **[REQUIRED]** A unique identifier for the new policy statement. * **AWSAccountId** (*list*) -- **[REQUIRED]** The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service. * *(string) --* * **ActionName** (*list*) -- **[REQUIRED]** The action you want to allow for the specified principal(s). Valid values: Any Amazon SNS action name, for example "Publish". * *(string) --* Returns: None **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.NotFoundException" SNS / Client / set_endpoint_attributes set_endpoint_attributes *********************** SNS.Client.set_endpoint_attributes(**kwargs) Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications. See also: AWS API Documentation **Request Syntax** response = client.set_endpoint_attributes( EndpointArn='string', Attributes={ 'string': 'string' } ) Parameters: * **EndpointArn** (*string*) -- **[REQUIRED]** EndpointArn used for "SetEndpointAttributes" action. * **Attributes** (*dict*) -- **[REQUIRED]** A map of the endpoint attributes. Attributes in this map include the following: * "CustomUserData" – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. * "Enabled" – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token. * "Token" – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service. * *(string) --* * *(string) --* Returns: None **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.NotFoundException" SNS / Client / tag_resource tag_resource ************ SNS.Client.tag_resource(**kwargs) Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the *Amazon SNS Developer Guide*. When you use topic tags, keep the following guidelines in mind: * Adding more than 50 tags to a topic isn't recommended. * Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings. * Tags are case-sensitive. * A new tag with a key identical to that of an existing tag overwrites the existing tag. * Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the topic to which to add tags. * **Tags** (*list*) -- **[REQUIRED]** The tags to be added to the specified topic. A tag consists of a required key and an optional value. * *(dict) --* The list of tags to be added to the specified topic. * **Key** *(string) --* **[REQUIRED]** The required key portion of the tag. * **Value** *(string) --* **[REQUIRED]** The optional value portion of the tag. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SNS.Client.exceptions.ResourceNotFoundException" * "SNS.Client.exceptions.TagLimitExceededException" * "SNS.Client.exceptions.StaleTagException" * "SNS.Client.exceptions.TagPolicyException" * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.AuthorizationErrorException" * "SNS.Client.exceptions.ConcurrentAccessException" SNS / Client / list_subscriptions_by_topic list_subscriptions_by_topic *************************** SNS.Client.list_subscriptions_by_topic(**kwargs) Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a "NextToken" is also returned. Use the "NextToken" parameter in a new "ListSubscriptionsByTopic" call to get further results. This action is throttled at 30 transactions per second (TPS). See also: AWS API Documentation **Request Syntax** response = client.list_subscriptions_by_topic( TopicArn='string', NextToken='string' ) Parameters: * **TopicArn** (*string*) -- **[REQUIRED]** The ARN of the topic for which you wish to find subscriptions. * **NextToken** (*string*) -- Token returned by the previous "ListSubscriptionsByTopic" request. Return type: dict Returns: **Response Syntax** { 'Subscriptions': [ { 'SubscriptionArn': 'string', 'Owner': 'string', 'Protocol': 'string', 'Endpoint': 'string', 'TopicArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Response for ListSubscriptionsByTopic action. * **Subscriptions** *(list) --* A list of subscriptions. * *(dict) --* A wrapper type for the attributes of an Amazon SNS subscription. * **SubscriptionArn** *(string) --* The subscription's ARN. * **Owner** *(string) --* The subscription's owner. * **Protocol** *(string) --* The subscription's protocol. * **Endpoint** *(string) --* The subscription's endpoint (format depends on the protocol). * **TopicArn** *(string) --* The ARN of the subscription's topic. * **NextToken** *(string) --* Token to pass along to the next "ListSubscriptionsByTopic" request. This element is returned if there are more subscriptions to retrieve. **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.NotFoundException" * "SNS.Client.exceptions.AuthorizationErrorException" SNS / Client / set_sms_attributes set_sms_attributes ****************** SNS.Client.set_sms_attributes(**kwargs) Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports. You can override some of these settings for a single message when you use the "Publish" action with the "MessageAttributes.entry.N" parameter. For more information, see Publishing to a mobile phone in the *Amazon SNS Developer Guide*. Note: To use this operation, you must grant the Amazon SNS service principal ( "sns.amazonaws.com") permission to perform the "s3:ListBucket" action. See also: AWS API Documentation **Request Syntax** response = client.set_sms_attributes( attributes={ 'string': 'string' } ) Parameters: **attributes** (*dict*) -- **[REQUIRED]** The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names: "MonthlySpendLimit" – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes. Warning: Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit. By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For **New limit value**, enter your desired monthly spend limit. In the **Use Case Description** field, explain that you are requesting an SMS monthly spend limit increase. "DeliveryStatusIAMRole" – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information. "DeliveryStatusSuccessSamplingRate" – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to "0". To write logs for 10% of your successful deliveries, set it to "10". "DefaultSenderID" – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter. "DefaultSMSType" – The type of SMS message that you will send by default. You can assign the following values: * "Promotional" – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost. * "Transactional" – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability. "UsageReportS3Bucket" – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your Amazon Web Services account: * Time that the message was published (in UTC) * Message ID * Destination phone number * Message type * Delivery status * Message price (in USD) * Part number (a message is split into multiple parts if it is too long for a single message) * Total number of parts To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the "s3:PutObject" and "s3:GetBucketLocation" actions. For an example bucket policy and usage report, see Monitoring SMS Activity in the *Amazon SNS Developer Guide*. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* The response for the SetSMSAttributes action. **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.ThrottledException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" SNS / Client / create_platform_application create_platform_application *************************** SNS.Client.create_platform_application(**kwargs) Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify "PlatformPrincipal" and "PlatformCredential" attributes when using the "CreatePlatformApplication" action. "PlatformPrincipal" and "PlatformCredential" are received from the notification service. * For ADM, "PlatformPrincipal" is "client id" and "PlatformCredential" is "client secret". * For APNS and "APNS_SANDBOX" using certificate credentials, "PlatformPrincipal" is "SSL certificate" and "PlatformCredential" is "private key". * For APNS and "APNS_SANDBOX" using token credentials, "PlatformPrincipal" is "signing key ID" and "PlatformCredential" is "signing key". * For Baidu, "PlatformPrincipal" is "API key" and "PlatformCredential" is "secret key". * For GCM (Firebase Cloud Messaging) using key credentials, there is no "PlatformPrincipal". The "PlatformCredential" is "API key". * For GCM (Firebase Cloud Messaging) using token credentials, there is no "PlatformPrincipal". The "PlatformCredential" is a JSON formatted private key file. When using the Amazon Web Services CLI or Amazon Web Services SDKs, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: "SERVICE_JSON=$(jq @json < service.json)". * For MPNS, "PlatformPrincipal" is "TLS certificate" and "PlatformCredential" is "private key". * For WNS, "PlatformPrincipal" is "Package Security Identifier" and "PlatformCredential" is "secret key". You can use the returned "PlatformApplicationArn" as an attribute for the "CreatePlatformEndpoint" action. See also: AWS API Documentation **Request Syntax** response = client.create_platform_application( Name='string', Platform='string', Attributes={ 'string': 'string' } ) Parameters: * **Name** (*string*) -- **[REQUIRED]** Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long. * **Platform** (*string*) -- **[REQUIRED]** The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging). * **Attributes** (*dict*) -- **[REQUIRED]** For a list of attributes, see SetPlatformApplicationAttributes. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'PlatformApplicationArn': 'string' } **Response Structure** * *(dict) --* Response from CreatePlatformApplication action. * **PlatformApplicationArn** *(string) --* "PlatformApplicationArn" is returned. **Exceptions** * "SNS.Client.exceptions.InvalidParameterException" * "SNS.Client.exceptions.InternalErrorException" * "SNS.Client.exceptions.AuthorizationErrorException" SNS / Client / set_platform_application_attributes set_platform_application_attributes *********************************** SNS.Client.set_platform_application_attributes(**kwargs) Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status. See also: AWS API Documentation **Request Syntax** response = client.set_platform_application_attributes( PlatformApplicationArn='string', Attributes={ 'string': 'string' } ) Parameters: * **PlatformApplicationArn** (*string*) -- **[REQUIRED]** "PlatformApplicationArn" for "SetPlatformApplicationAttributes" action. * **Attributes** (*dict*) -- **[REQUIRED]** A map of the platform application attributes. Attributes in this map include the following: * "PlatformCredential" – The credential received from the notification service. * For ADM, >>``<>``<