blib/lib/Paws/ECS/ListTaskDefinitionFamilies.pm untested

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::ECS::ListTaskDefinitionFamilies;
3 use Moose;
4 has FamilyPrefix => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'familyPrefix' );
5 has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' );
6 has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
7 has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status' );
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListTaskDefinitionFamilies');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::ListTaskDefinitionFamiliesResponse');
13 class_has _result_key => (isa => 'Str', is => 'ro');
14 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::ECS::ListTaskDefinitionFamilies - Arguments for method ListTaskDefinitionFamilies on L<Paws::ECS>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method ListTaskDefinitionFamilies on the
25 L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class
26 as arguments to method ListTaskDefinitionFamilies.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTaskDefinitionFamilies.
29  
30 =head1 SYNOPSIS
31  
32 my $ecs = Paws->service('ECS');
33 # To list your registered task definition families
34 # This example lists all of your registered task definition families.
35 my $ListTaskDefinitionFamiliesResponse = $ecs->ListTaskDefinitionFamilies();
36  
37 # Results:
38 my $families = $ListTaskDefinitionFamiliesResponse->families;
39  
40 # Returns a L<Paws::ECS::ListTaskDefinitionFamiliesResponse> object.
41 # To filter your registered task definition families
42 # This example lists the task definition revisions that start with "hpcc".
43 my $ListTaskDefinitionFamiliesResponse =
44 $ecs->ListTaskDefinitionFamilies( 'FamilyPrefix' => 'hpcc' );
45  
46 # Results:
47 my $families = $ListTaskDefinitionFamiliesResponse->families;
48  
49 # Returns a L<Paws::ECS::ListTaskDefinitionFamiliesResponse> object.
50  
51 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.
52 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/ListTaskDefinitionFamilies>
53  
54 =head1 ATTRIBUTES
55  
56  
57 =head2 FamilyPrefix => Str
58  
59 The C<familyPrefix> is a string that is used to filter the results of
60 C<ListTaskDefinitionFamilies>. If you specify a C<familyPrefix>, only
61 task definition family names that begin with the C<familyPrefix> string
62 are returned.
63  
64  
65  
66 =head2 MaxResults => Int
67  
68 The maximum number of task definition family results returned by
69 C<ListTaskDefinitionFamilies> in paginated output. When this parameter
70 is used, C<ListTaskDefinitions> only returns C<maxResults> results in a
71 single page along with a C<nextToken> response element. The remaining
72 results of the initial request can be seen by sending another
73 C<ListTaskDefinitionFamilies> request with the returned C<nextToken>
74 value. This value can be between 1 and 100. If this parameter is not
75 used, then C<ListTaskDefinitionFamilies> returns up to 100 results and
76 a C<nextToken> value if applicable.
77  
78  
79  
80 =head2 NextToken => Str
81  
82 The C<nextToken> value returned from a C<ListTaskDefinitionFamilies>
83 request indicating that more results are available to fulfill the
84 request and further calls will be needed. If C<maxResults> was
85 provided, it is possible the number of results to be fewer than
86 C<maxResults>.
87  
88 This token should be treated as an opaque identifier that is only used
89 to retrieve the next items in a list and not for other programmatic
90 purposes.
91  
92  
93  
94 =head2 Status => Str
95  
96 The task definition family status with which to filter the
97 C<ListTaskDefinitionFamilies> results. By default, both C<ACTIVE> and
98 C<INACTIVE> task definition families are listed. If this parameter is
99 set to C<ACTIVE>, only task definition families that have an C<ACTIVE>
100 task definition revision are returned. If this parameter is set to
101 C<INACTIVE>, only task definition families that do not have any
102 C<ACTIVE> task definition revisions are returned. If you paginate the
103 resulting output, be sure to keep the C<status> value constant in each
104 subsequent request.
105  
106 Valid values are: C<"ACTIVE">, C<"INACTIVE">, C<"ALL">
107  
108  
109 =head1 SEE ALSO
110  
111 This class forms part of L<Paws>, documenting arguments for method ListTaskDefinitionFamilies in L<Paws::ECS>
112  
113 =head1 BUGS and CONTRIBUTIONS
114  
115 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
116  
117 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
118  
119 =cut
120