You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Organizations::Types::InviteAccountToOrganizationRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing InviteAccountToOrganizationRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  target: { # required
    id: "HandshakePartyId", # required
    type: "ACCOUNT", # required, accepts ACCOUNT, ORGANIZATION, EMAIL
  },
  notes: "HandshakeNotes",
}

Instance Attribute Summary collapse

Instance Attribute Details

#notesString

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

Returns:

  • (String)

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

#targetTypes::HandshakeParty

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", then you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", then you must specify the email address that is associated with the account.

--target Id=bill@example.com,Type=EMAIL

Returns:

  • (Types::HandshakeParty)

    The identifier (ID) of the AWS account that you want to invite to join your organization.