CustomerProfiles / Client / list_domains

list_domains

CustomerProfiles.Client.list_domains(**kwargs)

Returns a list of all the domains for an AWS account that have been created.

See also: AWS API Documentation

Request Syntax

response = client.list_domains(
    NextToken='string',
    MaxResults=123
)

Parameters:

• NextToken (string) – The pagination token from the previous ListDomain API call.

• MaxResults (integer) – The maximum number of objects returned per page.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'DomainName': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'LastUpdatedAt': datetime(2015, 1, 1),
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Items (list) –

    The list of ListDomains instances.

    • (dict) –

      An object in a list that represents a domain.

      • DomainName (string) –

        The unique name of the domain.

      • CreatedAt (datetime) –

        The timestamp of when the domain was created.

      • LastUpdatedAt (datetime) –

        The timestamp of when the domain was most recently edited.

      • Tags (dict) –

        The tags used to organize, track, or control access for this resource.

        • (string) –

          • (string) –

  • NextToken (string) –

    The pagination token from the previous ListDomains API call.

Exceptions

• CustomerProfiles.Client.exceptions.BadRequestException

• CustomerProfiles.Client.exceptions.ResourceNotFoundException

• CustomerProfiles.Client.exceptions.AccessDeniedException

• CustomerProfiles.Client.exceptions.ThrottlingException

• CustomerProfiles.Client.exceptions.InternalServerException