Organizations / Client / invite_account_to_organization

invite_account_to_organization

Organizations.Client.invite_account_to_organization(**kwargs)

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

Request Syntax

response = client.invite_account_to_organization(
    Target={
        'Id': 'string',
        'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
    },
    Notes='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Target (dict) –

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

    • Type (string) – [REQUIRED]

      The type of ID for the participant.

  • Notes (string) – Additional information that you want to include in the generated email to the recipient account owner.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'Handshake': {
        'Id': 'string',
        'Arn': 'string',
        'Parties': [
            {
                'Id': 'string',
                'Type': 'ACCOUNT'|'ORGANIZATION'|'EMAIL'
            },
        ],
        'State': 'REQUESTED'|'OPEN'|'CANCELED'|'ACCEPTED'|'DECLINED'|'EXPIRED',
        'RequestedTimestamp': datetime(2015, 1, 1),
        'ExpirationTimestamp': datetime(2015, 1, 1),
        'Action': 'INVITE'|'ENABLE_ALL_FEATURES'|'APPROVE_ALL_FEATURES'|'ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE'|'TRANSFER_RESPONSIBILITY',
        'Resources': [
            {
                'Value': 'string',
                'Type': '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': {'... recursive ...'}
            },
        ]
    }
}

Response Structure

  • (dict) –

    • Handshake (dict) –

      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.

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

      • Parties (list) –

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

        • (dict) –

          Contains details for a participant in a handshake.

          • Id (string) –

            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.

          • Type (string) –

            The type of ID for the participant.

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

      • RequestedTimestamp (datetime) –

        Timestamp when the handshake request was made.

      • ExpirationTimestamp (datetime) –

        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.

      • Resources (list) –

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

        • (dict) –

          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.

          • Resources (list) –

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

Exceptions

Examples

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

response = client.invite_account_to_organization(
    Notes='This is a request for Juan's account to join Bill's organization',
    Target={
        'Id': 'juan@example.com',
        'Type': 'EMAIL',
    },
)

print(response)

Expected Output:

{
    'Handshake': {
        'Action': 'INVITE',
        'Arn': 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
        'ExpirationTimestamp': datetime(2017, 2, 16, 9, 36, 5, 3, 47, 0),
        'Id': 'h-examplehandshakeid111',
        'Parties': [
            {
                'Id': 'o-exampleorgid',
                'Type': 'ORGANIZATION',
            },
            {
                'Id': 'juan@example.com',
                'Type': 'EMAIL',
            },
        ],
        'RequestedTimestamp': datetime(2017, 2, 1, 9, 36, 5, 2, 32, 0),
        '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',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}