AWS Organizations

Creates or updates a resource policy.

You can only call this operation from the organization's management account.

See also: AWS API Documentation

Request Syntax

client.put_resource_policy(
    Content='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Content

string

param Content

[REQUIRED]

If provided, the new content for the resource policy. The text must be correctly formatted JSON that complies with the syntax for the resource policy's type. For more information, see Service Control Policy Syntax in the Organizations User Guide.

type Tags

list

param Tags

Updates the list of tags that you want to attach to the newly-created resource policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null . For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.

Note

Calls with tags apply to the initial creation of the resource policy, otherwise an exception is thrown. If any one of the tags is invalid or if you exceed the allowed number of tags for the resource policy, then the entire request fails and the resource policy is not created.

• (dict) --

  A custom key-value pair associated with a resource within your organization.

  You can attach tags to any of the following organization resources.

  • Amazon Web Services account

  • Organizational unit (OU)

  • Organization root

  • Policy

  • Key (string) -- [REQUIRED]

    The key identifier, or name, of the tag.

  • Value (string) -- [REQUIRED]

    The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

rtype

dict

returns

Response Syntax

{
    'ResourcePolicy': {
        'ResourcePolicySummary': {
            'Id': 'string',
            'Arn': 'string'
        },
        'Content': 'string'
    }
}

Response Structure

• (dict) --

  • ResourcePolicy (dict) --

    A structure that contains details about the resource policy.

    • ResourcePolicySummary (dict) --

      A structure that contains resource policy ID and Amazon Resource Name (ARN).

      • Id (string) --

        The unique identifier (ID) of the resource policy.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the resource policy.

    • Content (string) --

      The policy text of the resource policy.

Retrieves information about a resource policy.

You can only call this operation from the organization's management account or by a member account that is a delegated administrator for an AWS service.

See also: AWS API Documentation

Request Syntax

client.describe_resource_policy()

rtype

dict

returns

Response Syntax

{
    'ResourcePolicy': {
        'ResourcePolicySummary': {
            'Id': 'string',
            'Arn': 'string'
        },
        'Content': 'string'
    }
}

Response Structure

• (dict) --

  • ResourcePolicy (dict) --

    A structure that contains details about the resource policy.

    • ResourcePolicySummary (dict) --

      A structure that contains resource policy ID and Amazon Resource Name (ARN).

      • Id (string) --

        The unique identifier (ID) of the resource policy.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the resource policy.

    • Content (string) --

      The policy text of the resource policy.

Deletes the resource policy from your organization.

You can only call this operation from the organization's management account.

See also: AWS API Documentation

Request Syntax

client.delete_resource_policy()

returns

None

{'CreateAccountStatus': {'FailureReason': {'UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED'}}}

Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that Amazon Web Services performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:

• Use the Id value of the CreateAccountStatus response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

• Check the CloudTrail log for the CreateAccountResult event. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide.

The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, Organizations creates the required service-linked role named AWSServiceRoleForOrganizations . For more information, see Organizations and Service-Linked Roles in the Organizations User Guide .

If the request includes tags, then the requester must have the organizations:TagResource permission.

Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. Organizations clones the company name and address information for the new account from the organization's management account.

This operation can be called only from the organization's management account.

For more information about creating accounts, see Creating an Amazon Web Services account in Your Organization in the Organizations User Guide.

See also: AWS API Documentation

Request Syntax

client.create_account(
    Email='string',
    AccountName='string',
    RoleName='string',
    IamUserAccessToBilling='ALLOW'|'DENY',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Email

string

param Email

[REQUIRED]

The email address of the owner to assign to the new member account. This email address must not already be associated with another Amazon Web Services account. You must use a valid email address to complete account creation.

The rules for a valid email address:

• The address must be a minimum of 6 and a maximum of 64 characters long.

• All characters must be 7-bit ASCII characters.

• There must be one and only one @ symbol, which separates the local name from the domain name.

• The local name can't contain any of the following characters: whitespace, " ' ( ) < > [ ] : ; , | % &

• The local name can't begin with a dot (.)

• The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.)

• The domain name can't begin or end with a hyphen (-) or dot (.)

• The domain name must contain at least one dot

You can't access the root user of the account or remove an account that was created with an invalid email address.

type AccountName

string

param AccountName

[REQUIRED]

The friendly name of the member account.

type RoleName

string

param RoleName

The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.

If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole .

For more information about how to use this role to access the member account, see the following links:

• Accessing and Administering the Member Accounts in Your Organization in the Organizations User Guide

• Steps 2 and 3 in Tutorial: Delegate Access Across Amazon Web Services accounts Using IAM Roles in the IAM User Guide

The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

type IamUserAccessToBilling

string

param IamUserAccessToBilling

If set to ALLOW , the new account enables IAM users to access account billing information if they have the required permissions. If set to DENY , only the root user of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the Amazon Web Services Billing and Cost Management User Guide .

If you don't specify this parameter, the value defaults to ALLOW , and IAM users and roles with the required permissions can access billing information for the new account.

type Tags

list

param Tags

A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null . For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.

Note

If any one of the tags is invalid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.

• (dict) --

  A custom key-value pair associated with a resource within your organization.

  You can attach tags to any of the following organization resources.

  • Amazon Web Services account

  • Organizational unit (OU)

  • Organization root

  • Policy

  • Key (string) -- [REQUIRED]

    The key identifier, or name, of the tag.

  • Value (string) -- [REQUIRED]

    The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

rtype

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 details about the request to create an account. This response structure might not be fully populated when you first receive it because account creation is an asynchronous process. You can pass the returned CreateAccountStatus ID as a parameter to DescribeCreateAccountStatus to get status about the progress of the request at later times. You can also check the CloudTrail log for the CreateAccountResult event. For more information, see Monitoring the Activity in Your Organization in the Organizations User Guide .

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

{'CreateAccountStatus': {'FailureReason': {'UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED'}}}

This action is available if all of the following are true:

• You're authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For more information on the Amazon Web Services GovCloud (US) Region, see the Amazon Web Services GovCloud User Guide.

• You already have an account in the Amazon Web Services GovCloud (US) Region that is paired with a management account of an organization in the commercial Region.

• You call this action from the management account of your organization in the commercial Region.

• You have the organizations:CreateGovCloudAccount permission.

Organizations automatically creates the required service-linked role named AWSServiceRoleForOrganizations . For more information, see Organizations and Service-Linked Roles in the Organizations User Guide.

Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also do the following:

• Verify that CloudTrail is enabled to store logs.

• Create an Amazon S3 bucket for CloudTrail log storage. For more information, see Verifying CloudTrail Is Enabled in the Amazon Web Services GovCloud User Guide .

If the request includes tags, then the requester must have the organizations:TagResource permission. The tags are attached to the commercial account associated with the GovCloud account, rather than the GovCloud account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud account exists.

You call this action from the management account of your organization in the commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US) Region. After the account is created, the management account of an organization in the Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an organization, see Organizations in the Amazon Web Services GovCloud User Guide.

