DataZone / Client / list_accounts_in_account_pool

list_accounts_in_account_pool¶

DataZone.Client.list_accounts_in_account_pool(**kwargs)¶

Lists the accounts in the specified account pool.

Request Syntax

response = client.list_accounts_in_account_pool(
    domainIdentifier='string',
    identifier='string',
    nextToken='string',
    maxResults=123
)

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.
nextToken (string) – When the number of accounts 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 accounts, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountsInAccountPool to list the next set of accounts.
maxResults (integer) – The maximum number of accounts to return in a single call to ListAccountsInAccountPool. When the number of accounts 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 ListAccountsInAccountPool to list the next set of accounts.

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) –
  
  When the number of accounts 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 accounts, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountsInAccountPool to list the next set of accounts.

Exceptions

DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.ResourceNotFoundException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException