WorkDocs / Client / describe_notification_subscriptions

describe_notification_subscriptions#

WorkDocs.Client.describe_notification_subscriptions(**kwargs)#

Lists the specified notification subscriptions.

See also: AWS API Documentation

Request Syntax

response = client.describe_notification_subscriptions(
    OrganizationId='string',
    Marker='string',
    Limit=123
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    The ID of the organization.

  • Marker (string) – The marker for the next set of results. (You received this marker from a previous call.)

  • Limit (integer) – The maximum number of items to return with this call.

Return type:

dict

Returns:

Response Syntax

{
    'Subscriptions': [
        {
            'SubscriptionId': 'string',
            'EndPoint': 'string',
            'Protocol': 'HTTPS'|'SQS'
        },
    ],
    'Marker': '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.

    • Marker (string) –

      The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Exceptions

  • WorkDocs.Client.exceptions.UnauthorizedResourceAccessException

  • WorkDocs.Client.exceptions.EntityNotExistsException

  • WorkDocs.Client.exceptions.ServiceUnavailableException