Calling CreateGovCloudAccount is an asynchronous request that Amazon Web Services performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:

• Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

• Check the CloudTrail log for the CreateAccountResult event. For information on using CloudTrail with Organizations, see Monitoring the Activity in Your Organization in the Organizations User Guide.

When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address.

A role is created in the new account in the commercial Region that allows the management account in the organization in the commercial Region to assume it. An Amazon Web Services GovCloud (US) account is then created and associated with the commercial account that you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management account of the commercial organization. For more information and to view a diagram that explains how account access works, see Organizations in the Amazon Web Services GovCloud User Guide.

For more information about creating accounts, see Creating an Amazon Web Services account in Your Organization in the Organizations User Guide.

See also: AWS API Documentation

Request Syntax

client.create_gov_cloud_account(
    Email='string',
    AccountName='string',
    RoleName='string',
    IamUserAccessToBilling='ALLOW'|'DENY',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Email

string

param Email

[REQUIRED]

Specifies the email address of the owner to assign to the new member account in the commercial Region. This email address must not already be associated with another Amazon Web Services account. You must use a valid email address to complete account creation.

The rules for a valid email address:

• The address must be a minimum of 6 and a maximum of 64 characters long.

• All characters must be 7-bit ASCII characters.

• There must be one and only one @ symbol, which separates the local name from the domain name.

• The local name can't contain any of the following characters: whitespace, " ' ( ) < > [ ] : ; , | % &

• The local name can't begin with a dot (.)

• The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.)

