DataZone / Client / list_account_pools

list_account_pools

DataZone.Client.list_account_pools(**kwargs)

Lists existing account pools.

See also: AWS API Documentation

Request Syntax

response = client.list_account_pools(
    domainIdentifier='string',
    maxResults=123,
    name='string',
    nextToken='string',
    sortBy='NAME',
    sortOrder='ASCENDING'|'DESCENDING'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

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

  • maxResults (integer) – The maximum number of account pools to return in a single call to ListAccountPools. When the number of account pools to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAccountPools to list the next set of account pools.

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

  • nextToken (string) – When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.

  • 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.

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) –

      When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.

Exceptions