Organizations / Client / describe_create_account_status

describe_create_account_status#

Organizations.Client.describe_create_account_status(**kwargs)#

Retrieves the current status of an asynchronous request to create an account.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator for an Amazon Web Services service.

See also: AWS API Documentation

Request Syntax

response = client.describe_create_account_status(
    CreateAccountRequestId='string'
)
Parameters:

CreateAccountRequestId (string) –

[REQUIRED]

Specifies the Id value that uniquely identifies the CreateAccount request. You can get the value from the CreateAccountStatus.Id response in an earlier CreateAccount request, or from the ListCreateAccountStatus operation.

The regex pattern for a create account request ID string requires “car-” followed by from 8 to 32 lowercase letters or digits.

Return type:

dict

Returns:

Response Syntax

{
    'CreateAccountStatus': {
        'Id': 'string',
        'AccountName': 'string',
        'State': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
        'RequestedTimestamp': datetime(2015, 1, 1),
        'CompletedTimestamp': datetime(2015, 1, 1),
        'AccountId': 'string',
        'GovCloudAccountId': 'string',
        'FailureReason': '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'
    }
}

Response Structure

  • (dict) –

    • CreateAccountStatus (dict) –

      A structure that contains the current status of an account creation request.

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

      • AccountName (string) –

        The account name given to the account when it was created.

      • State (string) –

        The status of the asynchronous request to create an Amazon Web Services account.

      • RequestedTimestamp (datetime) –

        The date and time that the request was made for the account creation.

      • CompletedTimestamp (datetime) –

        The date and time that the account was created and the request completed.

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

      • GovCloudAccountId (string) –

        If the account was created successfully, the unique identifier (ID) of the new account in the Amazon Web Services GovCloud (US) Region.

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

Exceptions

  • Organizations.Client.exceptions.AccessDeniedException

  • Organizations.Client.exceptions.AWSOrganizationsNotInUseException

  • Organizations.Client.exceptions.CreateAccountStatusNotFoundException

  • Organizations.Client.exceptions.InvalidInputException

  • Organizations.Client.exceptions.ServiceException

  • Organizations.Client.exceptions.TooManyRequestsException

  • Organizations.Client.exceptions.UnsupportedAPIEndpointException

Examples

The following example shows how to request the status about a previous request to create an account in an organization. This operation can be called only by a principal from the organization’s master account. In the example, the specified “createAccountRequestId” comes from the response of the original call to “CreateAccount”:

response = client.describe_create_account_status(
    CreateAccountRequestId='car-exampleaccountcreationrequestid',
)

print(response)

Expected Output:

{
    'CreateAccountStatus': {
        'AccountId': '333333333333',
        'Id': 'car-exampleaccountcreationrequestid',
        'State': 'SUCCEEDED',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}