• The domain name can't begin or end with a hyphen (-) or dot (.)

• The domain name must contain at least one dot

You can't access the root user of the account or remove an account that was created with an invalid email address. Like all request parameters for CreateGovCloudAccount , the request for the email address for the Amazon Web Services GovCloud (US) account originates from the commercial Region, not from the Amazon Web Services GovCloud (US) Region.

type AccountName

string

param AccountName

[REQUIRED]

The friendly name of the member account.

The account name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) You can't separate characters with a dash (–).

type RoleName

string

param RoleName

(Optional)

The name of an IAM role that Organizations automatically preconfigures in the new member accounts in both the Amazon Web Services GovCloud (US) Region and in the commercial Region. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.

If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole .

For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the Organizations User Guide and steps 2 and 3 in Tutorial: Delegate Access Across Amazon Web Services accounts Using IAM Roles in the IAM User Guide.

The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

type IamUserAccessToBilling

string

param IamUserAccessToBilling

If set to ALLOW , the new linked account in the commercial Region enables IAM users to access account billing information if they have the required permissions. If set to DENY , only the root user of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the Amazon Web Services Billing and Cost Management User Guide.

If you don't specify this parameter, the value defaults to ALLOW , and IAM users and roles with the required permissions can access billing information for the new account.

type Tags

list

param Tags

A list of tags that you want to attach to the newly created account. These tags are attached to the commercial account associated with the GovCloud account, and not to the GovCloud account itself. To add tags to the actual GovCloud account, call the TagResource operation in the GovCloud region after the new GovCloud account exists.

For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null . For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.

Note

If any one of the tags is invalid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.

• (dict) --

  A custom key-value pair associated with a resource within your organization.

  You can attach tags to any of the following organization resources.

  • Amazon Web Services account

  • Organizational unit (OU)

  • Organization root

  • Policy

  • Key (string) -- [REQUIRED]

    The key identifier, or name, of the tag.

  • Value (string) -- [REQUIRED]

    The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

rtype

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) --

    Contains the status about a CreateAccount or CreateGovCloudAccount request to create an Amazon Web Services account or an Amazon Web Services GovCloud (US) account in an organization.

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

{'CreateAccountStatus': {'FailureReason': {'UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED'}}}

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

client.describe_create_account_status(
    CreateAccountRequestId='string'
)

type CreateAccountRequestId

string

param CreateAccountRequestId

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

rtype

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.

{'CreateAccountStatuses': {'FailureReason': {'UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED'}}}

Lists the account creation requests that match the specified status that is currently being tracked for the organization.

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

client.list_create_account_status(
    States=[
        'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    ],
    NextToken='string',
    MaxResults=123
)

type States

list

param States

A list of one or more states that you want included in the response. If this parameter isn't present, all requests are included in the response.

• (string) --

type NextToken

string

param NextToken

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

type MaxResults

integer

param MaxResults

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

rtype

dict

returns

Response Syntax

{
    'CreateAccountStatuses': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • CreateAccountStatuses (list) --

    A list of objects with details about the requests. Certain elements, such as the accountId number, are present in the output only after the account has been successfully created.

    • (dict) --

      Contains the status about a CreateAccount or CreateGovCloudAccount request to create an Amazon Web Services account or an Amazon Web Services GovCloud (US) account in an organization.

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

  • NextToken (string) --

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null .