| 1 | |||
| 2 | package Paws::EKS::ListClusters; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListClusters'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/clusters'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EKS::ListClustersResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::EKS::ListClusters - Arguments for method ListClusters on L<Paws::EKS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ListClusters on the | ||
| 24 | L<Amazon Elastic Kubernetes Service|Paws::EKS> service. Use the attributes of this class | ||
| 25 | as arguments to method ListClusters. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListClusters. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $eks = Paws->service('EKS'); | ||
| 32 | # To list your available clusters | ||
| 33 | # This example command lists all of your available clusters in your default | ||
| 34 | # region. | ||
| 35 | my $ListClustersResponse = $eks->ListClusters(); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $clusters = $ListClustersResponse->clusters; | ||
| 39 | |||
| 40 | # Returns a L<Paws::EKS::ListClustersResponse> object. | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/eks/ListClusters> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 MaxResults => Int | ||
| 49 | |||
| 50 | The maximum number of cluster results returned by C<ListClusters> in | ||
| 51 | paginated output. When you use this parameter, C<ListClusters> returns | ||
| 52 | only C<maxResults> results in a single page along with a C<nextToken> | ||
| 53 | response element. You can see the remaining results of the initial | ||
| 54 | request by sending another C<ListClusters> request with the returned | ||
| 55 | C<nextToken> value. This value can be between 1 and 100. If you don't | ||
| 56 | use this parameter, C<ListClusters> returns up to 100 results and a | ||
| 57 | C<nextToken> value if applicable. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 NextToken => Str | ||
| 62 | |||
| 63 | The C<nextToken> value returned from a previous paginated | ||
| 64 | C<ListClusters> request where C<maxResults> was used and the results | ||
| 65 | exceeded the value of that parameter. Pagination continues from the end | ||
| 66 | of the previous results that returned the C<nextToken> value. | ||
| 67 | |||
| 68 | This token should be treated as an opaque identifier that is used only | ||
| 69 | to retrieve the next items in a list and not for other programmatic | ||
| 70 | purposes. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, documenting arguments for method ListClusters in L<Paws::EKS> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |