paws.management (version 0.1.6)

organizations_invite_account_to_organization: Sends an invitation to another account to join your organization as a member account

Description

Sends an invitation to another account to join your organization as a member account. AWS Organizations sends email on your behalf to the email address that is associated with the other account\'s owner. The invitation is implemented as a Handshake whose details are in the response.

Usage

organizations_invite_account_to_organization(Target, Notes)

Arguments

Target

[required] The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements:

\{ "Type": "ACCOUNT", "Id": "&lt;<i> <b>account id number</b> </i>&gt;" \}

If you use the AWS CLI, you can submit this as a single string, similar to the following example:

--target Id=123456789012,Type=ACCOUNT

If you specify "Type": "ACCOUNT", you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", you must specify the email address that is associated with the account.

--target Id=[e-mail],Type=EMAIL

Notes

Additional information that you want to include in the generated email to the recipient account owner.

Request syntax

svc$invite_account_to_organization(
  Target = list(
    Id = "string",
    Type = "ACCOUNT"|"ORGANIZATION"|"EMAIL"
  ),
  Notes = "string"
)

Details

• You can invite AWS accounts only from the same seller as the master account. For example, assume that your organization\'s master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India. You can invite only other AISPL accounts to your organization. You can\'t combine accounts from AISPL and AWS or from any other AWS seller. For more information, see Consolidated Billing in India.

• You might receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing. If so, wait one hour and then try again. If the error persists after an hour, contact AWS Support.

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

Examples

# NOT RUN {
# The following example shows the admin of the master account owned by
# [e-mail] inviting the account owned by [e-mail] to join
# an organization.
# }
# NOT RUN {
svc$invite_account_to_organization(
  Notes = "This is a request for Juan's account to join Bill's organization",
  Target = list(
    Id = "[e-mail]",
    Type = "EMAIL"
  )
)
# }
# NOT RUN {
# }