File Coverage

blib/lib/Paws/Organizations/Organization.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::Organizations::Organization;
2 1     1   384 use Moose;
  1         4  
  1         9  
3             has Arn => (is => 'ro', isa => 'Str');
4             has AvailablePolicyTypes => (is => 'ro', isa => 'ArrayRef[Paws::Organizations::PolicyTypeSummary]');
5             has FeatureSet => (is => 'ro', isa => 'Str');
6             has Id => (is => 'ro', isa => 'Str');
7             has MasterAccountArn => (is => 'ro', isa => 'Str');
8             has MasterAccountEmail => (is => 'ro', isa => 'Str');
9             has MasterAccountId => (is => 'ro', isa => 'Str');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::Organizations::Organization
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::Organizations::Organization object:
28              
29             $service_obj->Method(Att1 => { Arn => $value, ..., MasterAccountId => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::Organizations::Organization object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->Arn
37              
38             =head1 DESCRIPTION
39              
40             Contains details about an organization. An organization is a collection
41             of accounts that are centrally managed together using consolidated
42             billing, organized hierarchically with organizational units (OUs), and
43             controlled with policies .
44              
45             =head1 ATTRIBUTES
46              
47              
48             =head2 Arn => Str
49              
50             The Amazon Resource Name (ARN) of an organization.
51              
52             For more information about ARNs in Organizations, see ARN Formats
53             Supported by Organizations in the I<AWS Organizations User Guide>.
54              
55              
56             =head2 AvailablePolicyTypes => ArrayRef[L<Paws::Organizations::PolicyTypeSummary>]
57              
58             A list of policy types that are enabled for this organization. For
59             example, if your organization has all features enabled, then service
60             control policies (SCPs) are included in the list.
61              
62              
63             =head2 FeatureSet => Str
64              
65             Specifies the functionality that currently is available to the
66             organization. If set to "ALL", then all features are enabled and
67             policies can be applied to accounts in the organization. If set to
68             "CONSOLIDATED_BILLING", then only consolidated billing functionality is
69             available. For more information, see Enabling All Features in Your
70             Organization in the I<AWS Organizations User Guide>.
71              
72              
73             =head2 Id => Str
74              
75             The unique identifier (ID) of an organization.
76              
77             The regex pattern for an organization ID string requires "o-" followed
78             by from 10 to 32 lower-case letters or digits.
79              
80              
81             =head2 MasterAccountArn => Str
82              
83             The Amazon Resource Name (ARN) of the account that is designated as the
84             master account for the organization.
85              
86             For more information about ARNs in Organizations, see ARN Formats
87             Supported by Organizations in the I<AWS Organizations User Guide>.
88              
89              
90             =head2 MasterAccountEmail => Str
91              
92             The email address that is associated with the AWS account that is
93             designated as the master account for the organization.
94              
95              
96             =head2 MasterAccountId => Str
97              
98             The unique identifier (ID) of the master account of an organization.
99              
100             The regex pattern for an account ID string requires exactly 12 digits.
101              
102              
103              
104             =head1 SEE ALSO
105              
106             This class forms part of L<Paws>, describing an object used in L<Paws::Organizations>
107              
108             =head1 BUGS and CONTRIBUTIONS
109              
110             The source code is located here: https://github.com/pplu/aws-sdk-perl
111              
112             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
113              
114             =cut
115