« blib/lib/Paws/DAX/DeleteSubnetGroupResponse.pm
↑ Summary
blib/lib/Paws/DAX/DescribeClustersResponse.pm »
| 1 | |||
| 2 | package Paws::DAX::DescribeClusters; | ||
| 3 | use Moose; | ||
| 4 | has ClusterNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeClusters'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DAX::DescribeClustersResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::DAX::DescribeClusters - Arguments for method DescribeClusters on L<Paws::DAX> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeClusters on the | ||
| 24 | L<Amazon DynamoDB Accelerator (DAX)|Paws::DAX> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeClusters. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeClusters. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $dax = Paws->service('DAX'); | ||
| 32 | my $DescribeClustersResponse = $dax->DescribeClusters( | ||
| 33 | ClusterNames => [ 'MyString', ... ], # OPTIONAL | ||
| 34 | MaxResults => 1, # OPTIONAL | ||
| 35 | NextToken => 'MyString', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $Clusters = $DescribeClustersResponse->Clusters; | ||
| 40 | my $NextToken = $DescribeClustersResponse->NextToken; | ||
| 41 | |||
| 42 | # Returns a L<Paws::DAX::DescribeClustersResponse> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dax/DescribeClusters> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 ClusterNames => ArrayRef[Str|Undef] | ||
| 51 | |||
| 52 | The names of the DAX clusters being described. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 MaxResults => Int | ||
| 57 | |||
| 58 | The maximum number of results to include in the response. If more | ||
| 59 | results exist than the specified C<MaxResults> value, a token is | ||
| 60 | included in the response so that the remaining results can be | ||
| 61 | retrieved. | ||
| 62 | |||
| 63 | The value for C<MaxResults> must be between 20 and 100. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 NextToken => Str | ||
| 68 | |||
| 69 | An optional token returned from a prior request. Use this token for | ||
| 70 | pagination of results from this action. If this parameter is specified, | ||
| 71 | the response includes only results beyond the token, up to the value | ||
| 72 | specified by C<MaxResults>. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head1 SEE ALSO | ||
| 78 | |||
| 79 | This class forms part of L<Paws>, documenting arguments for method DescribeClusters in L<Paws::DAX> | ||
| 80 | |||
| 81 | =head1 BUGS and CONTRIBUTIONS | ||
| 82 | |||
| 83 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 84 | |||
| 85 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 86 | |||
| 87 | =cut | ||
| 88 |