ConnectHealth / Client / list_subscriptions

list_subscriptions

ConnectHealth.Client.list_subscriptions(**kwargs)

Lists all Subscriptions within a Domain.

See also: AWS API Documentation

Request Syntax

response = client.list_subscriptions(
    domainId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the parent Domain.

  • maxResults (integer) – Maximum number of results to return.

  • nextToken (string) – Token for pagination.

Return type:

dict

Returns:

Response Syntax

{
    'subscriptions': [
        {
            'domainId': 'string',
            'subscriptionId': 'string',
            'arn': 'string',
            'status': 'ACTIVE'|'INACTIVE'|'DELETED',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'activatedAt': datetime(2015, 1, 1),
            'deactivatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • subscriptions (list) –

      List of Subscriptions.

      • (dict) –

        Complete subscription resource data.

        • domainId (string) –

        • subscriptionId (string) –

        • arn (string) –

        • status (string) –

        • createdAt (datetime) –

        • lastUpdatedAt (datetime) –

        • activatedAt (datetime) –

        • deactivatedAt (datetime) –

    • nextToken (string) –

      Token for the next page of results.

Exceptions