File Coverage

blib/lib/Paws/ECS/ListClusters.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::ListClusters;
3 1     1   564 use Moose;
  1         2  
  1         8  
4             has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' );
5             has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
6              
7 1     1   7210 use MooseX::ClassAttribute;
  1         2  
  1         9  
8              
9             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListClusters');
10             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::ListClustersResponse');
11             class_has _result_key => (isa => 'Str', is => 'ro');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::ECS::ListClusters - Arguments for method ListClusters on Paws::ECS
19              
20             =head1 DESCRIPTION
21              
22             This class represents the parameters used for calling the method ListClusters on the
23             Amazon EC2 Container Service service. Use the attributes of this class
24             as arguments to method ListClusters.
25              
26             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListClusters.
27              
28             As an example:
29              
30             $service_obj->ListClusters(Att1 => $value1, Att2 => $value2, ...);
31              
32             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.
33              
34             =head1 ATTRIBUTES
35              
36              
37             =head2 MaxResults => Int
38              
39             The maximum number of cluster results returned by C<ListClusters> in
40             paginated output. When this parameter is used, C<ListClusters> only
41             returns C<maxResults> results in a single page along with a
42             C<nextToken> response element. The remaining results of the initial
43             request can be seen by sending another C<ListClusters> request with the
44             returned C<nextToken> value. This value can be between 1 and 100. If
45             this parameter is not used, then C<ListClusters> returns up to 100
46             results and a C<nextToken> value if applicable.
47              
48              
49              
50             =head2 NextToken => Str
51              
52             The C<nextToken> value returned from a previous paginated
53             C<ListClusters> request where C<maxResults> was used and the results
54             exceeded the value of that parameter. Pagination continues from the end
55             of the previous results that returned the C<nextToken> value. This
56             value is C<null> when there are no more results to return.
57              
58             This token should be treated as an opaque identifier that is only used
59             to retrieve the next items in a list and not for other programmatic
60             purposes.
61              
62              
63              
64              
65             =head1 SEE ALSO
66              
67             This class forms part of L<Paws>, documenting arguments for method ListClusters in L<Paws::ECS>
68              
69             =head1 BUGS and CONTRIBUTIONS
70              
71             The source code is located here: https://github.com/pplu/aws-sdk-perl
72              
73             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
74              
75             =cut
76