File Coverage

blib/lib/Paws/ECS/ListTaskDefinitionFamilies.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 bran cond sub pod time code
1              
2             package Paws::ECS::ListTaskDefinitionFamilies;
3 1     1   685 use Moose;
  1         4  
  1         12  
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 1     1   11842 use MooseX::ClassAttribute;
  1         5  
  1         14  
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 Paws::ECS
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method ListTaskDefinitionFamilies on the
25             Amazon EC2 Container Service 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             As an example:
31              
32             $service_obj->ListTaskDefinitionFamilies(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 FamilyPrefix => Str
40              
41             The C<familyPrefix> is a string that is used to filter the results of
42             C<ListTaskDefinitionFamilies>. If you specify a C<familyPrefix>, only
43             task definition family names that begin with the C<familyPrefix> string
44             are returned.
45              
46              
47              
48             =head2 MaxResults => Int
49              
50             The maximum number of task definition family results returned by
51             C<ListTaskDefinitionFamilies> in paginated output. When this parameter
52             is used, C<ListTaskDefinitions> only returns C<maxResults> results in a
53             single page along with a C<nextToken> response element. The remaining
54             results of the initial request can be seen by sending another
55             C<ListTaskDefinitionFamilies> request with the returned C<nextToken>
56             value. This value can be between 1 and 100. If this parameter is not
57             used, then C<ListTaskDefinitionFamilies> returns up to 100 results and
58             a C<nextToken> value if applicable.
59              
60              
61              
62             =head2 NextToken => Str
63              
64             The C<nextToken> value returned from a previous paginated
65             C<ListTaskDefinitionFamilies> request where C<maxResults> was used and
66             the results exceeded the value of that parameter. Pagination continues
67             from the end of the previous results that returned the C<nextToken>
68             value. This value is C<null> when there are no more results to return.
69              
70             This token should be treated as an opaque identifier that is only used
71             to retrieve the next items in a list and not for other programmatic
72             purposes.
73              
74              
75              
76             =head2 Status => Str
77              
78             The task definition family status with which to filter the
79             C<ListTaskDefinitionFamilies> results. By default, both C<ACTIVE> and
80             C<INACTIVE> task definition families are listed. If this parameter is
81             set to C<ACTIVE>, only task definition families that have an C<ACTIVE>
82             task definition revision are returned. If this parameter is set to
83             C<INACTIVE>, only task definition families that do not have any
84             C<ACTIVE> task definition revisions are returned. If you paginate the
85             resulting output, be sure to keep the C<status> value constant in each
86             subsequent request.
87              
88             Valid values are: C<"ACTIVE">, C<"INACTIVE">, C<"ALL">
89              
90              
91             =head1 SEE ALSO
92              
93             This class forms part of L<Paws>, documenting arguments for method ListTaskDefinitionFamilies in L<Paws::ECS>
94              
95             =head1 BUGS and CONTRIBUTIONS
96              
97             The source code is located here: https://github.com/pplu/aws-sdk-perl
98              
99             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
100              
101             =cut
102