accounts_in_account_pools
Creates, updates, deletes, gets or lists an accounts_in_account_pools resource.
Overview
| Name | accounts_in_account_pools |
| Type | Resource |
| Id | aws.datazone.accounts_in_account_pools |
Fields
The following fields are returned by SELECT queries:
- list_accounts_in_account_pool
| Name | Datatype | Description |
|---|---|---|
aws_account_id | string | The account ID. (pattern: <code>\d{12}</code>) |
aws_account_name | string | The account name. |
supported_regions | array | The regions supported for an account within an account pool. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_accounts_in_account_pool | select | domain_identifier, identifier, region | nextToken, maxResults | Lists the accounts in the specified account pool. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
domain_identifier | string | The ID of the domain in which the accounts in the specified account pool are to be listed. |
identifier | string | The ID of the account pool whose accounts are to be listed. |
region | string | AWS region (default: us-east-1) |
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. |
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. |
SELECT examples
- list_accounts_in_account_pool
Lists the accounts in the specified account pool.
SELECT
aws_account_id,
aws_account_name,
supported_regions
FROM aws.datazone.accounts_in_account_pools
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;