NAME
Paws::Organizations::InviteAccountToOrganization - Arguments for method InviteAccountToOrganization on Paws::Organizations
DESCRIPTION
This class represents the parameters used for calling the method InviteAccountToOrganization on the AWS Organizations service. Use the attributes of this class as arguments to method InviteAccountToOrganization.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to InviteAccountToOrganization.
SYNOPSIS
my $organizations = Paws->service('Organizations');
my $InviteAccountToOrganizationResponse =
$organizations->InviteAccountToOrganization(
Target => {
Id => 'MyHandshakePartyId', # min: 1, max: 64
Type => 'ACCOUNT', # values: ACCOUNT, ORGANIZATION, EMAIL
},
Notes => 'MyHandshakeNotes', # OPTIONAL
);
# Results:
my $Handshake = $InviteAccountToOrganizationResponse->Handshake;
# Returns a L<Paws::Organizations::InviteAccountToOrganizationResponse> object.
Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/organizations/InviteAccountToOrganization
ATTRIBUTES
Notes => Str
Additional information that you want to include in the generated email to the recipient account owner.
REQUIRED Target => Paws::Organizations::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
SEE ALSO
This class forms part of Paws, documenting arguments for method InviteAccountToOrganization in Paws::Organizations
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues