Skip to main content

subscriptions_by_topics

Creates, updates, deletes, gets or lists a subscriptions_by_topics resource.

Overview

Namesubscriptions_by_topics
TypeResource
Idaws.sns.subscriptions_by_topics

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
endpointstringThe subscription's endpoint (format depends on the protocol).
ownerstringThe subscription's owner.
protocolstringThe subscription's protocol.
subscription_arnstringThe subscription's ARN.
topic_arnstringThe ARN of the subscription's topic.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_subscriptions_by_topicselectTopicArn, regionNextTokenReturns 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.

NameDatatypeDescription
TopicArnstringThe ARN of the topic for which you wish to find subscriptions.
regionstringAWS region (default: us-east-1)
NextTokenstringToken returned by the previous ListSubscriptionsByTopic request.

SELECT examples

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 }}'
;