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

Inherits:

Struct

Object
Struct
Aws::Organizations::Types::InviteAccountToOrganizationRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-organizations/types.rb

Overview

Note:

When making an API call, you may pass InviteAccountToOrganizationRequest data as a hash:

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

Instance Attribute Summary collapse

#notes ⇒ String

Additional information that you want to include in the generated email to the recipient account owner.
#target ⇒ Types::HandshakeParty

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

Instance Attribute Details

#notes ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-organizations/types.rb', line 1300

class InviteAccountToOrganizationRequest < Struct.new(
  :target,
  :notes)
  include Aws::Structure
end

#target ⇒ `Types::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 [email protected],type=EMAIL`