Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CostExplorer.GetCostForecast

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

data GetCostForecast = GetCostForecast' {
- predictionIntervalLevel :: Maybe Natural
- filter' :: Maybe Expression
- timePeriod :: DateInterval
- metric :: Metric
- granularity :: Granularity
}
newGetCostForecast :: DateInterval -> Metric -> Granularity -> GetCostForecast
getCostForecast_predictionIntervalLevel :: Lens' GetCostForecast (Maybe Natural)
getCostForecast_filter :: Lens' GetCostForecast (Maybe Expression)
getCostForecast_timePeriod :: Lens' GetCostForecast DateInterval
getCostForecast_metric :: Lens' GetCostForecast Metric
getCostForecast_granularity :: Lens' GetCostForecast Granularity
data GetCostForecastResponse = GetCostForecastResponse' {
- forecastResultsByTime :: Maybe [ForecastResult]
- total :: Maybe MetricValue
- httpStatus :: Int
}
newGetCostForecastResponse :: Int -> GetCostForecastResponse
getCostForecastResponse_forecastResultsByTime :: Lens' GetCostForecastResponse (Maybe [ForecastResult])
getCostForecastResponse_total :: Lens' GetCostForecastResponse (Maybe MetricValue)
getCostForecastResponse_httpStatus :: Lens' GetCostForecastResponse Int

Creating a Request

data GetCostForecast Source #

See: newGetCostForecast smart constructor.

Constructors

GetCostForecast'

Fields

predictionIntervalLevel :: Maybe Natural
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.

filter' :: Maybe Expression

The filters that you want to use to filter your forecast. The GetCostForecast 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
```

timePeriod :: DateInterval
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 :: Metric
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 GetCostForecast call are the following:
- AMORTIZED_COST
- BLENDED_COST
- NET_AMORTIZED_COST
- NET_UNBLENDED_COST
- UNBLENDED_COST
granularity :: Granularity
How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.
The GetCostForecast operation supports only DAILY and MONTHLY granularities.

Instances

Instances details

Eq GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods (==) :: GetCostForecast -> GetCostForecast -> Bool # (/=) :: GetCostForecast -> GetCostForecast -> Bool #
Read GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods readsPrec :: Int -> ReadS GetCostForecast # readList :: ReadS [GetCostForecast] # readPrec :: ReadPrec GetCostForecast # readListPrec :: ReadPrec [GetCostForecast] #
Show GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods showsPrec :: Int -> GetCostForecast -> ShowS # show :: GetCostForecast -> String # showList :: [GetCostForecast] -> ShowS #
Generic GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Associated Types type Rep GetCostForecast :: Type -> Type # Methods from :: GetCostForecast -> Rep GetCostForecast x # to :: Rep GetCostForecast x -> GetCostForecast #
NFData GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods rnf :: GetCostForecast -> () #
Hashable GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods hashWithSalt :: Int -> GetCostForecast -> Int # hash :: GetCostForecast -> Int #
ToJSON GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods toJSON :: GetCostForecast -> Value # toEncoding :: GetCostForecast -> Encoding # toJSONList :: [GetCostForecast] -> Value # toEncodingList :: [GetCostForecast] -> Encoding #
AWSRequest GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Associated Types type AWSResponse GetCostForecast # Methods request :: GetCostForecast -> Request GetCostForecast # response :: MonadResource m => Logger -> Service -> Proxy GetCostForecast -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetCostForecast))) #
ToHeaders GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods toHeaders :: GetCostForecast -> [Header] #
ToPath GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods toPath :: GetCostForecast -> ByteString #
ToQuery GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods toQuery :: GetCostForecast -> QueryString #
type Rep GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast type Rep GetCostForecast = D1 ('MetaData "GetCostForecast" "Amazonka.CostExplorer.GetCostForecast" "libZSservicesZSamazonka-cost-explorerZSamazonka-cost-explorer" 'False) (C1 ('MetaCons "GetCostForecast'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "predictionIntervalLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Expression))) :: (S1 ('MetaSel ('Just "timePeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DateInterval) :: (S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Metric) :: S1 ('MetaSel ('Just "granularity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Granularity)))))
type AWSResponse GetCostForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast type AWSResponse GetCostForecast = GetCostForecastResponse

newGetCostForecast Source #

Arguments

:: DateInterval	`$sel:timePeriod:GetCostForecast'`
-> Metric	`$sel:metric:GetCostForecast'`
-> Granularity	`$sel:granularity:GetCostForecast'`
-> GetCostForecast

