ControlCatalog / Paginator / ListDomains

ListDomains

class ControlCatalog.Paginator.ListDomains

paginator = client.get_paginator('list_domains')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ControlCatalog.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

{
    'Domains': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'LastUpdateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Domains (list) –

    The list of domains that the ListDomains API returns.

    • (dict) –

      A summary of metadata for a domain.

      • Arn (string) –

        The Amazon Resource Name (ARN) that identifies the domain.

      • Name (string) –

        The name of the domain.

      • Description (string) –

        The description of the domain.

      • CreateTime (datetime) –

        The time when the domain was created.

      • LastUpdateTime (datetime) –

        The time when the domain was most recently updated.