« blib/lib/Paws/Organizations/CreateOrganizationResponse.pm
↑ Summary
blib/lib/Paws/Organizations/CreateOrganizationalUnitResponse.pm »
| 1 | |||
| 2 | package Paws::Organizations::CreateOrganizationalUnit; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ParentId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Organizations::Tag]'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateOrganizationalUnit'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Organizations::CreateOrganizationalUnitResponse'); | ||
| 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::CreateOrganizationalUnit - Arguments for method CreateOrganizationalUnit on L<Paws::Organizations> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreateOrganizationalUnit on the | ||
| 24 | L<AWS Organizations|Paws::Organizations> service. Use the attributes of this class | ||
| 25 | as arguments to method CreateOrganizationalUnit. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateOrganizationalUnit. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $organizations = Paws->service('Organizations'); | ||
| 32 | # To create a new organization unit | ||
| 33 | # The following example shows how to create an OU that is named AccountingOU. | ||
| 34 | # The new OU is directly under the root.: | ||
| 35 | |||
| 36 | my $CreateOrganizationalUnitResponse = | ||
| 37 | $organizations->CreateOrganizationalUnit( | ||
| 38 | 'Name' => 'AccountingOU', | ||
| 39 | 'ParentId' => 'r-examplerootid111' | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $OrganizationalUnit = | ||
| 44 | $CreateOrganizationalUnitResponse->OrganizationalUnit; | ||
| 45 | |||
| 46 | # Returns a L<Paws::Organizations::CreateOrganizationalUnitResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/organizations/CreateOrganizationalUnit> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> Name => Str | ||
| 55 | |||
| 56 | The friendly name to assign to the new OU. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> ParentId => Str | ||
| 61 | |||
| 62 | The unique identifier (ID) of the parent root or OU that you want to | ||
| 63 | create the new OU in. | ||
| 64 | |||
| 65 | The regex pattern (http://wikipedia.org/wiki/regex) for a parent ID | ||
| 66 | string requires one of the following: | ||
| 67 | |||
| 68 | =over | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | B<Root> - A string that begins with "r-" followed by from 4 to 32 | ||
| 73 | lowercase letters or digits. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | B<Organizational unit (OU)> - A string that begins with "ou-" followed | ||
| 78 | by from 4 to 32 lowercase letters or digits (the ID of the root that | ||
| 79 | the OU is in). This string is followed by a second "-" dash and from 8 | ||
| 80 | to 32 additional lowercase letters or digits. | ||
| 81 | |||
| 82 | =back | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 Tags => ArrayRef[L<Paws::Organizations::Tag>] | ||
| 88 | |||
| 89 | A list of tags that you want to attach to the newly created OU. For | ||
| 90 | each tag in the list, you must specify both a tag key and a value. You | ||
| 91 | can set the value to an empty string, but you can't set it to C<null>. | ||
| 92 | For more information about tagging, see Tagging AWS Organizations | ||
| 93 | resources | ||
| 94 | (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) | ||
| 95 | in the AWS Organizations User Guide. | ||
| 96 | |||
| 97 | If any one of the tags is invalid or if you exceed the allowed number | ||
| 98 | of tags for an OU, then the entire request fails and the OU is not | ||
| 99 | created. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head1 SEE ALSO | ||
| 105 | |||
| 106 | This class forms part of L<Paws>, documenting arguments for method CreateOrganizationalUnit in L<Paws::Organizations> | ||
| 107 | |||
| 108 | =head1 BUGS and CONTRIBUTIONS | ||
| 109 | |||
| 110 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 111 | |||
| 112 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 113 | |||
| 114 | =cut | ||
| 115 |