package Paws::CostExplorer::GetUsageForecast; use Moose; has Filter => (is => 'ro', isa => 'Paws::CostExplorer::Expression'); has Granularity => (is => 'ro', isa => 'Str', required => 1); has Metric => (is => 'ro', isa => 'Str', required => 1); has PredictionIntervalLevel => (is => 'ro', isa => 'Int'); has TimePeriod => (is => 'ro', isa => 'Paws::CostExplorer::DateInterval', required => 1); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetUsageForecast'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CostExplorer::GetUsageForecastResponse'); class_has _result_key => (isa => 'Str', is => 'ro'); 1; ### main pod documentation begin ### =head1 NAME Paws::CostExplorer::GetUsageForecast - Arguments for method GetUsageForecast on L =head1 DESCRIPTION This class represents the parameters used for calling the method GetUsageForecast on the L service. Use the attributes of this class as arguments to method GetUsageForecast. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetUsageForecast. =head1 SYNOPSIS my $ce = Paws->service('CostExplorer'); my $GetUsageForecastResponse = $ce->GetUsageForecast( Granularity => 'DAILY', Metric => 'BLENDED_COST', TimePeriod => { End => 'MyYearMonthDay', # max: 40 Start => 'MyYearMonthDay', # max: 40 }, Filter => { And => [ , ... ], # OPTIONAL CostCategories => { Key => 'MyCostCategoryName', # min: 1, max: 50; OPTIONAL MatchOptions => [ 'EQUALS', ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE ], # OPTIONAL Values => [ 'MyValue', ... # max: 1024 ], # OPTIONAL }, # OPTIONAL Dimensions => { Key => 'AZ' , # 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 MatchOptions => [ 'EQUALS', ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE ], # OPTIONAL Values => [ 'MyValue', ... # max: 1024 ], # OPTIONAL }, # OPTIONAL Not => , Or => [ , ... ], # OPTIONAL Tags => { Key => 'MyTagKey', # max: 1024; OPTIONAL MatchOptions => [ 'EQUALS', ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE ], # OPTIONAL Values => [ 'MyValue', ... # max: 1024 ], # OPTIONAL }, # OPTIONAL }, # OPTIONAL PredictionIntervalLevel => 1, # OPTIONAL ); # Results: my $ForecastResultsByTime = $GetUsageForecastResponse->ForecastResultsByTime; my $Total = $GetUsageForecastResponse->Total; # Returns a L object. 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. For the AWS API documentation, see L =head1 ATTRIBUTES =head2 Filter => L The filters that you want to use to filter your forecast. The C API supports filtering by the following dimensions: =over =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =back =head2 B Granularity => Str How granular you want the forecast to be. You can get 3 months of C forecasts or 12 months of C forecasts. The C operation supports only C and C granularities. Valid values are: C<"DAILY">, C<"MONTHLY">, C<"HOURLY"> =head2 B Metric => Str Which metric Cost Explorer uses to create your forecast. Valid values for a C call are the following: =over =item * USAGE_QUANTITY =item * NORMALIZED_USAGE_AMOUNT =back Valid values are: C<"BLENDED_COST">, C<"UNBLENDED_COST">, C<"AMORTIZED_COST">, C<"NET_UNBLENDED_COST">, C<"NET_AMORTIZED_COST">, C<"USAGE_QUANTITY">, C<"NORMALIZED_USAGE_AMOUNT"> =head2 PredictionIntervalLevel => Int Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals. =head2 B TimePeriod => L The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if C is C<2017-01-01> and C is C<2017-05-01>, then the cost and usage data is retrieved from C<2017-01-01> up to and including C<2017-04-30> but not including C<2017-05-01>. The start date must be equal to or later than the current date to avoid a validation error. =head1 SEE ALSO This class forms part of L, documenting arguments for method GetUsageForecast in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut