Table of Contents
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()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',
]
)
[REQUIRED]
The ARN of the topic whose access control policy you wish to modify.
[REQUIRED]
A unique identifier for the new policy statement.
[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.
[REQUIRED]
The action you want to allow for the specified principal(s).
Valid values: Any Amazon SNS action name, for example Publish .
None
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.NotFoundExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
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").True if the operation can be paginated,
False otherwise.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'
)
[REQUIRED]
The phone number for which you want to check the opt out status.
{
'isOptedOut': True|False
}
Response Structure
The response from the CheckIfPhoneNumberIsOptedOut action.
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.ThrottledExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InvalidParameterExceptionclose()¶Closes underlying endpoint connections.
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'
)
[REQUIRED]
The ARN of the topic for which you wish to confirm a subscription.
[REQUIRED]
Short-lived token sent to an endpoint during the Subscribe action.
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.dict
Response Syntax
{
'SubscriptionArn': 'string'
}
Response Structure
(dict) --
Response for ConfirmSubscriptions action.
SubscriptionArn (string) --
The ARN of the created subscription.
Exceptions
SNS.Client.exceptions.SubscriptionLimitExceededExceptionSNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.FilterPolicyLimitExceededExceptioncreate_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.
PlatformPrincipalandPlatformCredentialare received from the notification service.
ADM , PlatformPrincipal is client id and PlatformCredential is client secret .Baidu , PlatformPrincipal is API key and PlatformCredential is secret key .APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key .APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key .GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key .MPNS , PlatformPrincipal is TLS certificate and PlatformCredential is private key .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'
}
)
[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.
[REQUIRED]
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).
[REQUIRED]
For a list of attributes, see SetPlatformApplicationAttributes.
dict
Response Syntax
{
'PlatformApplicationArn': 'string'
}
Response Structure
(dict) --
Response from CreatePlatformApplication action.
PlatformApplicationArn (string) --
PlatformApplicationArn is returned.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptioncreate_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'
}
)
[REQUIRED]
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
[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.
For a list of attributes, see SetEndpointAttributes.
dict
Response Syntax
{
'EndpointArn': 'string'
}
Response Structure
(dict) --
Response from CreateEndpoint action.
EndpointArn (string) --
EndpointArn returned from CreateEndpoint action.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.NotFoundExceptioncreate_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'
)
[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.
en-US .dict
Response Syntax
{}
Response Structure
Exceptions
SNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.OptedOutExceptionSNS.Client.exceptions.UserErrorExceptionSNS.Client.exceptions.ThrottledExceptioncreate_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'
)
[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.
A map of attributes with their corresponding values.
The following lists the 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.FifoTopic – Set to true to create a FIFO topic.Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.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.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:
FifoTopic – When this is set to true , a FIFO topic is created.ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.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.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.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.
The list of tags to be added to the specified topic.
The required key portion of the tag.
The optional value portion of the tag.
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.
dict
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.InvalidParameterExceptionSNS.Client.exceptions.TopicLimitExceededExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InvalidSecurityExceptionSNS.Client.exceptions.TagLimitExceededExceptionSNS.Client.exceptions.StaleTagExceptionSNS.Client.exceptions.TagPolicyExceptionSNS.Client.exceptions.ConcurrentAccessExceptiondelete_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'
)
[REQUIRED]
EndpointArn of endpoint to delete.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptiondelete_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'
)
[REQUIRED]
PlatformApplicationArn of platform application object to delete.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptiondelete_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'
)
[REQUIRED]
The destination phone number to delete.
{}
Response Structure
Exceptions
SNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.ResourceNotFoundExceptionSNS.Client.exceptions.UserErrorExceptionSNS.Client.exceptions.ThrottledExceptiondelete_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'
)
[REQUIRED]
The ARN of the topic you want to delete.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.StaleTagExceptionSNS.Client.exceptions.TagPolicyExceptionSNS.Client.exceptions.ConcurrentAccessExceptionget_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'
)
[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.
{
'DataProtectionPolicy': 'string'
}
Response Structure
Retrieves the DataProtectionPolicy in JSON string format.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InvalidSecurityExceptionget_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'
)
[REQUIRED]
EndpointArn for GetEndpointAttributes input.
{
'Attributes': {
'string': 'string'
}
}
Response Structure
Response from GetEndpointAttributes of the EndpointArn.
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.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.NotFoundExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.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'
)
[REQUIRED]
PlatformApplicationArn for GetPlatformApplicationAttributesInput.
{
'Attributes': {
'string': 'string'
}
}
Response Structure
Response for GetPlatformApplicationAttributes action.
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.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.Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.NotFoundExceptionget_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',
]
)
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.
{
'attributes': {
'string': 'string'
}
}
Response Structure
The response from the GetSMSAttributes request.
The SMS attribute names and their values.
Exceptions
SNS.Client.exceptions.ThrottledExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InvalidParameterExceptionget_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()
{
'IsInSandbox': True|False
}
Response Structure
Indicates whether the calling Amazon Web Services account is in the SMS sandbox.
Exceptions
SNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.ThrottledExceptionget_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'
)
[REQUIRED]
The ARN of the subscription whose properties you want to get.
{
'Attributes': {
'string': 'string'
}
}
Response Structure
Response for GetSubscriptionAttributes action.
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 Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide .
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.AuthorizationErrorExceptionget_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'
)
[REQUIRED]
The ARN of the topic whose properties you want to get.
{
'Attributes': {
'string': 'string'
}
}
Response Structure
Response for GetTopicAttributes action.
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 version of the Amazon SNS signature used for the topic.SignatureVersion is set to 1 . The signature is a Base64-encoded SHA1withRSA signature.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:
FifoTopic – When this is set to true , a FIFO topic is created.ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.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.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.Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InvalidSecurityExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
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'
)
[REQUIRED]
PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
dict
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.
NextToken (string) --
NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.NotFoundExceptionlist_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
)
ListOriginationNumbers request returns.dict
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.
Exceptions
SNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.ThrottledExceptionSNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.ValidationExceptionlist_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'
)
NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.{
'phoneNumbers': [
'string',
],
'nextToken': 'string'
}
Response Structure
The response from the ListPhoneNumbersOptedOut action.
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.
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.ThrottledExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InvalidParameterExceptionlist_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'
)
{
'PlatformApplications': [
{
'PlatformApplicationArn': 'string',
'Attributes': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
Response for ListPlatformApplications action.
Platform applications returned when calling ListPlatformApplications action.
Platform application object.
PlatformApplicationArn for platform application object.
Attributes for platform application object.
NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionlist_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
)
ListSMSSandboxPhoneNumbersInput request returns.dict
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.AuthorizationErrorExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.ResourceNotFoundExceptionSNS.Client.exceptions.ThrottledExceptionlist_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'
)
ListSubscriptions request.{
'Subscriptions': [
{
'SubscriptionArn': 'string',
'Owner': 'string',
'Protocol': 'string',
'Endpoint': 'string',
'TopicArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Response for ListSubscriptions action
A list of subscriptions.
A wrapper type for the attributes of an Amazon SNS subscription.
The subscription's ARN.
The subscription's owner.
The subscription's protocol.
The subscription's endpoint (format depends on the protocol).
The ARN of the subscription's topic.
Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionlist_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'
)
[REQUIRED]
The ARN of the topic for which you wish to find subscriptions.
ListSubscriptionsByTopic request.dict
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.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.AuthorizationErrorExceptionList 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'
)
[REQUIRED]
The ARN of the topic for which to list tags.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The tags associated with the specified topic.
The list of tags to be added to the specified topic.
The required key portion of the tag.
The optional value portion of the tag.
Exceptions
SNS.Client.exceptions.ResourceNotFoundExceptionSNS.Client.exceptions.TagPolicyExceptionSNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.ConcurrentAccessExceptionlist_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'
)
ListTopics request.{
'Topics': [
{
'TopicArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Response for ListTopics action.
A list of topic ARNs.
A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes .
The topic's ARN.
Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionopt_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'
)
[REQUIRED]
The phone number to opt in. Use E.164 format.
{}
Response Structure
The response for the OptInPhoneNumber action.
Exceptions
SNS.Client.exceptions.ThrottledExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InvalidParameterExceptionpublish(**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'
)
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 parameter, you must specify a value for the PhoneNumber or TopicArn parameters.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.
[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:
Publish action is 1,600 characters.JSON-specific constraints:
Publish call to return an error (no partial delivery).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 ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
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:
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
Message attributes for Publish action.
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.
Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.
Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
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. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.
If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.
This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) .
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 .
dict
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.InvalidParameterExceptionSNS.Client.exceptions.InvalidParameterValueExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.EndpointDisabledExceptionSNS.Client.exceptions.PlatformApplicationDisabledExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.KMSDisabledExceptionSNS.Client.exceptions.KMSInvalidStateExceptionSNS.Client.exceptions.KMSNotFoundExceptionSNS.Client.exceptions.KMSOptInRequiredSNS.Client.exceptions.KMSThrottlingExceptionSNS.Client.exceptions.KMSAccessDeniedExceptionSNS.Client.exceptions.InvalidSecurityExceptionSNS.Client.exceptions.ValidationExceptionpublish_batch(**kwargs)¶Publishes up to ten messages to the specified topic. This is a batch version of Publish . 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 5 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).
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'
},
]
)
[REQUIRED]
The Amazon resource name (ARN) of the topic you want to batch publish to.
[REQUIRED]
A list of PublishBatch request entries to be sent to the SNS topic.
Contains the details of a single Amazon SNS message along with an Id that identifies a message within the batch.
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 (_).
The body of the message.
The subject of the batch message.
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:
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g. http).
Each message attribute consists of a Name , Type , and Value . For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide.
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.
Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.
Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
This parameter applies only to FIFO (first-in-first-out) topics.
The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered.
MessageDeduplicationId .MessageDeduplicationId explicitly.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).MessageDeduplicationId and the topic doesn't have ContentBasedDeduplication set, the action fails with an error.ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.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 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.
The length of MessageDeduplicationId is 128 characters.
MessageDeduplicationIdcan contain alphanumeric characters(a-z, A-Z, 0-9)and punctuation(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
This parameter applies only to FIFO (first-in-first-out) 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 don't provide a MessageGroupId , the action fails.
The length of MessageGroupId is 128 characters.
MessageGroupIdcan contain alphanumeric characters(a-z, A-Z, 0-9)and punctuation(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
Warning
MessageGroupId is required for FIFO topics. You can't use it for standard topics.
dict
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.InvalidParameterExceptionSNS.Client.exceptions.InvalidParameterValueExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.EndpointDisabledExceptionSNS.Client.exceptions.PlatformApplicationDisabledExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.BatchEntryIdsNotDistinctExceptionSNS.Client.exceptions.BatchRequestTooLongExceptionSNS.Client.exceptions.EmptyBatchRequestExceptionSNS.Client.exceptions.InvalidBatchEntryIdExceptionSNS.Client.exceptions.TooManyEntriesInBatchRequestExceptionSNS.Client.exceptions.KMSDisabledExceptionSNS.Client.exceptions.KMSInvalidStateExceptionSNS.Client.exceptions.KMSNotFoundExceptionSNS.Client.exceptions.KMSOptInRequiredSNS.Client.exceptions.KMSThrottlingExceptionSNS.Client.exceptions.KMSAccessDeniedExceptionSNS.Client.exceptions.InvalidSecurityExceptionSNS.Client.exceptions.ValidationExceptionput_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'
)
[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.
[REQUIRED]
The JSON serialization of the topic's DataProtectionPolicy .
The DataProtectionPolicy must be in JSON string format.
Length Constraints: Maximum length of 30,720.
None
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InvalidSecurityExceptionremove_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'
)
[REQUIRED]
The ARN of the topic whose access control policy you wish to modify.
[REQUIRED]
The unique label of the statement you want to remove.
None
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.NotFoundExceptionset_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'
}
)
[REQUIRED]
EndpointArn used for SetEndpointAttributes action.
[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.None
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.NotFoundExceptionset_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'
}
)
[REQUIRED]
PlatformApplicationArn for SetPlatformApplicationAttributes action.
[REQUIRED]
A map of the platform application attributes. Attributes in this map include the following:
PlatformCredential – The credential received from the notification service.PlatformCredential is client secret.PlatformCredential is private key.PlatformCredential is signing key.PlatformCredential is API key.PlatformPrincipal – The principal received from the notification service.PlatformPrincipal is client id.PlatformPrincipal is SSL certificate.PlatformPrincipal is signing key ID.PlatformPrincipal .EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.The following attributes only apply to APNs token-based authentication:
ApplePlatformTeamID – The identifier that's assigned to your Apple developer account team.ApplePlatformBundleID – The bundle identifier that's assigned to your iOS app.None
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.NotFoundExceptionset_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'
}
)
[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 to0. To write logs for 10% of your successful deliveries, set it to10.
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:
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 .
{}
Response Structure
The response for the SetSMSAttributes action.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.ThrottledExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionset_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'
)
[REQUIRED]
The ARN of the subscription to modify.
[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 Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide .
None
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.FilterPolicyLimitExceededExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.AuthorizationErrorExceptionset_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'
)
[REQUIRED]
The ARN of the topic to modify.
[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.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.The following attribute applies only to FIFO topics:
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.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.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.None
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InvalidSecurityExceptionsubscribe(**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 three 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
)
[REQUIRED]
The ARN of the topic you want to subscribe to.
[REQUIRED]
The protocol that you want to use. Supported protocols include:
http – delivery of JSON-encoded message via HTTP POSThttps – delivery of JSON-encoded message via HTTPS POSTemail – delivery of message via SMTPemail-json – delivery of JSON-encoded message via SMTPsms – delivery of message via SMSsqs – delivery of JSON-encoded message to an Amazon SQS queueapplication – delivery of JSON-encoded message to an EndpointArn for a mobile app and devicelambda – delivery of JSON-encoded message to an Lambda functionfirehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.The endpoint that you want to receive notifications. Endpoints vary by protocol:
http protocol, the (public) endpoint is a URL beginning with http:// .https protocol, the (public) endpoint is a URL beginning with https:// .email protocol, the endpoint is an email address.email-json protocol, the endpoint is an email address.sms protocol, the endpoint is a phone number of an SMS-enabled device.sqs protocol, the endpoint is the ARN of an Amazon SQS queue.application protocol, the endpoint is the EndpointArn of a mobile app and device.lambda protocol, the endpoint is the ARN of an Lambda function.firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the Subscribe action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:MessageAttributes (default) – The filter is applied on the message attributes.MessageBody – The filter is applied on the message body.RawMessageDelivery – When set to true , enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide .
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 .
dict
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.SubscriptionLimitExceededExceptionSNS.Client.exceptions.FilterPolicyLimitExceededExceptionSNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InvalidSecurityExceptiontag_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:
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ARN of the topic to which to add tags.
[REQUIRED]
The tags to be added to the specified topic. A tag consists of a required key and an optional value.
The list of tags to be added to the specified topic.
The required key portion of the tag.
The optional value portion of the tag.
dict
Response Syntax
{}
Response Structure
Exceptions
SNS.Client.exceptions.ResourceNotFoundExceptionSNS.Client.exceptions.TagLimitExceededExceptionSNS.Client.exceptions.StaleTagExceptionSNS.Client.exceptions.TagPolicyExceptionSNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.ConcurrentAccessExceptionunsubscribe(**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.
Note
Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.
This action is throttled at 100 transactions per second (TPS).
See also: AWS API Documentation
Request Syntax
response = client.unsubscribe(
SubscriptionArn='string'
)
[REQUIRED]
The ARN of the subscription to be deleted.
Exceptions
SNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.NotFoundExceptionSNS.Client.exceptions.InvalidSecurityExceptionuntag_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',
]
)
[REQUIRED]
The ARN of the topic from which to remove tags.
[REQUIRED]
The list of tag keys to remove from the specified topic.
dict
Response Syntax
{}
Response Structure
Exceptions
SNS.Client.exceptions.ResourceNotFoundExceptionSNS.Client.exceptions.TagLimitExceededExceptionSNS.Client.exceptions.StaleTagExceptionSNS.Client.exceptions.TagPolicyExceptionSNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.ConcurrentAccessExceptionverify_sms_sandbox_phone_number(**kwargs)¶Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.
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.verify_sms_sandbox_phone_number(
PhoneNumber='string',
OneTimePassword='string'
)
[REQUIRED]
The destination phone number to verify.
[REQUIRED]
The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber call.
dict
Response Syntax
{}
Response Structure
(dict) --
The destination phone number's verification status.
Exceptions
SNS.Client.exceptions.AuthorizationErrorExceptionSNS.Client.exceptions.InternalErrorExceptionSNS.Client.exceptions.InvalidParameterExceptionSNS.Client.exceptions.ResourceNotFoundExceptionSNS.Client.exceptions.VerificationExceptionSNS.Client.exceptions.ThrottledExceptionThe available paginators are:
SNS.Paginator.ListEndpointsByPlatformApplicationSNS.Paginator.ListOriginationNumbersSNS.Paginator.ListPhoneNumbersOptedOutSNS.Paginator.ListPlatformApplicationsSNS.Paginator.ListSMSSandboxPhoneNumbersSNS.Paginator.ListSubscriptionsSNS.Paginator.ListSubscriptionsByTopicSNS.Paginator.ListTopicsSNS.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'
}
)
[REQUIRED]
PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'PhoneNumbers': [
{
'CreatedAt': datetime(2015, 1, 1),
'PhoneNumber': 'string',
'Status': 'string',
'Iso2CountryCode': 'string',
'RouteType': 'Transactional'|'Promotional'|'Premium',
'NumberCapabilities': [
'SMS'|'MMS'|'VOICE',
]
},
]
}
Response Structure
A list of the calling account's verified and pending origination numbers.
A list of phone numbers and their metadata.
The date and time when the phone number was created.
The phone number.
The status of the phone number.
The two-character code for the country or region, in ISO 3166-1 alpha-2 format.
The list of supported routes.
The capabilities of each phone number.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'phoneNumbers': [
'string',
],
'NextToken': 'string'
}
Response Structure
The response from the ListPhoneNumbersOptedOut action.
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.
A token to resume pagination.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'PlatformApplications': [
{
'PlatformApplicationArn': 'string',
'Attributes': {
'string': 'string'
}
},
],
}
Response Structure
Response for ListPlatformApplications action.
Platform applications returned when calling ListPlatformApplications action.
Platform application object.
PlatformApplicationArn for platform application object.
Attributes for platform application object.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'PhoneNumbers': [
{
'PhoneNumber': 'string',
'Status': 'Pending'|'Verified'
},
],
}
Response Structure
A list of the calling account's pending and verified phone numbers.
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 .
The destination phone number.
The destination phone number's verification status.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Subscriptions': [
{
'SubscriptionArn': 'string',
'Owner': 'string',
'Protocol': 'string',
'Endpoint': 'string',
'TopicArn': 'string'
},
],
}
Response Structure
Response for ListSubscriptions action
A list of subscriptions.
A wrapper type for the attributes of an Amazon SNS subscription.
The subscription's ARN.
The subscription's owner.
The subscription's protocol.
The subscription's endpoint (format depends on the protocol).
The ARN of the subscription's topic.
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'
}
)
[REQUIRED]
The ARN of the topic for which you wish to find subscriptions.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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¶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'
}
)
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Topics': [
{
'TopicArn': 'string'
},
],
}
Response Structure
Response for ListTopics action.
A list of topic ARNs.
A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes .
The topic's ARN.
SNS.ServiceResource¶A resource representing Amazon Simple Notification Service (SNS):
import boto3
sns = boto3.resource('sns')
These are the resource's available actions:
These are the resource's available sub-resources:
These are the resource's available collections:
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.
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.
PlatformPrincipalandPlatformCredentialare received from the notification service.
ADM , PlatformPrincipal is client id and PlatformCredential is client secret .Baidu , PlatformPrincipal is API key and PlatformCredential is secret key .APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key .APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key .GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key .MPNS , PlatformPrincipal is TLS certificate and PlatformCredential is private key .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'
}
)
[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.
[REQUIRED]
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).
[REQUIRED]
For a list of attributes, see SetPlatformApplicationAttributes.
sns.PlatformApplication
PlatformApplication resource
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
topic = sns.create_topic(
Name='string',
Attributes={
'string': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DataProtectionPolicy='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.
A map of attributes with their corresponding values.
The following lists the 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.FifoTopic – Set to true to create a FIFO topic.Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.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.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:
FifoTopic – When this is set to true , a FIFO topic is created.ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.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.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.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.
The list of tags to be added to the specified topic.
The required key portion of the tag.
The optional value portion of the tag.
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.
sns.Topic
Topic resource
get_available_subresources()¶Returns a list of all the available sub-resources for this Resource.
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.
PlatformApplication(arn)¶Creates a PlatformApplication resource.:
platform_application = sns.PlatformApplication('arn')
SNS.PlatformApplicationPlatformEndpoint(arn)¶Creates a PlatformEndpoint resource.:
platform_endpoint = sns.PlatformEndpoint('arn')
SNS.PlatformEndpointSubscription(arn)¶Creates a Subscription resource.:
subscription = sns.Subscription('arn')
SNS.SubscriptionTopic(arn)¶Creates a Topic resource.:
topic = sns.Topic('arn')
SNS.TopicCollections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
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()
sns.PlatformApplication)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'
)
sns.PlatformApplication)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
)
sns.PlatformApplication)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
)
sns.PlatformApplication)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 = sns.subscriptions.all()
sns.Subscription)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 = sns.subscriptions.filter(
NextToken='string'
)
ListSubscriptions request.sns.Subscription)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 = sns.subscriptions.limit(
count=123
)
sns.Subscription)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 = sns.subscriptions.page_size(
count=123
)
sns.Subscription)topics¶A collection of Topic resources.A Topic 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 Topic resources in the collection.
See also: AWS API Documentation
Request Syntax
topic_iterator = sns.topics.all()
sns.Topic)filter(**kwargs)Creates an iterable of all Topic resources in the collection filtered by kwargs passed to method. A Topic 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
topic_iterator = sns.topics.filter(
NextToken='string'
)
ListTopics request.sns.Topic)limit(**kwargs)Creates an iterable up to a specified amount of Topic resources in the collection.
See also: AWS API Documentation
Request Syntax
topic_iterator = sns.topics.limit(
count=123
)
sns.Topic)page_size(**kwargs)Creates an iterable of all Topic 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
topic_iterator = sns.topics.page_size(
count=123
)
sns.Topic)SNS.PlatformApplication(arn)¶A resource representing an Amazon Simple Notification Service (SNS) PlatformApplication:
import boto3
sns = boto3.resource('sns')
platform_application = sns.PlatformApplication('arn')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
These are the resource's available collections:
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.
arn¶(string) The PlatformApplication's arn identifier. This must be set.
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.
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.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.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.
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
platform_endpoint = platform_application.create_platform_endpoint(
Token='string',
CustomUserData='string',
Attributes={
'string': '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.
For a list of attributes, see SetEndpointAttributes.
sns.PlatformEndpoint
PlatformEndpoint resource
delete()¶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 = platform_application.delete()
get_available_subresources()¶Returns a list of all the available sub-resources for this Resource.
load()¶Calls SNS.Client.get_platform_application_attributes() to update the attributes of the PlatformApplication 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_application.load()
reload()¶Calls SNS.Client.get_platform_application_attributes() to update the attributes of the PlatformApplication 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_application.reload()
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'
}
)
[REQUIRED]
A map of the platform application attributes. Attributes in this map include the following:
PlatformCredential – The credential received from the notification service.PlatformCredential is client secret.PlatformCredential is private key.PlatformCredential is signing key.PlatformCredential is API key.PlatformPrincipal – The principal received from the notification service.PlatformPrincipal is client id.PlatformPrincipal is SSL certificate.PlatformPrincipal is signing key ID.PlatformPrincipal .EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.The following attributes only apply to APNs token-based authentication:
ApplePlatformTeamID – The identifier that's assigned to your Apple developer account team.ApplePlatformBundleID – The bundle identifier that's assigned to your iOS app.Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
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()
sns.PlatformEndpoint)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'
)
sns.PlatformEndpoint)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
)
sns.PlatformEndpoint)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
)
sns.PlatformEndpoint)SNS.PlatformEndpoint(arn)¶A resource representing an Amazon Simple Notification Service (SNS) PlatformEndpoint:
import boto3
sns = boto3.resource('sns')
platform_endpoint = sns.PlatformEndpoint('arn')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
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.
arn¶(string) The PlatformEndpoint's arn identifier. This must be set.
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.
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.
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.
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()
get_available_subresources()¶Returns a list of all the available sub-resources for this Resource.
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()
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'
)
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.
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.
[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:
Publish action is 1,600 characters.JSON-specific constraints:
Publish call to return an error (no partial delivery).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 ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
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:
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
Message attributes for Publish action.
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.
Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.
Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
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. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.
If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.
This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) .
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 .
dict
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 .
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()
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'
}
)
[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.SNS.Subscription(arn)¶A resource representing an Amazon Simple Notification Service (SNS) Subscription:
import boto3
sns = boto3.resource('sns')
subscription = sns.Subscription('arn')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
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.
arn¶(string) The Subscription's arn identifier. This must be set.
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.
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 Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide .
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.
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.
Note
Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.
This action is throttled at 100 transactions per second (TPS).
See also: AWS API Documentation
Request Syntax
response = subscription.delete()
get_available_subresources()¶Returns a list of all the available sub-resources for this Resource.
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()
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()
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'
)
[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 Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide .
None
SNS.Topic(arn)¶A resource representing an Amazon Simple Notification Service (SNS) Topic:
import boto3
sns = boto3.resource('sns')
topic = sns.Topic('arn')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
add_permission()confirm_subscription()delete()get_available_subresources()load()publish()reload()remove_permission()set_attributes()subscribe()These are the resource's available collections:
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.
arn¶(string) The Topic's arn identifier. This must be set.
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.
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 version of the Amazon SNS signature used for the topic.
SignatureVersion is set to 1 . The signature is a Base64-encoded SHA1withRSA signature.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:
FifoTopic – When this is set to true , a FIFO topic is created.ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.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.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.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.
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',
]
)
[REQUIRED]
A unique identifier for the new policy statement.
[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.
[REQUIRED]
The action you want to allow for the specified principal(s).
Valid values: Any Amazon SNS action name, for example Publish .
None
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'
)
[REQUIRED]
Short-lived token sent to an endpoint during the Subscribe action.
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.sns.Subscription
Subscription resource
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()
get_available_subresources()¶Returns a list of all the available sub-resources for this Resource.
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()
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'
)
TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.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.
[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:
Publish action is 1,600 characters.JSON-specific constraints:
Publish call to return an error (no partial delivery).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 ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
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:
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
Message attributes for Publish action.
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.
Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.
Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
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. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.
If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.
This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) .
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 .
dict
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 .
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()
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'
)
[REQUIRED]
The unique label of the statement you want to remove.
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'
)
[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.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.The following attribute applies only to FIFO topics:
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.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.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.None
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 three 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
)
[REQUIRED]
The protocol that you want to use. Supported protocols include:
http – delivery of JSON-encoded message via HTTP POSThttps – delivery of JSON-encoded message via HTTPS POSTemail – delivery of message via SMTPemail-json – delivery of JSON-encoded message via SMTPsms – delivery of message via SMSsqs – delivery of JSON-encoded message to an Amazon SQS queueapplication – delivery of JSON-encoded message to an EndpointArn for a mobile app and devicelambda – delivery of JSON-encoded message to an Lambda functionfirehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.The endpoint that you want to receive notifications. Endpoints vary by protocol:
http protocol, the (public) endpoint is a URL beginning with http:// .https protocol, the (public) endpoint is a URL beginning with https:// .email protocol, the endpoint is an email address.email-json protocol, the endpoint is an email address.sms protocol, the endpoint is a phone number of an SMS-enabled device.sqs protocol, the endpoint is the ARN of an Amazon SQS queue.application protocol, the endpoint is the EndpointArn of a mobile app and device.lambda protocol, the endpoint is the ARN of an Lambda function.firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the Subscribe action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:MessageAttributes (default) – The filter is applied on the message attributes.MessageBody – The filter is applied on the message body.RawMessageDelivery – When set to true , enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn – The ARN of the IAM role that has the following:Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide .
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 .
sns.Subscription
Subscription resource
Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
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()
sns.Subscription)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'
)
ListSubscriptionsByTopic request.sns.Subscription)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
)
sns.Subscription)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
)
sns.Subscription)