« blib/lib/Paws/Organizations/RemoveAccountFromOrganization.pm
↑ Summary
blib/lib/Paws/Organizations/Tag.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Organizations::Root; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str'); | ||
| 5 | has Id => (is => 'ro', isa => 'Str'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str'); | ||
| 7 | has PolicyTypes => (is => 'ro', isa => 'ArrayRef[Paws::Organizations::PolicyTypeSummary]'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Organizations::Root | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Organizations::Root object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Arn => $value, ..., PolicyTypes => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Organizations::Root object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Arn | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Contains details about a root. A root is a top-level parent node in the | ||
| 40 | hierarchy of an organization that can contain organizational units | ||
| 41 | (OUs) and accounts. The root contains every AWS account in the | ||
| 42 | organization. | ||
| 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 | ||
| 53 | (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) | ||
| 54 | in the I<AWS Service Authorization Reference>. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Id => Str | ||
| 58 | |||
| 59 | The unique identifier (ID) for the root. | ||
| 60 | |||
| 61 | The regex pattern (http://wikipedia.org/wiki/regex) for a root ID | ||
| 62 | string requires "r-" followed by from 4 to 32 lowercase letters or | ||
| 63 | digits. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Name => Str | ||
| 67 | |||
| 68 | The friendly name of the root. | ||
| 69 | |||
| 70 | The regex pattern (http://wikipedia.org/wiki/regex) that is used to | ||
| 71 | validate this parameter is a string of any of the characters in the | ||
| 72 | ASCII character range. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 PolicyTypes => ArrayRef[L<Paws::Organizations::PolicyTypeSummary>] | ||
| 76 | |||
| 77 | The types of policies that are currently enabled for the root and | ||
| 78 | therefore can be attached to the root or to its OUs or accounts. | ||
| 79 | |||
| 80 | Even if a policy type is shown as available in the organization, you | ||
| 81 | can separately enable and disable them at the root level by using | ||
| 82 | EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see | ||
| 83 | the availability of the policy types in that organization. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head1 SEE ALSO | ||
| 88 | |||
| 89 | This class forms part of L<Paws>, describing an object used in L<Paws::Organizations> | ||
| 90 | |||
| 91 | =head1 BUGS and CONTRIBUTIONS | ||
| 92 | |||
| 93 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 94 | |||
| 95 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 96 | |||
| 97 | =cut | ||
| 98 |