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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-organizations/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", # 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)


1302
1303
1304
1305
1306
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1302

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

#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



1302
1303
1304
1305
1306
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1302

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