blib/lib/Paws/Organizations/ListChildren.pm untested

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