Amazonka.Organizations.CreateGovCloudAccount

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.

• When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account is not automatically collected. This includes a payment method and signing the end user license agreement (EULA). If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the Organizations User Guide.
• If you get an exception that indicates that you exceeded your account limits for the organization, contact Amazon Web Services Support.
• If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact Amazon Web Services Support.
• Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Amazon Web Services Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an Amazon Web Services account in the Organizations User Guide.

When you create a member account with this operation, you can choose whether to create the account with the __IAM User and Role Access to Billing Information__ switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.

Creating a Request

data CreateGovCloudAccount

See: newCreateGovCloudAccount smart constructor.

Constructors

CreateGovCloudAccount'

Fields

• iamUserAccessToBilling :: Maybe 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.

• roleName :: Maybe Text

  (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: =,.@-

• tags :: Maybe [Tag]

  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.

  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.

• email :: Sensitive Text

  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.

• accountName :: Sensitive Text

  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 (–).

Instances

ToJSON CreateGovCloudAccount

Defined in Amazonka.Organizations.CreateGovCloudAccount

Methods

toJSON :: CreateGovCloudAccount -> Value

toEncoding :: CreateGovCloudAccount -> Encoding

toJSONList :: [CreateGovCloudAccount] -> Value

toEncodingList :: [CreateGovCloudAccount] -> Encoding

ToHeaders CreateGovCloudAccount

Defined in Amazonka.Organizations.CreateGovCloudAccount

Methods

toHeaders :: CreateGovCloudAccount -> [Header]

ToPath CreateGovCloudAccount

Defined in Amazonka.Organizations.CreateGovCloudAccount

Methods

toPath :: CreateGovCloudAccount -> ByteString

ToQuery CreateGovCloudAccount

Defined in Amazonka.Organizations.CreateGovCloudAccount

Methods

toQuery :: CreateGovCloudAccount -> QueryString

AWSRequest CreateGovCloudAccount

Defined in Amazonka.Organizations.CreateGovCloudAccount

Associated Types

type AWSResponse CreateGovCloudAccount

Methods

request :: (Service -> Service) -> CreateGovCloudAccount -> Request CreateGovCloudAccount

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateGovCloudAccount -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateGovCloudAccount)))

Generic CreateGovCloudAccount

Defined in Amazonka.Organizations.CreateGovCloudAccount

Associated Types

type Rep CreateGovCloudAccount :: Type -> Type

Methods

from :: CreateGovCloudAccount -> Rep CreateGovCloudAccount x

to :: Rep CreateGovCloudAccount x -> CreateGovCloudAccount

Show CreateGovCloudAccount

Defined in Amazonka.Organizations.CreateGovCloudAccount

Methods

showsPrec :: Int -> CreateGovCloudAccount -> ShowS

show :: CreateGovCloudAccount -> String

showList :: [CreateGovCloudAccount] -> ShowS

NFData CreateGovCloudAccount

Defined in Amazonka.Organizations.CreateGovCloudAccount

Methods

rnf :: CreateGovCloudAccount -> ()

Eq CreateGovCloudAccount

Defined in Amazonka.Organizations.CreateGovCloudAccount

Methods

(==) :: CreateGovCloudAccount -> CreateGovCloudAccount -> Bool

(/=) :: CreateGovCloudAccount -> CreateGovCloudAccount -> Bool

Hashable CreateGovCloudAccount

Defined in Amazonka.Organizations.CreateGovCloudAccount

Methods

hashWithSalt :: Int -> CreateGovCloudAccount -> Int

hash :: CreateGovCloudAccount -> Int

type AWSResponse CreateGovCloudAccount

Defined in Amazonka.Organizations.CreateGovCloudAccount

type AWSResponse CreateGovCloudAccount = CreateGovCloudAccountResponse

type Rep CreateGovCloudAccount

Defined in Amazonka.Organizations.CreateGovCloudAccount

