« blib/lib/Paws/CostExplorer/GetReservationCoverageResponse.pm
↑ Summary
blib/lib/Paws/CostExplorer/GetReservationPurchaseRecommendationResponse.pm »
| 1 | |||
| 2 | package Paws::CostExplorer::GetReservationPurchaseRecommendation; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str'); | ||
| 5 | has AccountScope => (is => 'ro', isa => 'Str'); | ||
| 6 | has Filter => (is => 'ro', isa => 'Paws::CostExplorer::Expression'); | ||
| 7 | has LookbackPeriodInDays => (is => 'ro', isa => 'Str'); | ||
| 8 | has NextPageToken => (is => 'ro', isa => 'Str'); | ||
| 9 | has PageSize => (is => 'ro', isa => 'Int'); | ||
| 10 | has PaymentOption => (is => 'ro', isa => 'Str'); | ||
| 11 | has Service => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has ServiceSpecification => (is => 'ro', isa => 'Paws::CostExplorer::ServiceSpecification'); | ||
| 13 | has TermInYears => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetReservationPurchaseRecommendation'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CostExplorer::GetReservationPurchaseRecommendationResponse'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::CostExplorer::GetReservationPurchaseRecommendation - Arguments for method GetReservationPurchaseRecommendation on L<Paws::CostExplorer> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method GetReservationPurchaseRecommendation on the | ||
| 31 | L<AWS Cost Explorer Service|Paws::CostExplorer> service. Use the attributes of this class | ||
| 32 | as arguments to method GetReservationPurchaseRecommendation. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetReservationPurchaseRecommendation. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $ce = Paws->service('CostExplorer'); | ||
| 39 | my $GetReservationPurchaseRecommendationResponse = | ||
| 40 | $ce->GetReservationPurchaseRecommendation( | ||
| 41 | Service => 'MyGenericString', | ||
| 42 | AccountId => 'MyGenericString', # OPTIONAL | ||
| 43 | AccountScope => 'PAYER', # OPTIONAL | ||
| 44 | Filter => { | ||
| 45 | And => [ <Expression>, ... ], # OPTIONAL | ||
| 46 | CostCategories => { | ||
| 47 | Key => 'MyCostCategoryName', # min: 1, max: 50; OPTIONAL | ||
| 48 | MatchOptions => [ | ||
| 49 | 'EQUALS', | ||
| 50 | ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE | ||
| 51 | ], # OPTIONAL | ||
| 52 | Values => [ | ||
| 53 | 'MyValue', ... # max: 1024 | ||
| 54 | ], # OPTIONAL | ||
| 55 | }, # OPTIONAL | ||
| 56 | Dimensions => { | ||
| 57 | Key => 'AZ' | ||
| 58 | , # values: AZ, INSTANCE_TYPE, LINKED_ACCOUNT, LINKED_ACCOUNT_NAME, OPERATION, PURCHASE_TYPE, REGION, SERVICE, SERVICE_CODE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, OPERATING_SYSTEM, TENANCY, SCOPE, PLATFORM, SUBSCRIPTION_ID, LEGAL_ENTITY_NAME, DEPLOYMENT_OPTION, DATABASE_ENGINE, CACHE_ENGINE, INSTANCE_TYPE_FAMILY, BILLING_ENTITY, RESERVATION_ID, RESOURCE_ID, RIGHTSIZING_TYPE, SAVINGS_PLANS_TYPE, SAVINGS_PLAN_ARN, PAYMENT_OPTION, AGREEMENT_END_DATE_TIME_AFTER, AGREEMENT_END_DATE_TIME_BEFORE; OPTIONAL | ||
| 59 | MatchOptions => [ | ||
| 60 | 'EQUALS', | ||
| 61 | ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE | ||
| 62 | ], # OPTIONAL | ||
| 63 | Values => [ | ||
| 64 | 'MyValue', ... # max: 1024 | ||
| 65 | ], # OPTIONAL | ||
| 66 | }, # OPTIONAL | ||
| 67 | Not => <Expression>, | ||
| 68 | Or => [ <Expression>, ... ], # OPTIONAL | ||
| 69 | Tags => { | ||
| 70 | Key => 'MyTagKey', # max: 1024; OPTIONAL | ||
| 71 | MatchOptions => [ | ||
| 72 | 'EQUALS', | ||
| 73 | ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE | ||
| 74 | ], # OPTIONAL | ||
| 75 | Values => [ | ||
| 76 | 'MyValue', ... # max: 1024 | ||
| 77 | ], # OPTIONAL | ||
| 78 | }, # OPTIONAL | ||
| 79 | }, # OPTIONAL | ||
| 80 | LookbackPeriodInDays => 'SEVEN_DAYS', # OPTIONAL | ||
| 81 | NextPageToken => 'MyNextPageToken', # OPTIONAL | ||
| 82 | PageSize => 1, # OPTIONAL | ||
| 83 | PaymentOption => 'NO_UPFRONT', # OPTIONAL | ||
| 84 | ServiceSpecification => { | ||
| 85 | EC2Specification => { | ||
| 86 | OfferingClass => 'STANDARD', # values: STANDARD, CONVERTIBLE; OPTIONAL | ||
| 87 | }, # OPTIONAL | ||
| 88 | }, # OPTIONAL | ||
| 89 | TermInYears => 'ONE_YEAR', # OPTIONAL | ||
| 90 | ); | ||
| 91 | |||
| 92 | # Results: | ||
| 93 | my $Metadata = $GetReservationPurchaseRecommendationResponse->Metadata; | ||
| 94 | my $NextPageToken = | ||
| 95 | $GetReservationPurchaseRecommendationResponse->NextPageToken; | ||
| 96 | my $Recommendations = | ||
| 97 | $GetReservationPurchaseRecommendationResponse->Recommendations; | ||
| 98 | |||
| 99 | # Returns a L<Paws::CostExplorer::GetReservationPurchaseRecommendationResponse> object. | ||
| 100 | |||
| 101 | 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. | ||
| 102 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ce/GetReservationPurchaseRecommendation> | ||
| 103 | |||
| 104 | =head1 ATTRIBUTES | ||
| 105 | |||
| 106 | |||
| 107 | =head2 AccountId => Str | ||
| 108 | |||
| 109 | The account ID that is associated with the recommendation. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 AccountScope => Str | ||
| 114 | |||
| 115 | The account scope that you want your recommendations for. Amazon Web | ||
| 116 | Services calculates recommendations including the management account | ||
| 117 | and member accounts if the value is set to C<PAYER>. If the value is | ||
| 118 | C<LINKED>, recommendations are calculated for individual member | ||
| 119 | accounts only. | ||
| 120 | |||
| 121 | Valid values are: C<"PAYER">, C<"LINKED"> | ||
| 122 | |||
| 123 | =head2 Filter => L<Paws::CostExplorer::Expression> | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 LookbackPeriodInDays => Str | ||
| 130 | |||
| 131 | The number of previous days that you want AWS to consider when it | ||
| 132 | calculates your recommendations. | ||
| 133 | |||
| 134 | Valid values are: C<"SEVEN_DAYS">, C<"THIRTY_DAYS">, C<"SIXTY_DAYS"> | ||
| 135 | |||
| 136 | =head2 NextPageToken => Str | ||
| 137 | |||
| 138 | The pagination token that indicates the next set of results that you | ||
| 139 | want to retrieve. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 PageSize => Int | ||
| 144 | |||
| 145 | The number of recommendations that you want returned in a single | ||
| 146 | response object. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 PaymentOption => Str | ||
| 151 | |||
| 152 | The reservation purchase option that you want recommendations for. | ||
| 153 | |||
| 154 | Valid values are: C<"NO_UPFRONT">, C<"PARTIAL_UPFRONT">, C<"ALL_UPFRONT">, C<"LIGHT_UTILIZATION">, C<"MEDIUM_UTILIZATION">, C<"HEAVY_UTILIZATION"> | ||
| 155 | |||
| 156 | =head2 B<REQUIRED> Service => Str | ||
| 157 | |||
| 158 | The specific service that you want recommendations for. | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head2 ServiceSpecification => L<Paws::CostExplorer::ServiceSpecification> | ||
| 163 | |||
| 164 | The hardware specifications for the service instances that you want | ||
| 165 | recommendations for, such as standard or convertible Amazon EC2 | ||
| 166 | instances. | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 TermInYears => Str | ||
| 171 | |||
| 172 | The reservation term that you want recommendations for. | ||
| 173 | |||
| 174 | Valid values are: C<"ONE_YEAR">, C<"THREE_YEARS"> | ||
| 175 | |||
| 176 | |||
| 177 | =head1 SEE ALSO | ||
| 178 | |||
| 179 | This class forms part of L<Paws>, documenting arguments for method GetReservationPurchaseRecommendation in L<Paws::CostExplorer> | ||
| 180 | |||
| 181 | =head1 BUGS and CONTRIBUTIONS | ||
| 182 | |||
| 183 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 184 | |||
| 185 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 186 | |||
| 187 | =cut | ||
| 188 |