File Coverage

blib/lib/Paws/Organizations/InviteAccountToOrganization.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::Organizations::InviteAccountToOrganization;
3 1     1   468 use Moose;
  1         3  
  1         9  
4             has Notes => (is => 'ro', isa => 'Str');
5             has Target => (is => 'ro', isa => 'Paws::Organizations::HandshakeParty', required => 1);
6              
7 1     1   5772 use MooseX::ClassAttribute;
  1         3  
  1         9  
8              
9             class_has _api_call => (isa => 'Str', is => 'ro', default => 'InviteAccountToOrganization');
10             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Organizations::InviteAccountToOrganizationResponse');
11             class_has _result_key => (isa => 'Str', is => 'ro');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::Organizations::InviteAccountToOrganization - Arguments for method InviteAccountToOrganization on Paws::Organizations
19              
20             =head1 DESCRIPTION
21              
22             This class represents the parameters used for calling the method InviteAccountToOrganization on the
23             AWS Organizations service. Use the attributes of this class
24             as arguments to method InviteAccountToOrganization.
25              
26             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to InviteAccountToOrganization.
27              
28             As an example:
29              
30             $service_obj->InviteAccountToOrganization(Att1 => $value1, Att2 => $value2, ...);
31              
32             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.
33              
34             =head1 ATTRIBUTES
35              
36              
37             =head2 Notes => Str
38              
39             Additional information that you want to include in the generated email
40             to the recipient account owner.
41              
42              
43              
44             =head2 B<REQUIRED> Target => L<Paws::Organizations::HandshakeParty>
45              
46             The identifier (ID) of the AWS account that you want to invite to join
47             your organization. This is a JSON object that contains the following
48             elements:
49              
50             C<{ "Type": "ACCOUNT", "Id": "E<lt>I< B<account id number> >E<gt>" }>
51              
52             If you use the AWS CLI, you can submit this as a single string, similar
53             to the following example:
54              
55             C<--target Id=123456789012,Type=ACCOUNT>
56              
57             If you specify C<"Type": "ACCOUNT">, then you must provide the AWS
58             account ID number as the C<Id>. If you specify C<"Type": "EMAIL">, then
59             you must specify the email address that is associated with the account.
60              
61             C<--target Id=bill@example.com,Type=EMAIL>
62              
63              
64              
65              
66             =head1 SEE ALSO
67              
68             This class forms part of L<Paws>, documenting arguments for method InviteAccountToOrganization in L<Paws::Organizations>
69              
70             =head1 BUGS and CONTRIBUTIONS
71              
72             The source code is located here: https://github.com/pplu/aws-sdk-perl
73              
74             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
75              
76             =cut
77