ServiceResource / Collection / subscriptions

subscriptions¶

SNS.ServiceResource.subscriptions¶

A collection of Subscription resources.A Subscription Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()¶

Creates an iterable of all Subscription resources in the collection.

See also: AWS API Documentation

Request Syntax

subscription_iterator = sns.subscriptions.all()

Return type:: list(sns.Subscription)
Returns:: A list of Subscription resources

filter(**kwargs)¶

Creates an iterable of all Subscription resources in the collection filtered by kwargs passed to method. A Subscription collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

subscription_iterator = sns.subscriptions.filter(
    NextToken='string'
)

Parameters:: NextToken (string) – Token returned by the previous ListSubscriptions request.
Return type:: list(sns.Subscription)
Returns:: A list of Subscription resources

limit(**kwargs)¶

Creates an iterable up to a specified amount of Subscription resources in the collection.

See also: AWS API Documentation

Request Syntax

subscription_iterator = sns.subscriptions.limit(
    count=123
)

Parameters:: count (integer) – The limit to the number of resources in the iterable.
Return type:: list(sns.Subscription)
Returns:: A list of Subscription resources

page_size(**kwargs)¶

Creates an iterable of all Subscription resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

subscription_iterator = sns.subscriptions.page_size(
    count=123
)

Parameters:: count (integer) – The number of items returned by each service call
Return type:: list(sns.Subscription)
Returns:: A list of Subscription resources