type Rep CreateGovCloudAccount = D1 ('MetaData "CreateGovCloudAccount" "Amazonka.Organizations.CreateGovCloudAccount" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "CreateGovCloudAccount'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "iamUserAccessToBilling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IAMUserAccessToBilling)) :*: S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "accountName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newCreateGovCloudAccount

Arguments

:: Text

CreateGovCloudAccount

-> Text

CreateGovCloudAccount

-> CreateGovCloudAccount

Create a value of CreateGovCloudAccount with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:iamUserAccessToBilling:CreateGovCloudAccount', createGovCloudAccount_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.

$sel:roleName:CreateGovCloudAccount', createGovCloudAccount_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: =,.@-

$sel:tags:CreateGovCloudAccount', createGovCloudAccount_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.

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.

CreateGovCloudAccount, createGovCloudAccount_email - 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.

CreateGovCloudAccount, createGovCloudAccount_accountName - 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 (–).

Request Lenses

createGovCloudAccount_iamUserAccessToBilling :: Lens' CreateGovCloudAccount (Maybe 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.

createGovCloudAccount_roleName :: Lens' CreateGovCloudAccount (Maybe Text)

(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: =,.@-

createGovCloudAccount_tags :: Lens' CreateGovCloudAccount (Maybe [Tag])

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.

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.

createGovCloudAccount_email :: Lens' CreateGovCloudAccount Text

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.

createGovCloudAccount_accountName :: Lens' CreateGovCloudAccount Text

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 (–).

Destructuring the Response

data CreateGovCloudAccountResponse

See: newCreateGovCloudAccountResponse smart constructor.

Constructors

CreateGovCloudAccountResponse'

Fields

• createAccountStatus :: Maybe CreateAccountStatus
• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateGovCloudAccountResponse

Defined in Amazonka.Organizations.CreateGovCloudAccount

Associated Types

type Rep CreateGovCloudAccountResponse :: Type -> Type

Methods

from :: CreateGovCloudAccountResponse -> Rep CreateGovCloudAccountResponse x

to :: Rep CreateGovCloudAccountResponse x -> CreateGovCloudAccountResponse

Show CreateGovCloudAccountResponse

Defined in Amazonka.Organizations.CreateGovCloudAccount

Methods

showsPrec :: Int -> CreateGovCloudAccountResponse -> ShowS

show :: CreateGovCloudAccountResponse -> String

showList :: [CreateGovCloudAccountResponse] -> ShowS

NFData CreateGovCloudAccountResponse

Defined in Amazonka.Organizations.CreateGovCloudAccount

Methods

rnf :: CreateGovCloudAccountResponse -> ()

Eq CreateGovCloudAccountResponse

Defined in Amazonka.Organizations.CreateGovCloudAccount

Methods

(==) :: CreateGovCloudAccountResponse -> CreateGovCloudAccountResponse -> Bool

(/=) :: CreateGovCloudAccountResponse -> CreateGovCloudAccountResponse -> Bool

type Rep CreateGovCloudAccountResponse

Defined in Amazonka.Organizations.CreateGovCloudAccount

type Rep CreateGovCloudAccountResponse = D1 ('MetaData "CreateGovCloudAccountResponse" "Amazonka.Organizations.CreateGovCloudAccount" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "CreateGovCloudAccountResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createAccountStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateAccountStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateGovCloudAccountResponse

Arguments

:: Int

$sel:httpStatus:CreateGovCloudAccountResponse'

-> CreateGovCloudAccountResponse

Create a value of CreateGovCloudAccountResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createAccountStatus:CreateGovCloudAccountResponse', createGovCloudAccountResponse_createAccountStatus - Undocumented member.

$sel:httpStatus:CreateGovCloudAccountResponse', createGovCloudAccountResponse_httpStatus - The response's http status code.

Response Lenses

createGovCloudAccountResponse_createAccountStatus :: Lens' CreateGovCloudAccountResponse (Maybe CreateAccountStatus)

Undocumented member.

createGovCloudAccountResponse_httpStatus :: Lens' CreateGovCloudAccountResponse Int

The response's http status code.