subscriptions_by_topics
Creates, updates, deletes, gets or lists a subscriptions_by_topics resource.
Overview
| Name | subscriptions_by_topics |
| Type | Resource |
| Id | aws.sns.subscriptions_by_topics |
Fields
The following fields are returned by SELECT queries:
- list_subscriptions_by_topic
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The subscription's endpoint (format depends on the protocol). |
owner | string | The subscription's owner. |
protocol | string | The subscription's protocol. |
subscription_arn | string | The subscription's ARN. |
topic_arn | string | The ARN of the subscription's topic. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_subscriptions_by_topic | select | TopicArn, region | NextToken | 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). |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
TopicArn | string | The ARN of the topic for which you wish to find subscriptions. |
region | string | AWS region (default: us-east-1) |
NextToken | string | Token returned by the previous ListSubscriptionsByTopic request. |
SELECT examples
- list_subscriptions_by_topic
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).
SELECT
endpoint,
owner,
protocol,
subscription_arn,
topic_arn
FROM aws.sns.subscriptions_by_topics
WHERE TopicArn = '{{ TopicArn }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
;