DataZone / Paginator / ListDomains

ListDomains#

class DataZone.Paginator.ListDomains#
paginator = client.get_paginator('list_domains')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    status='CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • status (string) – The status of the data source.

  • 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': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'id': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'managedAccountId': 'string',
            'name': 'string',
            'portalUrl': 'string',
            'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The results of the ListDomains action.

      • (dict) –

        A summary of a Amazon DataZone domain.

        • arn (string) –

          The ARN of the Amazon DataZone domain.

        • createdAt (datetime) –

          A timestamp of when a Amazon DataZone domain was created.

        • description (string) –

          A description of an Amazon DataZone domain.

        • id (string) –

          The ID of the Amazon DataZone domain.

        • lastUpdatedAt (datetime) –

          A timestamp of when a Amazon DataZone domain was last updated.

        • managedAccountId (string) –

          The identifier of the Amazon Web Services account that manages the domain.

        • name (string) –

          A name of an Amazon DataZone domain.

        • portalUrl (string) –

          The data portal URL for the Amazon DataZone domain.

        • status (string) –

          The status of the Amazon DataZone domain.

    • NextToken (string) –

      A token to resume pagination.