gov_cloud_account_informations
Creates, updates, deletes, gets or lists a gov_cloud_account_informations resource.
Overview
| Name | gov_cloud_account_informations |
| Type | Resource |
| Id | aws.account.gov_cloud_account_informations |
Fields
The following fields are returned by SELECT queries:
- get_gov_cloud_account_information
| Name | Datatype | Description |
|---|---|---|
account_state | string | The account state of the linked GovCloud account. (PENDING_ACTIVATION, ACTIVE, SUSPENDED, CLOSED) |
gov_cloud_account_id | string | The 12-digit account ID number of the linked GovCloud account. (pattern: <code>\d{12}</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_gov_cloud_account_information | select | region | Retrieves information about the GovCloud account linked to the specified standard account (if it exists) including the GovCloud account ID and state. To use this API, an IAM user or role must have the account:GetGovCloudAccountInformation IAM permission. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_gov_cloud_account_information
Retrieves information about the GovCloud account linked to the specified standard account (if it exists) including the GovCloud account ID and state. To use this API, an IAM user or role must have the account:GetGovCloudAccountInformation IAM permission.
SELECT
account_state,
gov_cloud_account_id
FROM aws.account.gov_cloud_account_informations
WHERE region = '{{ region }}' -- required
;