CloudWatchOmni / Client / list_domains

list_domains

CloudWatchOmni.Client.list_domains(**kwargs)

Returns the caller’s domains: the account-scoped domain and the organization-scoped domain, if either exists. At most two domains are returned.

See also: AWS API Documentation

Request Syntax

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

  • nextToken (string) – A token to retrieve the next page of results. Tokens expire after 24 hours.

  • maxResults (integer) – The maximum number of domains to return per page. Defaults to 100.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'domainId': 'string',
            'domainArn': 'string',
            'name': 'string',
            'identityCenterInstanceArn': 'string',
            'region': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'status': 'ACTIVE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The list of domain summaries.

      • (dict) –

        Summary of a domain. Call GetDomain for the full domain.

        • domainId (string) –

          The unique ID of the domain.

        • domainArn (string) –

          The Amazon Resource Name (ARN) of the domain.

        • name (string) –

          A name that identifies the domain.

        • identityCenterInstanceArn (string) –

          Identity Center instance ARN configured for the domain. Absent for IAM-only domains.

        • region (string) –

          The Region where this domain was created.

        • createdAt (datetime) –

          The timestamp when the domain was created.

        • updatedAt (datetime) –

          The timestamp when the domain was last updated.

        • status (string) –

          Current status of the domain.

    • nextToken (string) –

      A token to retrieve the next page of results, or null if there are no more results.

Exceptions