ListSubscriptions
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).
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- NextToken
-
Token returned by the previous
ListSubscriptions
request.Type: String
Required: No
Response Elements
The following elements are returned by the service.
- NextToken
-
Token to pass along to the next
ListSubscriptions
request. This element is returned if there are more subscriptions to retrieve.Type: String
- Subscriptions.member.N
-
A list of subscriptions.
Type: Array of Subscription objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AuthorizationError
-
Indicates that the user has been denied access to the requested resource.
HTTP Status Code: 403
- InternalError
-
Indicates an internal service error.
HTTP Status Code: 500
- InvalidParameter
-
Indicates that a request parameter does not comply with the associated constraints.
HTTP Status Code: 400
Examples
The structure of AUTHPARAMS
depends on the signature of the API request.
For more information, see Examples
of the complete Signature Version 4 signing process (Python) in the
AWS General Reference.
Example
This example illustrates one usage of ListSubscriptions.
Sample Request
https://sns.us-east-2.amazonaws.com/?Action=ListSubscriptions
&Version=2010-03-31
&AUTHPARAMS
Sample Response
<ListSubscriptionsResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
<ListSubscriptionsResult>
<Subscriptions>
<member>
<TopicArn>arn:aws:sns:us-east-2:698519295917:My-Topic</TopicArn>
<Protocol>email</Protocol>
<SubscriptionArn>arn:aws:sns:us-east-2:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca</SubscriptionArn>
<Owner>123456789012</Owner>
<Endpoint>example@amazon.com</Endpoint>
</member>
</Subscriptions>
</ListSubscriptionsResult>
<ResponseMetadata>
<RequestId>384ac68d-3775-11df-8963-01868b7c937a</RequestId>
</ResponseMetadata>
</ListSubscriptionsResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: