File Coverage

blib/lib/Paws/Organizations/ListParents.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

line	stmt	sub	time	code
1
2				package Paws::Organizations::ListParents;
3	1	1	429	use Moose;
	1		4
	1		8
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	1	1	6256	use MooseX::ClassAttribute;
	1		2
	1		9
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 Paws::Organizations
20
21				=head1 DESCRIPTION
22
23				This class represents the parameters used for calling the method ListParents on the
24				AWS 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				As an example:
30
31				$service_obj->ListParents(Att1 => $value1, Att2 => $value2, ...);
32
33				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.
34
35				=head1 ATTRIBUTES
36
37
38				=head2 B<REQUIRED> ChildId => Str
39
40				The unique identifier (ID) of the OU or account whose parent containers
41				you want to list. Do not specify a root.
42
43				The regex pattern for a child ID string requires one of the following:
44
45				=over
46
47				=item *
48
49				Account: a string that consists of exactly 12 digits.
50
51				=item *
52
53				Organizational unit (OU): a string that begins with "ou-" followed by
54				from 4 to 32 lower-case letters or digits (the ID of the root that
55				contains the OU) followed by a second "-" dash and from 8 to 32
56				additional lower-case letters or digits.
57
58				=back
59
60
61
62
63				=head2 MaxResults => Int
64
65				(Optional) Use this to limit the number of results you want included in
66				the response. If you do not include this parameter, it defaults to a
67				value that is specific to the operation. If additional items exist
68				beyond the maximum you specify, the C<NextToken> response element is
69				present and has a value (is not null). Include that value as the
70				C<NextToken> request parameter in the next call to the operation to get
71				the next part of the results. Note that Organizations might return
72				fewer results than the maximum even when there are more results
73				available. You should check C<NextToken> after every operation to
74				ensure that you receive all of the results.
75
76
77
78				=head2 NextToken => Str
79
80				Use this parameter if you receive a C<NextToken> response in a previous
81				request that indicates that there is more output available. Set it to
82				the value of the previous call's C<NextToken> response to indicate
83				where the output should continue from.
84
85
86
87
88				=head1 SEE ALSO
89
90				This class forms part of L<Paws>, documenting arguments for method ListParents in L<Paws::Organizations>
91
92				=head1 BUGS and CONTRIBUTIONS
93
94				The source code is located here: https://github.com/pplu/aws-sdk-perl
95
96				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
97
98				=cut
99