Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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 theCreateAccountStatus
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.
- 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, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. 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
CreateAccount
to create multiple temporary accounts isn't recommended. You can only close an account from the 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.
Synopsis
- data CreateAccount = CreateAccount' {}
- newCreateAccount :: Text -> Text -> CreateAccount
- createAccount_iamUserAccessToBilling :: Lens' CreateAccount (Maybe IAMUserAccessToBilling)
- createAccount_roleName :: Lens' CreateAccount (Maybe Text)
- createAccount_tags :: Lens' CreateAccount (Maybe [Tag])
- createAccount_email :: Lens' CreateAccount Text
- createAccount_accountName :: Lens' CreateAccount Text
- data CreateAccountResponse = CreateAccountResponse' {}
- newCreateAccountResponse :: Int -> CreateAccountResponse
- createAccountResponse_createAccountStatus :: Lens' CreateAccountResponse (Maybe CreateAccountStatus)
- createAccountResponse_httpStatus :: Lens' CreateAccountResponse Int
Creating a Request
data CreateAccount Source #
See: newCreateAccount
smart constructor.
CreateAccount' | |
|
Instances
Create a value of CreateAccount
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:CreateAccount'
, createAccount_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.
$sel:roleName:CreateAccount'
, createAccount_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: =,.@-
$sel:tags:CreateAccount'
, createAccount_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.
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.
CreateAccount
, createAccount_email
- 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.
CreateAccount
, createAccount_accountName
- The friendly name of the member account.
Request Lenses
createAccount_iamUserAccessToBilling :: Lens' CreateAccount (Maybe IAMUserAccessToBilling) Source #
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.
createAccount_roleName :: Lens' CreateAccount (Maybe Text) Source #
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: =,.@-
createAccount_tags :: Lens' CreateAccount (Maybe [Tag]) Source #
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.
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.
createAccount_email :: Lens' CreateAccount Text Source #
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.
createAccount_accountName :: Lens' CreateAccount Text Source #
The friendly name of the member account.
Destructuring the Response
data CreateAccountResponse Source #
See: newCreateAccountResponse
smart constructor.
CreateAccountResponse' | |
|
Instances
newCreateAccountResponse Source #
Create a value of CreateAccountResponse
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:CreateAccountResponse'
, createAccountResponse_createAccountStatus
- 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.
$sel:httpStatus:CreateAccountResponse'
, createAccountResponse_httpStatus
- The response's http status code.
Response Lenses
createAccountResponse_createAccountStatus :: Lens' CreateAccountResponse (Maybe CreateAccountStatus) Source #
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.
createAccountResponse_httpStatus :: Lens' CreateAccountResponse Int Source #
The response's http status code.