File Coverage

blib/lib/Paws/Organizations/Root.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::Root;
2 1     1   303 use Moose;
  1         2  
  1         5  
3             has Arn => (is => 'ro', isa => 'Str');
4             has Id => (is => 'ro', isa => 'Str');
5             has Name => (is => 'ro', isa => 'Str');
6             has PolicyTypes => (is => 'ro', isa => 'ArrayRef[Paws::Organizations::PolicyTypeSummary]');
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::Organizations::Root
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::Organizations::Root object:
25              
26             $service_obj->Method(Att1 => { Arn => $value, ..., PolicyTypes => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::Organizations::Root object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->Arn
34              
35             =head1 DESCRIPTION
36              
37             Contains details about a root. A root is a top-level parent node in the
38             hierarchy of an organization that can contain organizational units
39             (OUs) and accounts. Every root contains every AWS account in the
40             organization. Each root enables the accounts to be organized in a
41             different way and to have different policy types enabled for use in
42             that root.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 Arn => Str
48              
49             The Amazon Resource Name (ARN) of the root.
50              
51             For more information about ARNs in Organizations, see ARN Formats
52             Supported by Organizations in the I<AWS Organizations User Guide>.
53              
54              
55             =head2 Id => Str
56              
57             The unique identifier (ID) for the root.
58              
59             The regex pattern for a root ID string requires "r-" followed by from 4
60             to 32 lower-case letters or digits.
61              
62              
63             =head2 Name => Str
64              
65             The friendly name of the root.
66              
67             The regex pattern that is used to validate this parameter is a string
68             of any of the characters in the ASCII character range.
69              
70              
71             =head2 PolicyTypes => ArrayRef[L<Paws::Organizations::PolicyTypeSummary>]
72              
73             The types of policies that are currently enabled for the root and
74             therefore can be attached to the root or to its OUs or accounts.
75              
76              
77              
78             =head1 SEE ALSO
79              
80             This class forms part of L<Paws>, describing an object used in L<Paws::Organizations>
81              
82             =head1 BUGS and CONTRIBUTIONS
83              
84             The source code is located here: https://github.com/pplu/aws-sdk-perl
85              
86             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
87              
88             =cut
89