File Coverage

blib/lib/Paws/ECS/ListContainerInstances.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::ListContainerInstances;
3 1     1   780 use Moose;
  1         5  
  1         14  
4             has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' );
5             has Filter => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filter' );
6             has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' );
7             has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
8             has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status' );
9              
10 1     1   8468 use MooseX::ClassAttribute;
  1         5  
  1         14  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListContainerInstances');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::ListContainerInstancesResponse');
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::ListContainerInstances - Arguments for method ListContainerInstances on Paws::ECS
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method ListContainerInstances on the
26             Amazon EC2 Container Service service. Use the attributes of this class
27             as arguments to method ListContainerInstances.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListContainerInstances.
30              
31             As an example:
32              
33             $service_obj->ListContainerInstances(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 Cluster => Str
41              
42             The short name or full Amazon Resource Name (ARN) of the cluster that
43             hosts the container instances to list. If you do not specify a cluster,
44             the default cluster is assumed.
45              
46              
47              
48             =head2 Filter => Str
49              
50             You can filter the results of a C<ListContainerInstances> operation
51             with cluster query language statements. For more information, see
52             Cluster Query Language in the I<Amazon EC2 Container Service Developer
53             Guide>.
54              
55              
56              
57             =head2 MaxResults => Int
58              
59             The maximum number of container instance results returned by
60             C<ListContainerInstances> in paginated output. When this parameter is
61             used, C<ListContainerInstances> only returns C<maxResults> results in a
62             single page along with a C<nextToken> response element. The remaining
63             results of the initial request can be seen by sending another
64             C<ListContainerInstances> request with the returned C<nextToken> value.
65             This value can be between 1 and 100. If this parameter is not used,
66             then C<ListContainerInstances> returns up to 100 results and a
67             C<nextToken> value if applicable.
68              
69              
70              
71             =head2 NextToken => Str
72              
73             The C<nextToken> value returned from a previous paginated
74             C<ListContainerInstances> request where C<maxResults> was used and the
75             results exceeded the value of that parameter. Pagination continues from
76             the end of the previous results that returned the C<nextToken> value.
77             This value is C<null> when there are no more results to return.
78              
79             This token should be treated as an opaque identifier that is only used
80             to retrieve the next items in a list and not for other programmatic
81             purposes.
82              
83              
84              
85             =head2 Status => Str
86              
87             Filters the container instances by status. For example, if you specify
88             the C<DRAINING> status, the results include only container instances
89             that have been set to C<DRAINING> using UpdateContainerInstancesState.
90             If you do not specify this parameter, the default is to include
91             container instances set to C<ACTIVE> and C<DRAINING>.
92              
93             Valid values are: C<"ACTIVE">, C<"DRAINING">
94              
95              
96             =head1 SEE ALSO
97              
98             This class forms part of L<Paws>, documenting arguments for method ListContainerInstances in L<Paws::ECS>
99              
100             =head1 BUGS and CONTRIBUTIONS
101              
102             The source code is located here: https://github.com/pplu/aws-sdk-perl
103              
104             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
105              
106             =cut
107