CloudWatchOmni / Paginator / ListDomains

ListDomains

class CloudWatchOmni.Paginator.ListDomains

paginator = client.get_paginator('list_domains')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    '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 resume pagination.