[ aws . organizations ]

invite-account-to-organization

Description

Sends an invitation to another account to join your organization as a member account. 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.

Warning

If you 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, wait one hour and then try again. If the error persists after an hour, contact Amazon Web Services Support .

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

You can only call this operation from the management account.

See also: AWS API Documentation

Synopsis

  invite-account-to-organization
--target <value>
[--notes <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--target (structure) [required]

The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is a JSON object that contains the following elements:

{ "Type": "ACCOUNT", "Id": "<* **account id number** * >" }

If you use the 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 Amazon Web Services 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=diego@example.com,Type=EMAIL

Id -> (string) [required]

ID for the participant: Acccount ID, organization ID, or email address.

The regex pattern for handshake ID string requires “h-” followed by from 8 to 32 lowercase letters or digits.

Constraints:

• min: 1
• max: 64
• pattern: [\s\S]*

Type -> (string) [required]

The type of ID for the participant.

Possible values:

• ACCOUNT
• ORGANIZATION
• EMAIL

Shorthand Syntax:

Id=string,Type=string

JSON Syntax:

{
  "Id": "string",
  "Type": "ACCOUNT"|"ORGANIZATION"|"EMAIL"
}

--notes (string)

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

Constraints:

• max: 1024
• pattern: [\s\S]*

--tags (list)

A list of tags that you want to attach to the account when it becomes a member of the organization. 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.

Warning

Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don’t match the requirements of the policy at that time. Tag policy compliance is * not * checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.

Note

If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.

(structure)

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.

Constraints:

• min: 1
• max: 128
• pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

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.

Constraints:

• min: 0
• max: 256
• pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To invite an account to join an organization

The following example shows the master account owned by bill@example.com inviting the account owned by juan@example.com to join an organization:

aws organizations invite-account-to-organization --target '{"Type": "EMAIL", "Id": "juan@example.com"}' --notes "This is a request for Juan's account to join Bill's organization."

The output includes a handshake structure that shows what is sent to the invited account:

{
        "Handshake": {
                "Action": "INVITE",
                "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
                "ExpirationTimestamp": 1482952459.257,
                "Id": "h-examplehandshakeid111",
                "Parties": [
                        {
                                "Id": "o-exampleorgid",
                                "Type": "ORGANIZATION"
                        },
                        {
                                "Id": "juan@example.com",
                                "Type": "EMAIL"
                        }
                ],
                "RequestedTimestamp": 1481656459.257,
                "Resources": [
                        {
                                "Resources": [
                                        {
                                                "Type": "MASTER_EMAIL",
                                                "Value": "bill@amazon.com"
                                        },
                                        {
                                                "Type": "MASTER_NAME",
                                                "Value": "Org Master Account"
                                        },
                                        {
                                                "Type": "ORGANIZATION_FEATURE_SET",
                                                "Value": "FULL"
                                        }
                                ],
                                "Type": "ORGANIZATION",
                                "Value": "o-exampleorgid"
                        },
                        {
                                "Type": "EMAIL",
                                "Value": "juan@example.com"
                        }
                ],
                "State": "OPEN"
        }
}

Output

Handshake -> (structure)

A structure that contains details about the handshake that is created to support this invitation request.

Id -> (string)

ID for the handshake.

The regex pattern for handshake ID string requires “h-” followed by from 8 to 32 lowercase letters or digits.

Constraints:

• max: 34
• pattern: ^h-[0-9a-z]{8,32}$

Arn -> (string)

Amazon Resource Name (ARN) for the handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .

Constraints:

• pattern: ^arn:aws:organizations::\d{12}:handshake\/o-[a-z0-9]{10,32}\/[a-z_]{1,32}\/h-[0-9a-z]{8,32}

Parties -> (list)

An array of HandshakeParty objects. Contains details for participant in a handshake.

(structure)

Contains details for a participant in a handshake.

Id -> (string) [required]

ID for the participant: Acccount ID, organization ID, or email address.

The regex pattern for handshake ID string requires “h-” followed by from 8 to 32 lowercase letters or digits.

Constraints:

• min: 1
• max: 64
• pattern: [\s\S]*

Type -> (string) [required]

The type of ID for the participant.

Possible values:

• ACCOUNT
• ORGANIZATION
• EMAIL

State -> (string)

Current state for the handshake.

• REQUESTED : Handshake awaiting a response from the recipient.
• OPEN : Handshake sent to multiple recipients and all recipients have responded. The sender can now complete the handshake action.
• CANCELED : Handshake canceled by the sender.
• ACCEPTED : Handshake accepted by the recipient.
• DECLINED : Handshake declined by the recipient.
• EXPIRED : Handshake has expired.

Possible values:

• REQUESTED
• OPEN
• CANCELED
• ACCEPTED
• DECLINED
• EXPIRED

RequestedTimestamp -> (timestamp)

Timestamp when the handshake request was made.

ExpirationTimestamp -> (timestamp)

Timestamp when the handshake expires.

Action -> (string)

The type of handshake:

• INVITE : Handshake sent to a standalone account requesting that it to join the sender’s organization.
• ENABLE_ALL_FEATURES : Handshake sent to invited member accounts to enable all features for the organization.
• APPROVE_ALL_FEATURES : Handshake sent to the management account when all invited member accounts have approved to enable all features.
• TRANSFER_RESPONSIBILITY : Handshake sent to another organization’s management account requesting that it designate the sender with the specified responsibilities for recipient’s organization.

Possible values:

• INVITE
• ENABLE_ALL_FEATURES
• APPROVE_ALL_FEATURES
• ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE
• TRANSFER_RESPONSIBILITY

Resources -> (list)

An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.

(structure)

Contains additional details for a handshake.

Value -> (string)

Additional information for the handshake. The format of the value string must match the requirements of the specified type.

Type -> (string)

The type of information being passed, specifying how the value is to be interpreted by the other party:

• ACCOUNT : ID for an Amazon Web Services account.
• ORGANIZATION : ID for an organization.
• EMAIL : Email address for the recipient.
• OWNER_EMAIL : Email address for the sender.
• OWNER_NAME : Name of the sender.
• NOTES : Additional text included by the sender for the recipient.

Possible values:

• ACCOUNT
• ORGANIZATION
• ORGANIZATION_FEATURE_SET
• EMAIL
• MASTER_EMAIL
• MASTER_NAME
• NOTES
• PARENT_HANDSHAKE
• RESPONSIBILITY_TRANSFER
• TRANSFER_START_TIMESTAMP
• TRANSFER_TYPE
• MANAGEMENT_ACCOUNT
• MANAGEMENT_EMAIL
• MANAGEMENT_NAME

Resources -> (list)

An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.

(structure)

Contains additional details for a handshake.

Value -> (string)

Additional information for the handshake. The format of the value string must match the requirements of the specified type.

Type -> (string)

The type of information being passed, specifying how the value is to be interpreted by the other party:

• ACCOUNT : ID for an Amazon Web Services account.
• ORGANIZATION : ID for an organization.
• EMAIL : Email address for the recipient.
• OWNER_EMAIL : Email address for the sender.
• OWNER_NAME : Name of the sender.
• NOTES : Additional text included by the sender for the recipient.

Possible values:

• ACCOUNT
• ORGANIZATION
• ORGANIZATION_FEATURE_SET
• EMAIL
• MASTER_EMAIL
• MASTER_NAME
• NOTES
• PARENT_HANDSHAKE
• RESPONSIBILITY_TRANSFER
• TRANSFER_START_TIMESTAMP
• TRANSFER_TYPE
• MANAGEMENT_ACCOUNT
• MANAGEMENT_EMAIL
• MANAGEMENT_NAME