DataZone / Paginator / ListAccountsInAccountPool

ListAccountsInAccountPool

class DataZone.Paginator.ListAccountsInAccountPool

paginator = client.get_paginator('list_accounts_in_account_pool')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the domain in which the accounts in the specified account pool are to be listed.

• identifier (string) –

  [REQUIRED]

  The ID of the account pool whose accounts 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': [
        {
            'awsAccountId': 'string',
            'supportedRegions': [
                'string',
            ],
            'awsAccountName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListAccountsInAccountPool operation.

    • (dict) –

      The account information within an account pool.

      • awsAccountId (string) –

        The account ID.

      • supportedRegions (list) –

        The regions supported for an account within an account pool.

        • (string) –

      • awsAccountName (string) –

        The account name.

  • NextToken (string) –

    A token to resume pagination.