/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Organizations::InviteAccountToOrganization

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');
# To invite an account to join an organization
# The following example shows the admin of the master account owned by
# bill@example.com inviting the account owned by juan@example.com to join an
# organization.
my $InviteAccountToOrganizationResponse = $organizations->InviteAccountToOrganization(
'Notes' => 'This is a request for Juan's account to join Bill's organization',
'Target' => 
{
'Id' => 'juan@example.com',
'Type' => 'EMAIL'
}
);

# Results: my $Handshake = $InviteAccountToOrganizationResponse->Handshake;

# Returns a 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.

Tags => ArrayRef[Paws::Organizations::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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide.

Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.

If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.

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