« blib/lib/Paws/EKS/ListIdentityProviderConfigsResponse.pm
↑ Summary
blib/lib/Paws/EKS/ListNodegroupsResponse.pm »
| 1 | |||
| 2 | package Paws::EKS::ListNodegroups; | ||
| 3 | use Moose; | ||
| 4 | has ClusterName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListNodegroups'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/clusters/{name}/node-groups'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EKS::ListNodegroupsResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::EKS::ListNodegroups - Arguments for method ListNodegroups on L<Paws::EKS> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ListNodegroups on the | ||
| 25 | L<Amazon Elastic Kubernetes Service|Paws::EKS> service. Use the attributes of this class | ||
| 26 | as arguments to method ListNodegroups. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListNodegroups. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $eks = Paws->service('EKS'); | ||
| 33 | my $ListNodegroupsResponse = $eks->ListNodegroups( | ||
| 34 | ClusterName => 'MyString', | ||
| 35 | MaxResults => 1, # OPTIONAL | ||
| 36 | NextToken => 'MyString', # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $NextToken = $ListNodegroupsResponse->NextToken; | ||
| 41 | my $Nodegroups = $ListNodegroupsResponse->Nodegroups; | ||
| 42 | |||
| 43 | # Returns a L<Paws::EKS::ListNodegroupsResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/eks/ListNodegroups> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> ClusterName => Str | ||
| 52 | |||
| 53 | The name of the Amazon EKS cluster that you would like to list node | ||
| 54 | groups in. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 MaxResults => Int | ||
| 59 | |||
| 60 | The maximum number of node group results returned by C<ListNodegroups> | ||
| 61 | in paginated output. When you use this parameter, C<ListNodegroups> | ||
| 62 | returns only C<maxResults> results in a single page along with a | ||
| 63 | C<nextToken> response element. You can see the remaining results of the | ||
| 64 | initial request by sending another C<ListNodegroups> request with the | ||
| 65 | returned C<nextToken> value. This value can be between 1 and 100. If | ||
| 66 | you don't use this parameter, C<ListNodegroups> returns up to 100 | ||
| 67 | results and a 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<ListNodegroups> request where C<maxResults> was used and the results | ||
| 75 | exceeded the value of that parameter. Pagination continues from the end | ||
| 76 | of the previous results that returned the C<nextToken> value. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method ListNodegroups in L<Paws::EKS> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |