WorkDocs / Paginator / DescribeNotificationSubscriptions
DescribeNotificationSubscriptions#
- class WorkDocs.Paginator.DescribeNotificationSubscriptions#
paginator = client.get_paginator('describe_notification_subscriptions')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
WorkDocs.Client.describe_notification_subscriptions()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( OrganizationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
OrganizationId (string) –
[REQUIRED]
The ID of the organization.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'Subscriptions': [ { 'SubscriptionId': 'string', 'EndPoint': 'string', 'Protocol': 'HTTPS'|'SQS' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
Subscriptions (list) –
The subscriptions.
(dict) –
Describes a subscription.
SubscriptionId (string) –
The ID of the subscription.
EndPoint (string) –
The endpoint of the subscription.
Protocol (string) –
The protocol of the subscription.
NextToken (string) –
A token to resume pagination.