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
- Struct
- Aws::Organizations::Types::InviteAccountToOrganizationRequest
- Defined in:
- (unknown)
Overview
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",
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
}
Instance Attribute Summary collapse
-
#notes ⇒ String
Additional information that you want to include in the generated email to the recipient account owner.
-
#tags ⇒ Array<Types::Tag>
A list of tags that you want to attach to the account when it becomes a member of the organization.
-
#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.
#tags ⇒ Array<Types::Tag>
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 in the AWS Organizations User
Guide.
#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"
, 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