File Coverage

blib/lib/Paws/ECS/ListTaskDefinitions.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::ListTaskDefinitions;
3 1     1   304 use Moose;
  1         3  
  1         6  
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 Sort => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sort' );
8             has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status' );
9              
10 1     1   5406 use MooseX::ClassAttribute;
  1         2  
  1         7  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListTaskDefinitions');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::ListTaskDefinitionsResponse');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::ECS::ListTaskDefinitions - Arguments for method ListTaskDefinitions on Paws::ECS
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method ListTaskDefinitions on the
26             Amazon EC2 Container Service service. Use the attributes of this class
27             as arguments to method ListTaskDefinitions.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTaskDefinitions.
30              
31             As an example:
32              
33             $service_obj->ListTaskDefinitions(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 FamilyPrefix => Str
41              
42             The full family name with which to filter the C<ListTaskDefinitions>
43             results. Specifying a C<familyPrefix> limits the listed task
44             definitions to task definition revisions that belong to that family.
45              
46              
47              
48             =head2 MaxResults => Int
49              
50             The maximum number of task definition results returned by
51             C<ListTaskDefinitions> in paginated output. When this parameter is
52             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<ListTaskDefinitions> request with the returned C<nextToken> value.
56             This value can be between 1 and 100. If this parameter is not used,
57             then C<ListTaskDefinitions> returns up to 100 results and a
58             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<ListTaskDefinitions> request where C<maxResults> was used and the
66             results exceeded the value of that parameter. Pagination continues from
67             the end of the previous results that returned the C<nextToken> value.
68             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 Sort => Str
77              
78             The order in which to sort the results. Valid values are C<ASC> and
79             C<DESC>. By default (C<ASC>), task definitions are listed
80             lexicographically by family name and in ascending numerical order by
81             revision so that the newest task definitions in a family are listed
82             last. Setting this parameter to C<DESC> reverses the sort order on
83             family name and revision so that the newest task definitions in a
84             family are listed first.
85              
86             Valid values are: C<"ASC">, C<"DESC">
87              
88             =head2 Status => Str
89              
90             The task definition status with which to filter the
91             C<ListTaskDefinitions> results. By default, only C<ACTIVE> task
92             definitions are listed. By setting this parameter to C<INACTIVE>, you
93             can view task definitions that are C<INACTIVE> as long as an active
94             task or service still references them. If you paginate the resulting
95             output, be sure to keep the C<status> value constant in each subsequent
96             request.
97              
98             Valid values are: C<"ACTIVE">, C<"INACTIVE">
99              
100              
101             =head1 SEE ALSO
102              
103             This class forms part of L<Paws>, documenting arguments for method ListTaskDefinitions in L<Paws::ECS>
104              
105             =head1 BUGS and CONTRIBUTIONS
106              
107             The source code is located here: https://github.com/pplu/aws-sdk-perl
108              
109             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
110              
111             =cut
112