DataZone / Paginator / ListAccountPools

ListAccountPools

class DataZone.Paginator.ListAccountPools

paginator = client.get_paginator('list_account_pools')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainIdentifier='string',
    name='string',
    sortBy='NAME',
    sortOrder='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the domain where exsting account pools are to be listed.

• name (string) – The name of the account pool to be listed.

• sortBy (string) – The sort by mechanism in which the existing account pools are to be listed.

• sortOrder (string) – The sort order in which the existing account pools are to be listed.

• 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': [
        {
            'createdBy': 'string',
            'domainId': 'string',
            'domainUnitId': 'string',
            'id': 'string',
            'name': 'string',
            'resolutionStrategy': 'MANUAL',
            'updatedBy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListAccountPools operation.

    • (dict) –

      The summary of the account pool.

      • createdBy (string) –

        The user who created the account pool.

      • domainId (string) –

        The ID of the domain.

      • domainUnitId (string) –

        The ID of the domain unit.

      • id (string) –

        The ID of the account pool.

      • name (string) –

        The name of the account pool.

      • resolutionStrategy (string) –

        The mechanism used to resolve the account selection from the account pool.

      • updatedBy (string) –

        The user who updated the account pool.

  • NextToken (string) –

    A token to resume pagination.