blib/lib/Paws/Organizations/InviteAccountToOrganization.pm untested

filter: Statementstmt 0.0% 0 / 12 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 14 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Organizations::InviteAccountToOrganization;
3 use Moose;
4 has Notes => (is => 'ro', isa => 'Str');
5 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Organizations::Tag]');
6 has Target => (is => 'ro', isa => 'Paws::Organizations::HandshakeParty', required => 1);
7  
8 use MooseX::ClassAttribute;
9  
10 class_has _api_call => (isa => 'Str', is => 'ro', default => 'InviteAccountToOrganization');
11 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Organizations::InviteAccountToOrganizationResponse');
12 class_has _result_key => (isa => 'Str', is => 'ro');
13 1;
14  
15 ### main pod documentation begin ###
16  
17 =head1 NAME
18  
19 Paws::Organizations::InviteAccountToOrganization - Arguments for method InviteAccountToOrganization on L<Paws::Organizations>
20  
21 =head1 DESCRIPTION
22  
23 This class represents the parameters used for calling the method InviteAccountToOrganization on the
24 L<AWS Organizations|Paws::Organizations> service. Use the attributes of this class
25 as arguments to method InviteAccountToOrganization.
26  
27 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to InviteAccountToOrganization.
28  
29 =head1 SYNOPSIS
30  
31 my $organizations = Paws->service('Organizations');
32 # To invite an account to join an organization
33 # The following example shows the admin of the master account owned by
34 # bill@example.com inviting the account owned by juan@example.com to join an
35 # organization.
36 my $InviteAccountToOrganizationResponse = $organizations->InviteAccountToOrganization(
37 'Notes' => 'This is a request for Juan's account to join Bill's organization',
38 'Target' =>
39 {
40 'Id' => 'juan@example.com',
41 'Type' => 'EMAIL'
42 }
43 );
44  
45 # Results:
46 my $Handshake = $InviteAccountToOrganizationResponse->Handshake;
47  
48 # Returns a L<Paws::Organizations::InviteAccountToOrganizationResponse> object.
49  
50 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.
51 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/organizations/InviteAccountToOrganization>
52  
53 =head1 ATTRIBUTES
54  
55  
56 =head2 Notes => Str
57  
58 Additional information that you want to include in the generated email
59 to the recipient account owner.
60  
61  
62  
63 =head2 Tags => ArrayRef[L<Paws::Organizations::Tag>]
64  
65 A list of tags that you want to attach to the account when it becomes a
66 member of the organization. For each tag in the list, you must specify
67 both a tag key and a value. You can set the value to an empty string,
68 but you can't set it to C<null>. For more information about tagging,
69 see Tagging AWS Organizations resources
70 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html)
71 in the AWS Organizations User Guide.
72  
73 Any tags in the request are checked for compliance with any applicable
74 tag policies when the request is made. The request is rejected if the
75 tags in the request don't match the requirements of the policy at that
76 time. Tag policy compliance is I< B<not> > checked again when the
77 invitation is accepted and the tags are actually attached to the
78 account. That means that if the tag policy changes between the
79 invitation and the acceptance, then that tags could potentially be
80 non-compliant.
81  
82 If any one of the tags is invalid or if you exceed the allowed number
83 of tags for an account, then the entire request fails and invitations
84 are not sent.
85  
86  
87  
88 =head2 B<REQUIRED> Target => L<Paws::Organizations::HandshakeParty>
89  
90 The identifier (ID) of the AWS account that you want to invite to join
91 your organization. This is a JSON object that contains the following
92 elements:
93  
94 C<{ "Type": "ACCOUNT", "Id": "E<lt>I< B<account id number> >E<gt>" }>
95  
96 If you use the AWS CLI, you can submit this as a single string, similar
97 to the following example:
98  
99 C<--target Id=123456789012,Type=ACCOUNT>
100  
101 If you specify C<"Type": "ACCOUNT">, you must provide the AWS account
102 ID number as the C<Id>. If you specify C<"Type": "EMAIL">, you must
103 specify the email address that is associated with the account.
104  
105 C<--target Id=diego@example.com,Type=EMAIL>
106  
107  
108  
109  
110 =head1 SEE ALSO
111  
112 This class forms part of L<Paws>, documenting arguments for method InviteAccountToOrganization in L<Paws::Organizations>
113  
114 =head1 BUGS and CONTRIBUTIONS
115  
116 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
117  
118 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
119  
120 =cut
121