Table of Contents
A low-level client representing Amazon Simple Notification Service (SNS):
import boto3
client = boto3.client('sns')
These are the available methods:
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
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 AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, 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
Check if an operation can be paginated.
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your 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:
Exceptions
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.
dict
Response Syntax
{
'SubscriptionArn': 'string'
}
Response Structure
(dict) --
Response for ConfirmSubscriptions action.
SubscriptionArn (string) --
The ARN of the created subscription.
Exceptions
Creates a platform application object for one of the supported push notification services, such as APNS and FCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For FCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".
For APNS/APNS_SANDBOX, PlatformCredential is "private key". For FCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used 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 FCM (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
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as FCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication . The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action 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 FCM 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
Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see https://aws.amazon.com/sns . 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'
},
]
)
[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.
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:
The following attribute applies only to server-side-encryption :
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.
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
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
Deletes a platform application object for one of the supported push notification services, such as APNS and FCM. 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
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
Generate a presigned url given a client, its method, and arguments
The presigned url
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as FCM 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:
Note
The device token for the iOS platform is returned in lowercase.
Exceptions
Create a paginator for an operation.
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and FCM. 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:
Exceptions
Returns the settings for sending SMS messages from your 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
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:
Exceptions
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:
The following attribute applies only to server-side-encryption :
Exceptions
Returns an object that can wait for some condition.
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as FCM 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) --
Endpoint for mobile app and device.
EndpointArn (string) --
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
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'
)
{
'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
Lists the platform application objects for the supported push notification services, such as APNS and FCM. 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
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'
)
{
'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
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.
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
List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[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
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'
)
{
'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
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.
{}
Response Structure
The response for the OptInPhoneNumber action.
Exceptions
Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number.
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 has been saved and Amazon SNS will attempt to deliver it shortly.
To use the Publish action for sending 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 .
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'
}
}
)
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:
JSON-specific constraints:
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 Using Amazon SNS Message Attributes .
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.
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
Response for Publish action.
MessageId (string) --
Unique identifier assigned to the published message.
Length Constraint: Maximum 100 characters
Exceptions
Removes a statement from a topic's access control 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
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as FCM 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:
None
Exceptions
Sets the attributes of the platform application object for the supported push notification services, such as APNS and FCM. 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:
None
Exceptions
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 Sending an SMS Message in the Amazon SNS Developer Guide .
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 account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Warning
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case . For New limit value , enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0 . To write logs for 10% of your successful deliveries, set it to 10 .
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
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 account:
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle 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
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 the SetTopicAttributes action uses:
None
Exceptions
Allows a topic owner to set an attribute of the topic to a new value.
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:
The following attribute applies only to server-side-encryption :
None
Exceptions
Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. 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 you want to use. Supported protocols include:
The endpoint that you want to receive notifications. Endpoints vary by protocol:
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:
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 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
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
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 AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.
This action is throttled at 100 transactions per second (TPS).
See also: AWS API Documentation
Request Syntax
response = client.unsubscribe(
SubscriptionArn='string'
)
[REQUIRED]
The ARN of the subscription to be deleted.
Exceptions
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
The available paginators are:
paginator = client.get_paginator('list_endpoints_by_platform_application')
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) --
Endpoint for mobile app and device.
EndpointArn (string) --
EndpointArn for mobile app and device.
Attributes (dict) --
Attributes for endpoint.
paginator = client.get_paginator('list_phone_numbers_opted_out')
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.
paginator = client.get_paginator('list_platform_applications')
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.
paginator = client.get_paginator('list_subscriptions')
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.
paginator = client.get_paginator('list_subscriptions_by_topic')
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.
paginator = client.get_paginator('list_topics')
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.
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.
Creates a platform application object for one of the supported push notification services, such as APNS and FCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For FCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".
For APNS/APNS_SANDBOX, PlatformCredential is "private key". For FCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used 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 FCM (Firebase Cloud Messaging).
[REQUIRED]
For a list of attributes, see SetPlatformApplicationAttributes
sns.PlatformApplication
PlatformApplication resource
Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see https://aws.amazon.com/sns . 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'
},
]
)
[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.
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:
The following attribute applies only to server-side-encryption :
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.
sns.Topic
Topic resource
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.
Creates a PlatformApplication resource.:
platform_application = sns.PlatformApplication('arn')
Creates a PlatformEndpoint resource.:
platform_endpoint = sns.PlatformEndpoint('arn')
Creates a Subscription resource.:
subscription = sns.Subscription('arn')
Creates a Topic resource.:
topic = sns.Topic('arn')
Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
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.
Creates an iterable of all PlatformApplication resources in the collection.
See also: AWS API Documentation
Request Syntax
platform_application_iterator = sns.platform_applications.all()
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'
)
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
)
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
)
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.
Creates an iterable of all Subscription resources in the collection.
See also: AWS API Documentation
Request Syntax
subscription_iterator = sns.subscriptions.all()
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'
)
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
)
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
)
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.
Creates an iterable of all Topic resources in the collection.
See also: AWS API Documentation
Request Syntax
topic_iterator = sns.topics.all()
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'
)
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
)
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
)
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 instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(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.
(dict) --
Attributes include the following:
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.
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as FCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication . The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action 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 FCM or ADM, the device token equivalent is called the registration ID.
For a list of attributes, see SetEndpointAttributes .
sns.PlatformEndpoint
PlatformEndpoint resource
Deletes a platform application object for one of the supported push notification services, such as APNS and FCM. For more information, see Using Amazon SNS Mobile Push Notifications .
See also: AWS API Documentation
Request Syntax
response = platform_application.delete()
Returns a list of all the available sub-resources for this Resource.
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()
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()
Sets the attributes of the platform application object for the supported push notification services, such as APNS and FCM. 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:
Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
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.
Creates an iterable of all PlatformEndpoint resources in the collection.
See also: AWS API Documentation
Request Syntax
platform_endpoint_iterator = platform_application.endpoints.all()
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'
)
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
)
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
)
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 instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(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.
(dict) --
Attributes include the following:
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.
Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications .
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
See also: AWS API Documentation
Request Syntax
response = platform_endpoint.delete()
Returns a list of all the available sub-resources for this Resource.
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()
Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number.
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 has been saved and Amazon SNS will attempt to deliver it shortly.
To use the Publish action for sending 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 .
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'
}
}
)
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:
JSON-specific constraints:
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 Using Amazon SNS Message Attributes .
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.
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
Response for Publish action.
MessageId (string) --
Unique identifier assigned to the published message.
Length Constraint: Maximum 100 characters
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()
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as FCM 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:
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 instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(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.
(dict) --
A map of the subscription's attributes. Attributes in this map include the following:
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.
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 AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.
This action is throttled at 100 transactions per second (TPS).
See also: AWS API Documentation
Request Syntax
response = subscription.delete()
Returns a list of all the available sub-resources for this Resource.
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()
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()
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 the SetTopicAttributes action uses:
None
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:
These are the resource's available collections:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(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.
(dict) --
A map of the topic's attributes. Attributes in this map include the following:
The following attribute applies only to server-side-encryption :
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.
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
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 AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, 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
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.
sns.Subscription
Subscription resource
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
See also: AWS API Documentation
Request Syntax
response = topic.delete()
Returns a list of all the available sub-resources for this Resource.
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()
Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number.
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 has been saved and Amazon SNS will attempt to deliver it shortly.
To use the Publish action for sending 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 .
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'
}
}
)
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:
JSON-specific constraints:
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 Using Amazon SNS Message Attributes .
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.
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
Response for Publish action.
MessageId (string) --
Unique identifier assigned to the published message.
Length Constraint: Maximum 100 characters
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()
Removes a statement from a topic's access control 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.
Allows a topic owner to set an attribute of the topic to a new value.
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:
The following attribute applies only to server-side-encryption :
None
Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. 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 you want to use. Supported protocols include:
The endpoint that you want to receive notifications. Endpoints vary by protocol:
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:
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 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.
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.
Creates an iterable of all Subscription resources in the collection.
See also: AWS API Documentation
Request Syntax
subscription_iterator = topic.subscriptions.all()
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'
)
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
)
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
)