Create a value of GetCostForecast with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:predictionIntervalLevel:GetCostForecast', getCostForecast_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.

$sel:filter':GetCostForecast', getCostForecast_filter - The filters that you want to use to filter your forecast. The GetCostForecast 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
```

$sel:timePeriod:GetCostForecast', getCostForecast_timePeriod - 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.

$sel:metric:GetCostForecast', getCostForecast_metric - 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 GetCostForecast call are the following:

AMORTIZED_COST
BLENDED_COST
NET_AMORTIZED_COST
NET_UNBLENDED_COST
UNBLENDED_COST

$sel:granularity:GetCostForecast', getCostForecast_granularity - How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

The GetCostForecast operation supports only DAILY and MONTHLY granularities.

Request Lenses

getCostForecast_predictionIntervalLevel :: Lens' GetCostForecast (Maybe Natural) Source #

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.

getCostForecast_filter :: Lens' GetCostForecast (Maybe Expression) Source #

The filters that you want to use to filter your forecast. The GetCostForecast 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
```

getCostForecast_timePeriod :: Lens' GetCostForecast DateInterval Source #

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.

getCostForecast_metric :: Lens' GetCostForecast Metric Source #

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 GetCostForecast call are the following:

AMORTIZED_COST
BLENDED_COST
NET_AMORTIZED_COST
NET_UNBLENDED_COST
UNBLENDED_COST

getCostForecast_granularity :: Lens' GetCostForecast Granularity Source #

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

The GetCostForecast operation supports only DAILY and MONTHLY granularities.

Destructuring the Response

data GetCostForecastResponse Source #

See: newGetCostForecastResponse smart constructor.

Constructors

GetCostForecastResponse'
Fields forecastResultsByTime :: Maybe [ForecastResult] The forecasts for your query, in order. For `DAILY` forecasts, this is a list of days. For `MONTHLY` forecasts, this is a list of months. total :: Maybe MetricValue How much you are forecasted to spend over the forecast period, in `USD`. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetCostForecastResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods (==) :: GetCostForecastResponse -> GetCostForecastResponse -> Bool # (/=) :: GetCostForecastResponse -> GetCostForecastResponse -> Bool #
Read GetCostForecastResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods readsPrec :: Int -> ReadS GetCostForecastResponse # readList :: ReadS [GetCostForecastResponse] # readPrec :: ReadPrec GetCostForecastResponse # readListPrec :: ReadPrec [GetCostForecastResponse] #
Show GetCostForecastResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods showsPrec :: Int -> GetCostForecastResponse -> ShowS # show :: GetCostForecastResponse -> String # showList :: [GetCostForecastResponse] -> ShowS #
Generic GetCostForecastResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Associated Types type Rep GetCostForecastResponse :: Type -> Type # Methods from :: GetCostForecastResponse -> Rep GetCostForecastResponse x # to :: Rep GetCostForecastResponse x -> GetCostForecastResponse #
NFData GetCostForecastResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast Methods rnf :: GetCostForecastResponse -> () #
type Rep GetCostForecastResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetCostForecast type Rep GetCostForecastResponse = D1 ('MetaData "GetCostForecastResponse" "Amazonka.CostExplorer.GetCostForecast" "libZSservicesZSamazonka-cost-explorerZSamazonka-cost-explorer" 'False) (C1 ('MetaCons "GetCostForecastResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forecastResultsByTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ForecastResult])) :: (S1 ('MetaSel ('Just "total") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricValue)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetCostForecastResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetCostForecastResponse'`
-> GetCostForecastResponse

Create a value of GetCostForecastResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:forecastResultsByTime:GetCostForecastResponse', getCostForecastResponse_forecastResultsByTime - The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.

$sel:total:GetCostForecastResponse', getCostForecastResponse_total - How much you are forecasted to spend over the forecast period, in USD.

$sel:httpStatus:GetCostForecastResponse', getCostForecastResponse_httpStatus - The response's http status code.

Response Lenses

getCostForecastResponse_forecastResultsByTime :: Lens' GetCostForecastResponse (Maybe [ForecastResult]) Source #

The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.

getCostForecastResponse_total :: Lens' GetCostForecastResponse (Maybe MetricValue) Source #

How much you are forecasted to spend over the forecast period, in USD.

getCostForecastResponse_httpStatus :: Lens' GetCostForecastResponse Int Source #

The response's http status code.