class Aws::Organizations::Types::InviteAccountToOrganizationRequest

@note When making an API call, you may pass InviteAccountToOrganizationRequest

data as a hash:

    {
      target: { # required
        id: "HandshakePartyId", # required
        type: "ACCOUNT", # required, accepts ACCOUNT, ORGANIZATION, EMAIL
      },
      notes: "HandshakeNotes",
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
    }

@!attribute [rw] target

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": "< account id number >" \}`

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=diego@example.com,Type=EMAIL`
@return [Types::HandshakeParty]

@!attribute [rw] notes

Additional information that you want to include in the generated
email to the recipient account owner.
@return [String]

@!attribute [rw] tags

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 AWS Organizations resources][1] in the
AWS Organizations User Guide.

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 <i> <b>not</b>
</i> 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 markdown="1"> If any one of the tags is invalid or if you exceed the allowed
number of tags for an account, then the entire request fails and
invitations are not sent.

 </note>

[1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html
@return [Array<Types::Tag>]

@see docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28/InviteAccountToOrganizationRequest AWS API Documentation

Constants

SENSITIVE