create_account_status
Creates, updates, deletes, gets or lists a create_account_status resource.
Overview
| Name | create_account_status |
| Type | Resource |
| Id | aws.organizations.create_account_status |
Fields
The following fields are returned by SELECT queries:
- describe_create_account_status
- list_create_account_status
| Name | Datatype | Description |
|---|---|---|
account_id | string | If the account was created successfully, the unique identifier (ID) of the new account. The regex pattern for an account ID string requires exactly 12 digits. (pattern: <code>^\d{12}$</code>) |
account_name | string | The account name given to the account when it was created. (pattern: <code>[\u0020-\u007E]+</code>) |
completed_timestamp | string (date-time) | The date and time that the account was created and the request completed. |
failure_reason | string | If the request failed, a description of the reason for the failure. ACCOUNT_LIMIT_EXCEEDED: The account couldn't be created because you reached the limit on the number of accounts in your organization. CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with the same information. EMAIL_ALREADY_EXISTS: The account could not be created because another Amazon Web Services account with that email address already exists. FAILED_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization failed to receive business license validation. GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the Amazon Web Services GovCloud (US) Region could not be created because this Region already includes an account with that email address. IDENTITY_INVALID_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization can't complete business license validation because it doesn't have valid identity data. INVALID_ADDRESS: The account could not be created because the address you provided is not valid. INVALID_EMAIL: The account could not be created because the email address you provided is not valid. INVALID_PAYMENT_INSTRUMENT: The Amazon Web Services account that owns your organization does not have a supported payment method associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments. INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Amazon Web Services Customer Support. MISSING_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization has not received Business Validation. MISSING_PAYMENT_INSTRUMENT: You must configure the management account with a valid payment method, such as a credit card. PENDING_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization is still in the process of completing business license validation. UNKNOWN_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization has an unknown issue with business license validation. (ACCOUNT_LIMIT_EXCEEDED, EMAIL_ALREADY_EXISTS, INVALID_ADDRESS, INVALID_EMAIL, CONCURRENT_ACCOUNT_MODIFICATION, INTERNAL_FAILURE, GOVCLOUD_ACCOUNT_ALREADY_EXISTS, MISSING_BUSINESS_VALIDATION, FAILED_BUSINESS_VALIDATION, PENDING_BUSINESS_VALIDATION, INVALID_IDENTITY_FOR_BUSINESS_VALIDATION, UNKNOWN_BUSINESS_VALIDATION, MISSING_PAYMENT_INSTRUMENT, INVALID_PAYMENT_INSTRUMENT, UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED) |
gov_cloud_account_id | string | If the account was created successfully, the ID for the new account in the Amazon Web Services GovCloud (US) Region. (pattern: <code>^\d{12}$</code>) |
id | string | The unique identifier (ID) that references this request. You get this value from the response of the initial CreateAccount request to create the account. The regex pattern for a create account request ID string requires "car-" followed by from 8 to 32 lowercase letters or digits. (pattern: <code>^car-[a-z0-9]{8,32}$</code>) |
requested_timestamp | string (date-time) | The date and time that the request was made for the account creation. |
state | string | The status of the asynchronous request to create an Amazon Web Services account. (IN_PROGRESS, SUCCEEDED, FAILED) |
| Name | Datatype | Description |
|---|---|---|
account_id | string | If the account was created successfully, the unique identifier (ID) of the new account. The regex pattern for an account ID string requires exactly 12 digits. (pattern: <code>^\d{12}$</code>) |
account_name | string | The account name given to the account when it was created. (pattern: <code>[\u0020-\u007E]+</code>) |
completed_timestamp | string (date-time) | The date and time that the account was created and the request completed. |
failure_reason | string | If the request failed, a description of the reason for the failure. ACCOUNT_LIMIT_EXCEEDED: The account couldn't be created because you reached the limit on the number of accounts in your organization. CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with the same information. EMAIL_ALREADY_EXISTS: The account could not be created because another Amazon Web Services account with that email address already exists. FAILED_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization failed to receive business license validation. GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the Amazon Web Services GovCloud (US) Region could not be created because this Region already includes an account with that email address. IDENTITY_INVALID_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization can't complete business license validation because it doesn't have valid identity data. INVALID_ADDRESS: The account could not be created because the address you provided is not valid. INVALID_EMAIL: The account could not be created because the email address you provided is not valid. INVALID_PAYMENT_INSTRUMENT: The Amazon Web Services account that owns your organization does not have a supported payment method associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments. INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Amazon Web Services Customer Support. MISSING_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization has not received Business Validation. MISSING_PAYMENT_INSTRUMENT: You must configure the management account with a valid payment method, such as a credit card. PENDING_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization is still in the process of completing business license validation. UNKNOWN_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization has an unknown issue with business license validation. (ACCOUNT_LIMIT_EXCEEDED, EMAIL_ALREADY_EXISTS, INVALID_ADDRESS, INVALID_EMAIL, CONCURRENT_ACCOUNT_MODIFICATION, INTERNAL_FAILURE, GOVCLOUD_ACCOUNT_ALREADY_EXISTS, MISSING_BUSINESS_VALIDATION, FAILED_BUSINESS_VALIDATION, PENDING_BUSINESS_VALIDATION, INVALID_IDENTITY_FOR_BUSINESS_VALIDATION, UNKNOWN_BUSINESS_VALIDATION, MISSING_PAYMENT_INSTRUMENT, INVALID_PAYMENT_INSTRUMENT, UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED) |
gov_cloud_account_id | string | If the account was created successfully, the ID for the new account in the Amazon Web Services GovCloud (US) Region. (pattern: <code>^\d{12}$</code>) |
id | string | The unique identifier (ID) that references this request. You get this value from the response of the initial CreateAccount request to create the account. The regex pattern for a create account request ID string requires "car-" followed by from 8 to 32 lowercase letters or digits. (pattern: <code>^car-[a-z0-9]{8,32}$</code>) |
requested_timestamp | string (date-time) | The date and time that the request was made for the account creation. |
state | string | The status of the asynchronous request to create an Amazon Web Services account. (IN_PROGRESS, SUCCEEDED, FAILED) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_create_account_status | select | region | Retrieves the current status of an asynchronous request to create an account. You can only call this operation from the management account or a member account that is a delegated administrator. | |
list_create_account_status | select | region | Lists the account creation requests that match the specified status that is currently being tracked for the organization. When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results. You can only call this operation from the management account or a member account that is a delegated administrator. |
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
- describe_create_account_status
- list_create_account_status
Retrieves the current status of an asynchronous request to create an account. You can only call this operation from the management account or a member account that is a delegated administrator.
SELECT
account_id,
account_name,
completed_timestamp,
failure_reason,
gov_cloud_account_id,
id,
requested_timestamp,
state
FROM aws.organizations.create_account_status
WHERE region = '{{ region }}' -- required
;
Lists the account creation requests that match the specified status that is currently being tracked for the organization. When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results. You can only call this operation from the management account or a member account that is a delegated administrator.
SELECT
account_id,
account_name,
completed_timestamp,
failure_reason,
gov_cloud_account_id,
id,
requested_timestamp,
state
FROM aws.organizations.create_account_status
WHERE region = '{{ region }}' -- required
;