ConnectHealth / Client / list_domains

list_domains

ConnectHealth.Client.list_domains(**kwargs)

Lists Domains for a given account.

See also: AWS API Documentation

Request Syntax

response = client.list_domains(
    status='ACTIVE'|'DELETING'|'DELETED',
    maxResults=123,
    nextToken='string'
)

Parameters:

• status (string) – Filter by Domain status.

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

• nextToken (string) – Token for pagination.

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) –

    Token for the next page of results.