« blib/lib/Paws/Organizations/ListOrganizationalUnitsForParentResponse.pm
↑ Summary
blib/lib/Paws/Organizations/ListParentsResponse.pm »
| 1 | |||
| 2 | package Paws::Organizations::ListParents; | ||
| 3 | use Moose; | ||
| 4 | has ChildId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListParents'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Organizations::ListParentsResponse'); | ||
| 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::ListParents - Arguments for method ListParents on L<Paws::Organizations> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ListParents on the | ||
| 24 | L<AWS Organizations|Paws::Organizations> service. Use the attributes of this class | ||
| 25 | as arguments to method ListParents. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListParents. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $organizations = Paws->service('Organizations'); | ||
| 32 | # To retrieve a list of all of the parents of a child OU or account | ||
| 33 | # The following example shows how to list the root or OUs that contain account | ||
| 34 | # 444444444444:/n/n | ||
| 35 | my $ListParentsResponse = | ||
| 36 | $organizations->ListParents( 'ChildId' => 444444444444 ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $Parents = $ListParentsResponse->Parents; | ||
| 40 | |||
| 41 | # Returns a L<Paws::Organizations::ListParentsResponse> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/organizations/ListParents> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> ChildId => Str | ||
| 50 | |||
| 51 | The unique identifier (ID) of the OU or account whose parent containers | ||
| 52 | you want to list. Don't specify a root. | ||
| 53 | |||
| 54 | The regex pattern (http://wikipedia.org/wiki/regex) for a child ID | ||
| 55 | string requires one of the following: | ||
| 56 | |||
| 57 | =over | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | B<Account> - A string that consists of exactly 12 digits. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | B<Organizational unit (OU)> - A string that begins with "ou-" followed | ||
| 66 | by from 4 to 32 lowercase letters or digits (the ID of the root that | ||
| 67 | contains the OU). This string is followed by a second "-" dash and from | ||
| 68 | 8 to 32 additional lowercase letters or digits. | ||
| 69 | |||
| 70 | =back | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 MaxResults => Int | ||
| 76 | |||
| 77 | The total number of results that you want included on each page of the | ||
| 78 | response. If you do not include this parameter, it defaults to a value | ||
| 79 | that is specific to the operation. If additional items exist beyond the | ||
| 80 | maximum you specify, the C<NextToken> response element is present and | ||
| 81 | has a value (is not null). Include that value as the C<NextToken> | ||
| 82 | request parameter in the next call to the operation to get the next | ||
| 83 | part of the results. Note that Organizations might return fewer results | ||
| 84 | than the maximum even when there are more results available. You should | ||
| 85 | check C<NextToken> after every operation to ensure that you receive all | ||
| 86 | of the results. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 NextToken => Str | ||
| 91 | |||
| 92 | The parameter for receiving additional results if you receive a | ||
| 93 | C<NextToken> response in a previous request. A C<NextToken> response | ||
| 94 | indicates that more output is available. Set this parameter to the | ||
| 95 | value of the previous call's C<NextToken> response to indicate where | ||
| 96 | the output should continue from. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method ListParents in L<Paws::Organizations> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |