costexplorer_get_cost_forecast: Retrieves a forecast for how much Amazon Web Services...

In paws.cost.management: 'Amazon Web Services' Cost Management Services

Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs

Description

Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.

See https://www.paws-r-sdk.com/docs/costexplorer_get_cost_forecast/ for full documentation.

Usage

costexplorer_get_cost_forecast(
  TimePeriod,
  Metric,
  Granularity,
  Filter = NULL,
  BillingViewArn = NULL,
  PredictionIntervalLevel = NULL
)

Arguments

TimePeriod	[required] The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.
Metric	[required] Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?. Valid values for a get_cost_forecast call are the following: AMORTIZED_COST BLENDED_COST NET_AMORTIZED_COST NET_UNBLENDED_COST UNBLENDED_COST
Granularity	[required] How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts. The get_cost_forecast operation supports only DAILY and MONTHLY granularities.
Filter	The filters that you want to use to filter your forecast. The get_cost_forecast API supports filtering by the following dimensions: AZ INSTANCE_TYPE LINKED_ACCOUNT LINKED_ACCOUNT_NAME OPERATION PURCHASE_TYPE REGION SERVICE USAGE_TYPE USAGE_TYPE_GROUP RECORD_TYPE OPERATING_SYSTEM TENANCY SCOPE PLATFORM SUBSCRIPTION_ID LEGAL_ENTITY_NAME DEPLOYMENT_OPTION DATABASE_ENGINE INSTANCE_TYPE_FAMILY BILLING_ENTITY RESERVATION_ID SAVINGS_PLAN_ARN
BillingViewArn	The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.
PredictionIntervalLevel	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.

paws.cost.management documentation built on April 3, 2025, 9:24 p.m.