| 1 | |||
| 2 | package Paws::ECS::ListClusters; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::ECS> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method ListClusters on the | ||
| 23 | L<Amazon EC2 Container Service|Paws::ECS> 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 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $ecs = Paws->service('ECS'); | ||
| 31 | # To list your available clusters | ||
| 32 | # This example lists all of your available clusters in your default region. | ||
| 33 | my $ListClustersResponse = $ecs->ListClusters(); | ||
| 34 | |||
| 35 | # Results: | ||
| 36 | my $clusterArns = $ListClustersResponse->clusterArns; | ||
| 37 | |||
| 38 | # Returns a L<Paws::ECS::ListClustersResponse> object. | ||
| 39 | |||
| 40 | 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. | ||
| 41 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/ListClusters> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 MaxResults => Int | ||
| 47 | |||
| 48 | The maximum number of cluster results returned by C<ListClusters> in | ||
| 49 | paginated output. When this parameter is used, C<ListClusters> only | ||
| 50 | returns C<maxResults> results in a single page along with a | ||
| 51 | C<nextToken> response element. The remaining results of the initial | ||
| 52 | request can be seen by sending another C<ListClusters> request with the | ||
| 53 | returned C<nextToken> value. This value can be between 1 and 100. If | ||
| 54 | this parameter is not used, then C<ListClusters> returns up to 100 | ||
| 55 | results and a C<nextToken> value if applicable. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 NextToken => Str | ||
| 60 | |||
| 61 | The C<nextToken> value returned from a C<ListClusters> request | ||
| 62 | indicating that more results are available to fulfill the request and | ||
| 63 | further calls will be needed. If C<maxResults> was provided, it is | ||
| 64 | possible the number of results to be fewer than C<maxResults>. | ||
| 65 | |||
| 66 | This token should be treated as an opaque identifier that is only used | ||
| 67 | to retrieve the next items in a list and not for other programmatic | ||
| 68 | purposes. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head1 SEE ALSO | ||
| 74 | |||
| 75 | This class forms part of L<Paws>, documenting arguments for method ListClusters in L<Paws::ECS> | ||
| 76 | |||
| 77 | =head1 BUGS and CONTRIBUTIONS | ||
| 78 | |||
| 79 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 80 | |||
| 81 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 82 | |||
| 83 | =cut | ||
| 84 |