2014/10/16 - Amazon Simple Notification Service - 25 new api methods
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".
Request Syntax
client.confirm_subscription(
TopicArn='string',
Token='string',
AuthenticateOnUnsubscribe='string'
)
string
[REQUIRED]
The ARN of the topic for which you wish to confirm a subscription.
string
[REQUIRED]
Short-lived token sent to an endpoint during the Subscribe action.
string
Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
dict
Response Syntax
{
'SubscriptionArn': 'string'
}
Response Structure
(dict) -- Response for ConfirmSubscriptions action.
SubscriptionArn (string) --
The ARN of the created subscription.
Returns all of the properties of a subscription.
Request Syntax
client.get_subscription_attributes(
SubscriptionArn='string'
)
string
[REQUIRED]
The ARN of the subscription whose properties you want to get.
dict
Response Syntax
{
'Attributes': {
'string': 'string'
}
}
Response Structure
(dict) --
Response for GetSubscriptionAttributes action.
Attributes (dict) --
A map of the subscription's attributes. Attributes in this map include the following:
SubscriptionArn -- the subscription's ARN
TopicArn -- the topic ARN that the subscription is associated with
Owner -- the AWS account ID of the subscription's owner
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
(string) --
(string) --
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.
<http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqssubscribe.html>`__
Request Syntax
client.subscribe(
TopicArn='string',
Protocol='string',
Endpoint='string'
)
string
[REQUIRED]
The ARN of the topic you want to subscribe to.
string
[REQUIRED]
The protocol you want to use. Supported protocols include:
http -- delivery of JSON-encoded message via HTTP POST
https -- delivery of JSON-encoded message via HTTPS POST
email -- delivery of message via SMTP
email-json -- delivery of JSON-encoded message via SMTP
sms -- delivery of message via SMS
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
string
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http protocol, the endpoint is an URL beginning with "http://"
For the https protocol, the endpoint is a URL beginning with "https://"
For the email protocol, the endpoint is an email address
For the email-json protocol, the endpoint is an email address
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
dict
Response Syntax
{
'SubscriptionArn': 'string'
}
Response Structure
(dict) -- Response for Subscribe action.
SubscriptionArn (string) --
The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM 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.
Request Syntax
client.list_endpoints_by_platform_application(
PlatformApplicationArn='string',
NextToken='string'
)
string
[REQUIRED]
PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
string
NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.
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.
(string) --
(string) --
NextToken (string) --
NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
Request Syntax
client.get_platform_application_attributes(
PlatformApplicationArn='string'
)
string
[REQUIRED]
PlatformApplicationArn for GetPlatformApplicationAttributesInput.
dict
Response Syntax
{
'Attributes': {
'string': 'string'
}
}
Response Structure
(dict) --
Response for GetPlatformApplicationAttributes action.
Attributes (dict) --
Attributes include the following:
EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.
EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.
EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.
EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
(string) --
(string) --
Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.
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. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. The second example below shows a request and response for publishing to a mobile endpoint.
Request Syntax
client.publish(
TopicArn='string',
TargetArn='string',
Message='string',
Subject='string',
MessageStructure='string',
MessageAttributes={
'string': {
'DataType': 'string',
'StringValue': 'string',
'BinaryValue': b'bytes'
}
}
)
string
The topic you want to publish to.
string
Either TopicArn or EndpointArn, but not both.
string
[REQUIRED]
The message you want to send to the topic.
If 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. See the Examples section for the format of the JSON object.
Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
string
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be 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.
string
Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json , the value of the Message parameter must:
be a syntactically valid JSON object; and
contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide .
Valid value: json
dict
Message attributes for Publish action.
(string) --
(dict) --
The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish.
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Using Amazon SNS Message Attributes.
DataType (string) -- [REQUIRED]
Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
StringValue (string) --
Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
BinaryValue (bytes) --
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
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
Request Syntax
client.set_endpoint_attributes(
EndpointArn='string',
Attributes={
'string': 'string'
}
)
string
[REQUIRED]
EndpointArn used for SetEndpointAttributes action.
dict
[REQUIRED]
A map of the endpoint attributes. Attributes in this map include the following:
CustomUserData -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
Enabled -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
(string) --
(string) --
None
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
Request Syntax
client.set_platform_application_attributes(
PlatformApplicationArn='string',
Attributes={
'string': 'string'
}
)
string
[REQUIRED]
PlatformApplicationArn for SetPlatformApplicationAttributes action.
dict
[REQUIRED]
A map of the platform application attributes. Attributes in this map include the following:
PlatformCredential -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret".
PlatformPrincipal -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id".
EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.
EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.
EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.
EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
(string) --
(string) --
None
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM 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.
Request Syntax
client.create_platform_endpoint(
PlatformApplicationArn='string',
Token='string',
CustomUserData='string',
Attributes={
'string': 'string'
}
)
string
[REQUIRED]
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
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 or ADM, the device token equivalent is called the registration ID.
string
Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
dict
For a list of attributes, see SetEndpointAttributes.
(string) --
(string) --
dict
Response Syntax
{
'EndpointArn': 'string'
}
Response Structure
(dict) --
Response from CreateEndpoint action.
EndpointArn (string) --
EndpointArn returned from CreateEndpoint action.
Creates a platform application object for one of the supported push notification services, such as APNS and GCM, 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 GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications.
Request Syntax
client.create_platform_application(
Name='string',
Platform='string',
Attributes={
'string': '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.
string
[REQUIRED]
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
dict
[REQUIRED]
For a list of attributes, see SetPlatformApplicationAttributes
(string) --
(string) --
dict
Response Syntax
{
'PlatformApplicationArn': 'string'
}
Response Structure
(dict) --
Response from CreatePlatformApplication action.
PlatformApplicationArn (string) --
PlatformApplicationArn is returned.
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
Request Syntax
client.get_topic_attributes(
TopicArn='string'
)
string
[REQUIRED]
The ARN of the topic whose properties you want to get.
dict
Response Syntax
{
'Attributes': {
'string': 'string'
}
}
Response Structure
(dict) --
Response for GetTopicAttributes action.
Attributes (dict) --
A map of the topic's attributes. Attributes in this map include the following:
TopicArn -- the topic's ARN
Owner -- the AWS account ID of the topic's owner
Policy -- the JSON serialization of the topic's access control policy
DisplayName -- the human-readable name used in the "From" field for notifications to email and email-json endpoints
SubscriptionsPending -- the number of subscriptions pending confirmation on this topic
SubscriptionsConfirmed -- the number of confirmed subscriptions on this topic
SubscriptionsDeleted -- the number of deleted subscriptions on this topic
DeliveryPolicy -- the JSON serialization of the topic's delivery policy
EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account system defaults
(string) --
(string) --
Allows a subscription owner to set an attribute of the topic to a new value.
Request Syntax
client.set_subscription_attributes(
SubscriptionArn='string',
AttributeName='string',
AttributeValue='string'
)
string
[REQUIRED]
The ARN of the subscription to modify.
string
[REQUIRED]
The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
string
The new value for the attribute in JSON format.
None
Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see http://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.
Request Syntax
client.create_topic(
Name='string'
)
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.
dict
Response Syntax
{
'TopicArn': 'string'
}
Response Structure
(dict) --
Response from CreateTopic action.
TopicArn (string) --
The Amazon Resource Name (ARN) assigned to the created topic.
Allows a topic owner to set an attribute of the topic to a new value.
Request Syntax
client.set_topic_attributes(
TopicArn='string',
AttributeName='string',
AttributeValue='string'
)
string
[REQUIRED]
The ARN of the topic to modify.
string
[REQUIRED]
The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
string
The new value for the attribute.
None
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.
Request Syntax
client.delete_topic(
TopicArn='string'
)
string
[REQUIRED]
The ARN of the topic you want to delete.
None
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
Request Syntax
client.delete_platform_application(
PlatformApplicationArn='string'
)
string
[REQUIRED]
PlatformApplicationArn of platform application object to delete.
None
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.
Request Syntax
client.list_subscriptions(
NextToken='string'
)
string
Token returned by the previous ListSubscriptions request.
dict
Response Syntax
{
'Subscriptions': [
{
'SubscriptionArn': 'string',
'Owner': 'string',
'Protocol': 'string',
'Endpoint': 'string',
'TopicArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Response for ListSubscriptions action
Subscriptions (list) --
A list of subscriptions.
(dict) --
A wrapper type for the attributes of an Amazon SNS subscription.
SubscriptionArn (string) --
The subscription's ARN.
Owner (string) --
The subscription's owner.
Protocol (string) --
The subscription's protocol.
Endpoint (string) --
The subscription's endpoint (format depends on the protocol).
TopicArn (string) --
The ARN of the subscription's topic.
NextToken (string) --
Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.
Lists the platform application objects for the supported push notification services, such as APNS and GCM. 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.
Request Syntax
client.list_platform_applications(
NextToken='string'
)
string
NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.
dict
Response Syntax
{
'PlatformApplications': [
{
'PlatformApplicationArn': 'string',
'Attributes': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Response for ListPlatformApplications action.
PlatformApplications (list) --
Platform applications returned when calling ListPlatformApplications action.
(dict) --
Platform application object.
PlatformApplicationArn (string) --
PlatformApplicationArn for platform application object.
Attributes (dict) --
Attributes for platform application object.
(string) --
(string) --
NextToken (string) --
NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.
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.
Request Syntax
client.list_topics(
NextToken='string'
)
string
Token returned by the previous ListTopics request.
dict
Response Syntax
{
'Topics': [
{
'TopicArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Response for ListTopics action.
Topics (list) --
A list of topic ARNs.
(dict) --
A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes .
TopicArn (string) --
The topic's ARN.
NextToken (string) --
Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
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.
Request Syntax
client.unsubscribe(
SubscriptionArn='string'
)
string
[REQUIRED]
The ARN of the subscription to be deleted.
None
Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
Request Syntax
client.delete_endpoint(
EndpointArn='string'
)
string
[REQUIRED]
EndpointArn of endpoint to delete.
None
Removes a statement from a topic's access control policy.
Request Syntax
client.remove_permission(
TopicArn='string',
Label='string'
)
string
[REQUIRED]
The ARN of the topic whose access control policy you wish to modify.
string
[REQUIRED]
The unique label of the statement you want to remove.
None
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
Request Syntax
client.add_permission(
TopicArn='string',
Label='string',
AWSAccountId=[
'string',
],
ActionName=[
'string',
]
)
string
[REQUIRED]
The ARN of the topic whose access control policy you wish to modify.
string
[REQUIRED]
A unique identifier for the new policy statement.
list
[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.
(string) --
list
[REQUIRED]
The action you want to allow for the specified principal(s).
Valid values: any Amazon SNS action name.
(string) --
None
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
Request Syntax
client.get_endpoint_attributes(
EndpointArn='string'
)
string
[REQUIRED]
EndpointArn for GetEndpointAttributes input.
dict
Response Syntax
{
'Attributes': {
'string': 'string'
}
}
Response Structure
(dict) --
Response from GetEndpointAttributes of the EndpointArn.
Attributes (dict) --
Attributes include the following:
CustomUserData -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
Enabled -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
(string) --
(string) --
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.
Request Syntax
client.list_subscriptions_by_topic(
TopicArn='string',
NextToken='string'
)
string
[REQUIRED]
The ARN of the topic for which you wish to find subscriptions.
string
Token returned by the previous 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.