ConnectHealth / Paginator / ListDomains

ListDomains

class ConnectHealth.Paginator.ListDomains

paginator = client.get_paginator('list_domains')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectHealth.Client.list_domains().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    status='ACTIVE'|'DELETING'|'DELETED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• status (string) – Filter by Domain status.

• 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

{
    'domains': [
        {
            'domainId': 'string',
            'arn': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'DELETING'|'DELETED',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • domains (list) –

    List of Domains.

    • (dict) –

      Summary information about a Domain.

      • domainId (string) –

        The unique identifier of the Domain.

      • arn (string) –

      • name (string) –

      • status (string) –

      • createdAt (datetime) –

        The timestamp when the Domain was created.

  • NextToken (string) –

    A token to resume pagination.