« blib/lib/Paws/SavingsPlans/DescribeSavingsPlanRatesResponse.pm
↑ Summary
blib/lib/Paws/SavingsPlans/DescribeSavingsPlansOfferingRates.pm »
| 1 | |||
| 2 | package Paws::SavingsPlans::DescribeSavingsPlans; | ||
| 3 | use Moose; | ||
| 4 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::SavingsPlans::SavingsPlanFilter]', traits => ['NameInRequest'], request_name => 'filters'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 7 | has SavingsPlanArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'savingsPlanArns'); | ||
| 8 | has SavingsPlanIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'savingsPlanIds'); | ||
| 9 | has States => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'states'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSavingsPlans'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/DescribeSavingsPlans'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SavingsPlans::DescribeSavingsPlansResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::SavingsPlans::DescribeSavingsPlans - Arguments for method DescribeSavingsPlans on L<Paws::SavingsPlans> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method DescribeSavingsPlans on the | ||
| 28 | L<AWS Savings Plans|Paws::SavingsPlans> service. Use the attributes of this class | ||
| 29 | as arguments to method DescribeSavingsPlans. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSavingsPlans. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $savingsplans = Paws->service('SavingsPlans'); | ||
| 36 | my $DescribeSavingsPlansResponse = $savingsplans->DescribeSavingsPlans( | ||
| 37 | Filters => [ | ||
| 38 | { | ||
| 39 | Name => 'region' | ||
| 40 | , # values: region, ec2-instance-family, commitment, upfront, term, savings-plan-type, payment-option, start, end; OPTIONAL | ||
| 41 | Values => [ 'MyString', ... ], # OPTIONAL | ||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # OPTIONAL | ||
| 45 | MaxResults => 1, # OPTIONAL | ||
| 46 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 47 | SavingsPlanArns => [ 'MySavingsPlanArn', ... ], # OPTIONAL | ||
| 48 | SavingsPlanIds => [ 'MySavingsPlanId', ... ], # OPTIONAL | ||
| 49 | States => [ | ||
| 50 | 'payment-pending', | ||
| 51 | ... # values: payment-pending, payment-failed, active, retired, queued, queued-deleted | ||
| 52 | ], # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $NextToken = $DescribeSavingsPlansResponse->NextToken; | ||
| 57 | my $SavingsPlans = $DescribeSavingsPlansResponse->SavingsPlans; | ||
| 58 | |||
| 59 | # Returns a L<Paws::SavingsPlans::DescribeSavingsPlansResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/savingsplans/DescribeSavingsPlans> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 Filters => ArrayRef[L<Paws::SavingsPlans::SavingsPlanFilter>] | ||
| 68 | |||
| 69 | The filters. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 MaxResults => Int | ||
| 74 | |||
| 75 | The maximum number of results to return with a single call. To retrieve | ||
| 76 | additional results, make another call with the returned token value. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 NextToken => Str | ||
| 81 | |||
| 82 | The token for the next page of results. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 SavingsPlanArns => ArrayRef[Str|Undef] | ||
| 87 | |||
| 88 | The Amazon Resource Names (ARN) of the Savings Plans. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 SavingsPlanIds => ArrayRef[Str|Undef] | ||
| 93 | |||
| 94 | The IDs of the Savings Plans. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 States => ArrayRef[Str|Undef] | ||
| 99 | |||
| 100 | The states. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head1 SEE ALSO | ||
| 106 | |||
| 107 | This class forms part of L<Paws>, documenting arguments for method DescribeSavingsPlans in L<Paws::SavingsPlans> | ||
| 108 | |||
| 109 | =head1 BUGS and CONTRIBUTIONS | ||
| 110 | |||
| 111 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 112 | |||
| 113 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 114 | |||
| 115 | =cut | ||
| 116 |