Table of Contents
SNS.Client¶A low-level client representing Amazon Simple Notification Service (SNS):
client = session.create_client('sns')
These are the available methods:
add_permission()can_paginate()check_if_phone_number_is_opted_out()confirm_subscription()create_platform_application()create_platform_endpoint()create_topic()delete_endpoint()delete_platform_application()delete_topic()generate_presigned_url()get_endpoint_attributes()get_paginator()get_platform_application_attributes()get_sms_attributes()get_subscription_attributes()get_topic_attributes()get_waiter()list_endpoints_by_platform_application()list_phone_numbers_opted_out()list_platform_applications()list_subscriptions()list_subscriptions_by_topic()list_topics()opt_in_phone_number()publish()remove_permission()set_endpoint_attributes()set_platform_application_attributes()set_sms_attributes()set_subscription_attributes()set_topic_attributes()subscribe()unsubscribe()add_permission(**kwargs)¶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',
]
)
| Parameters: |
|
|---|---|
| Returns: | None |
can_paginate(operation_name)¶Check if an operation can be paginated.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you’d normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo"). |
|---|---|
| Returns: | True if the operation can be paginated,
False otherwise. |
check_if_phone_number_is_opted_out(**kwargs)¶Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.
See also: AWS API Documentation
Request Syntax
response = client.check_if_phone_number_is_opted_out(
phoneNumber='string'
)
| Parameters: | phoneNumber (string) – [REQUIRED] The phone number for which you want to check the opt out status. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'isOptedOut': True|False
}
Response Structure
|
confirm_subscription(**kwargs)¶Verifies an endpoint owner’s intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to “true”.
See also: AWS API Documentation
Request Syntax
response = client.confirm_subscription(
TopicArn='string',
Token='string',
AuthenticateOnUnsubscribe='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'SubscriptionArn': 'string'
}
Response Structure
|
create_platform_application(**kwargs)¶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 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 GCM, 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. For more information, see Using Amazon SNS Mobile Push Notifications . For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service , Getting Started with Amazon Device Messaging , Getting Started with Baidu Cloud Push , Getting Started with Google Cloud Messaging for Android , Getting Started with MPNS , or Getting Started with WNS .
See also: AWS API Documentation
Request Syntax
response = client.create_platform_application(
Name='string',
Platform='string',
Attributes={
'string': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'PlatformApplicationArn': 'string'
}
Response Structure
|
create_platform_endpoint(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.create_platform_endpoint(
PlatformApplicationArn='string',
Token='string',
CustomUserData='string',
Attributes={
'string': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'EndpointArn': 'string'
}
Response Structure
|
create_topic(**kwargs)¶Creates a topic to which notifications can be published. Users can create at most 100,000 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.
See also: AWS API Documentation
Request Syntax
response = client.create_topic(
Name='string'
)
| Parameters: | Name (string) – [REQUIRED] The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'TopicArn': 'string'
}
Response Structure
|
delete_endpoint(**kwargs)¶Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications .
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
See also: AWS API Documentation
Request Syntax
response = client.delete_endpoint(
EndpointArn='string'
)
| Parameters: | EndpointArn (string) – [REQUIRED] EndpointArn of endpoint to delete. |
|---|---|
| Returns: | None |
delete_platform_application(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.delete_platform_application(
PlatformApplicationArn='string'
)
| Parameters: | PlatformApplicationArn (string) – [REQUIRED] PlatformApplicationArn of platform application object to delete. |
|---|---|
| Returns: | None |
delete_topic(**kwargs)¶Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
See also: AWS API Documentation
Request Syntax
response = client.delete_topic(
TopicArn='string'
)
| Parameters: | TopicArn (string) – [REQUIRED] The ARN of the topic you want to delete. |
|---|---|
| Returns: | None |
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
| Parameters: |
|
|---|---|
| Returns: | The presigned url |
get_endpoint_attributes(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.get_endpoint_attributes(
EndpointArn='string'
)
| Parameters: | EndpointArn (string) – [REQUIRED] EndpointArn for GetEndpointAttributes input. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'Attributes': {
'string': 'string'
}
}
Response Structure
|
get_paginator(operation_name)¶Create a paginator for an operation.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you’d normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo"). |
|---|---|
| Raises: | OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable. |
| Return type: | L{botocore.paginate.Paginator} |
| Returns: | A paginator object. |
get_platform_application_attributes(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.get_platform_application_attributes(
PlatformApplicationArn='string'
)
| Parameters: | PlatformApplicationArn (string) – [REQUIRED] PlatformApplicationArn for GetPlatformApplicationAttributesInput. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'Attributes': {
'string': 'string'
}
}
Response Structure
|
get_sms_attributes(**kwargs)¶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',
]
)
| Parameters: | attributes (list) – A list of the individual attribute names, such as For all attribute names, see SetSMSAttributes . If you don’t use this parameter, Amazon SNS returns all SMS attributes.
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'attributes': {
'string': 'string'
}
}
Response Structure
|
get_subscription_attributes(**kwargs)¶Returns all of the properties of a subscription.
See also: AWS API Documentation
Request Syntax
response = client.get_subscription_attributes(
SubscriptionArn='string'
)
| Parameters: | SubscriptionArn (string) – [REQUIRED] The ARN of the subscription whose properties you want to get. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'Attributes': {
'string': 'string'
}
}
Response Structure
|
get_topic_attributes(**kwargs)¶Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
See also: AWS API Documentation
Request Syntax
response = client.get_topic_attributes(
TopicArn='string'
)
| Parameters: | TopicArn (string) – [REQUIRED] The ARN of the topic whose properties you want to get. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'Attributes': {
'string': 'string'
}
}
Response Structure
|
get_waiter(waiter_name)¶list_endpoints_by_platform_application(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.list_endpoints_by_platform_application(
PlatformApplicationArn='string',
NextToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Endpoints': [
{
'EndpointArn': 'string',
'Attributes': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
|
list_phone_numbers_opted_out(**kwargs)¶Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.
See also: AWS API Documentation
Request Syntax
response = client.list_phone_numbers_opted_out(
nextToken='string'
)
| Parameters: | nextToken (string) – A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'phoneNumbers': [
'string',
],
'nextToken': 'string'
}
Response Structure
|
list_platform_applications(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.list_platform_applications(
NextToken='string'
)
| Parameters: | NextToken (string) – NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'PlatformApplications': [
{
'PlatformApplicationArn': 'string',
'Attributes': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
|
list_subscriptions(**kwargs)¶Returns a list of the requester’s subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.
See also: AWS API Documentation
Request Syntax
response = client.list_subscriptions(
NextToken='string'
)
| Parameters: | NextToken (string) – Token returned by the previous ListSubscriptions request. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'Subscriptions': [
{
'SubscriptionArn': 'string',
'Owner': 'string',
'Protocol': 'string',
'Endpoint': 'string',
'TopicArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
list_subscriptions_by_topic(**kwargs)¶Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.
See also: AWS API Documentation
Request Syntax
response = client.list_subscriptions_by_topic(
TopicArn='string',
NextToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Subscriptions': [
{
'SubscriptionArn': 'string',
'Owner': 'string',
'Protocol': 'string',
'Endpoint': 'string',
'TopicArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
list_topics(**kwargs)¶Returns a list of the requester’s topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.
See also: AWS API Documentation
Request Syntax
response = client.list_topics(
NextToken='string'
)
| Parameters: | NextToken (string) – Token returned by the previous ListTopics request. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'Topics': [
{
'TopicArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
opt_in_phone_number(**kwargs)¶Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
See also: AWS API Documentation
Request Syntax
response = client.opt_in_phone_number(
phoneNumber='string'
)
| Parameters: | phoneNumber (string) – [REQUIRED] The phone number to opt in. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{}
Response Structure
|
publish(**kwargs)¶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.
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'
}
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'MessageId': 'string'
}
Response Structure
|
remove_permission(**kwargs)¶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'
)
| Parameters: |
|
|---|---|
| Returns: | None |
set_endpoint_attributes(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.set_endpoint_attributes(
EndpointArn='string',
Attributes={
'string': 'string'
}
)
| Parameters: |
|
|---|---|
| Returns: | None |
set_platform_application_attributes(**kwargs)¶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 . For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status .
See also: AWS API Documentation
Request Syntax
response = client.set_platform_application_attributes(
PlatformApplicationArn='string',
Attributes={
'string': 'string'
}
)
| Parameters: |
|
|---|---|
| Returns: | None |
set_sms_attributes(**kwargs)¶Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see 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'
}
)
| Parameters: | attributes (dict) – [REQUIRED] The default settings for sending SMS messages from your account. You can set values for the following attribute names:
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 exceed the maximum, contact AWS Support or your AWS sales representative for a service limit increase.
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide .
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{}
Response Structure
|
set_subscription_attributes(**kwargs)¶Allows a subscription owner to set an attribute of the topic to a new value.
See also: AWS API Documentation
Request Syntax
response = client.set_subscription_attributes(
SubscriptionArn='string',
AttributeName='string',
AttributeValue='string'
)
| Parameters: |
|
|---|---|
| Returns: | None |
set_topic_attributes(**kwargs)¶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'
)
| Parameters: |
|
|---|---|
| Returns: | None |
subscribe(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.subscribe(
TopicArn='string',
Protocol='string',
Endpoint='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'SubscriptionArn': 'string'
}
Response Structure
|
unsubscribe(**kwargs)¶Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic’s owner can unsubscribe, and an 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.
See also: AWS API Documentation
Request Syntax
response = client.unsubscribe(
SubscriptionArn='string'
)
| Parameters: | SubscriptionArn (string) – [REQUIRED] The ARN of the subscription to be deleted. |
|---|---|
| Returns: | None |
The available paginators are:
SNS.Paginator.ListEndpointsByPlatformApplicationSNS.Paginator.ListPlatformApplicationsSNS.Paginator.ListSubscriptionsSNS.Paginator.ListSubscriptionsByTopicSNS.Paginator.ListTopicsSNS.Paginator.ListEndpointsByPlatformApplication¶paginator = client.get_paginator('list_endpoints_by_platform_application')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SNS.Client.list_endpoints_by_platform_application().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PlatformApplicationArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Endpoints': [
{
'EndpointArn': 'string',
'Attributes': {
'string': 'string'
}
},
],
}
Response Structure
|
SNS.Paginator.ListPlatformApplications¶paginator = client.get_paginator('list_platform_applications')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SNS.Client.list_platform_applications().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: | PaginationConfig (dict) – A dictionary that provides parameters to control pagination.
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'PlatformApplications': [
{
'PlatformApplicationArn': 'string',
'Attributes': {
'string': 'string'
}
},
],
}
Response Structure
|
SNS.Paginator.ListSubscriptions¶paginator = client.get_paginator('list_subscriptions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SNS.Client.list_subscriptions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: | PaginationConfig (dict) – A dictionary that provides parameters to control pagination.
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'Subscriptions': [
{
'SubscriptionArn': 'string',
'Owner': 'string',
'Protocol': 'string',
'Endpoint': 'string',
'TopicArn': 'string'
},
],
}
Response Structure
|
SNS.Paginator.ListSubscriptionsByTopic¶paginator = client.get_paginator('list_subscriptions_by_topic')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SNS.Client.list_subscriptions_by_topic().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TopicArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Subscriptions': [
{
'SubscriptionArn': 'string',
'Owner': 'string',
'Protocol': 'string',
'Endpoint': 'string',
'TopicArn': 'string'
},
],
}
Response Structure
|
SNS.Paginator.ListTopics¶paginator = client.get_paginator('list_topics')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SNS.Client.list_topics().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: | PaginationConfig (dict) – A dictionary that provides parameters to control pagination.
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'Topics': [
{
'TopicArn': 'string'
},
],
}
Response Structure
|