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.GetUsageForecast

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 use over the forecast time period that you select, based on your past usage.

Synopsis

data GetUsageForecast = GetUsageForecast' {
- predictionIntervalLevel :: Maybe Natural
- filter' :: Maybe Expression
- timePeriod :: DateInterval
- metric :: Metric
- granularity :: Granularity
}
newGetUsageForecast :: DateInterval -> Metric -> Granularity -> GetUsageForecast
getUsageForecast_predictionIntervalLevel :: Lens' GetUsageForecast (Maybe Natural)
getUsageForecast_filter :: Lens' GetUsageForecast (Maybe Expression)
getUsageForecast_timePeriod :: Lens' GetUsageForecast DateInterval
getUsageForecast_metric :: Lens' GetUsageForecast Metric
getUsageForecast_granularity :: Lens' GetUsageForecast Granularity
data GetUsageForecastResponse = GetUsageForecastResponse' {
- forecastResultsByTime :: Maybe [ForecastResult]
- total :: Maybe MetricValue
- httpStatus :: Int
}
newGetUsageForecastResponse :: Int -> GetUsageForecastResponse
getUsageForecastResponse_forecastResultsByTime :: Lens' GetUsageForecastResponse (Maybe [ForecastResult])
getUsageForecastResponse_total :: Lens' GetUsageForecastResponse (Maybe MetricValue)
getUsageForecastResponse_httpStatus :: Lens' GetUsageForecastResponse Int

Creating a Request

data GetUsageForecast Source #

See: newGetUsageForecast smart constructor.

Constructors

GetUsageForecast'

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 GetUsageForecast 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 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 start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.
metric :: Metric
Which metric Cost Explorer uses to create your forecast.
Valid values for a GetUsageForecast call are the following:
- USAGE_QUANTITY
- NORMALIZED_USAGE_AMOUNT
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 GetUsageForecast operation supports only DAILY and MONTHLY granularities.

Instances

Instances details

Eq GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods (==) :: GetUsageForecast -> GetUsageForecast -> Bool # (/=) :: GetUsageForecast -> GetUsageForecast -> Bool #
Read GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods readsPrec :: Int -> ReadS GetUsageForecast # readList :: ReadS [GetUsageForecast] # readPrec :: ReadPrec GetUsageForecast # readListPrec :: ReadPrec [GetUsageForecast] #
Show GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods showsPrec :: Int -> GetUsageForecast -> ShowS # show :: GetUsageForecast -> String # showList :: [GetUsageForecast] -> ShowS #
Generic GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Associated Types type Rep GetUsageForecast :: Type -> Type # Methods from :: GetUsageForecast -> Rep GetUsageForecast x # to :: Rep GetUsageForecast x -> GetUsageForecast #
NFData GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods rnf :: GetUsageForecast -> () #
Hashable GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods hashWithSalt :: Int -> GetUsageForecast -> Int # hash :: GetUsageForecast -> Int #
ToJSON GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods toJSON :: GetUsageForecast -> Value # toEncoding :: GetUsageForecast -> Encoding # toJSONList :: [GetUsageForecast] -> Value # toEncodingList :: [GetUsageForecast] -> Encoding #
AWSRequest GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Associated Types type AWSResponse GetUsageForecast # Methods request :: GetUsageForecast -> Request GetUsageForecast # response :: MonadResource m => Logger -> Service -> Proxy GetUsageForecast -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetUsageForecast))) #
ToHeaders GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods toHeaders :: GetUsageForecast -> [Header] #
ToPath GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods toPath :: GetUsageForecast -> ByteString #
ToQuery GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods toQuery :: GetUsageForecast -> QueryString #
type Rep GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast type Rep GetUsageForecast = D1 ('MetaData "GetUsageForecast" "Amazonka.CostExplorer.GetUsageForecast" "libZSservicesZSamazonka-cost-explorerZSamazonka-cost-explorer" 'False) (C1 ('MetaCons "GetUsageForecast'" '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 GetUsageForecast Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast type AWSResponse GetUsageForecast = GetUsageForecastResponse

newGetUsageForecast Source #

Arguments

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

Create a value of GetUsageForecast 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:GetUsageForecast', getUsageForecast_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':GetUsageForecast', getUsageForecast_filter - The filters that you want to use to filter your forecast. The GetUsageForecast 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:GetUsageForecast', getUsageForecast_timePeriod - 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 start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

$sel:metric:GetUsageForecast', getUsageForecast_metric - Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

USAGE_QUANTITY
NORMALIZED_USAGE_AMOUNT

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

The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

Request Lenses

getUsageForecast_predictionIntervalLevel :: Lens' GetUsageForecast (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.

getUsageForecast_filter :: Lens' GetUsageForecast (Maybe Expression) Source #

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

getUsageForecast_timePeriod :: Lens' GetUsageForecast DateInterval Source #

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 start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

getUsageForecast_metric :: Lens' GetUsageForecast Metric Source #

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

USAGE_QUANTITY
NORMALIZED_USAGE_AMOUNT

getUsageForecast_granularity :: Lens' GetUsageForecast 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 GetUsageForecast operation supports only DAILY and MONTHLY granularities.

Destructuring the Response

data GetUsageForecastResponse Source #

See: newGetUsageForecastResponse smart constructor.

Constructors

GetUsageForecastResponse'
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're forecasted to use over the forecast period. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetUsageForecastResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods (==) :: GetUsageForecastResponse -> GetUsageForecastResponse -> Bool # (/=) :: GetUsageForecastResponse -> GetUsageForecastResponse -> Bool #
Read GetUsageForecastResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods readsPrec :: Int -> ReadS GetUsageForecastResponse # readList :: ReadS [GetUsageForecastResponse] # readPrec :: ReadPrec GetUsageForecastResponse # readListPrec :: ReadPrec [GetUsageForecastResponse] #
Show GetUsageForecastResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods showsPrec :: Int -> GetUsageForecastResponse -> ShowS # show :: GetUsageForecastResponse -> String # showList :: [GetUsageForecastResponse] -> ShowS #
Generic GetUsageForecastResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Associated Types type Rep GetUsageForecastResponse :: Type -> Type # Methods from :: GetUsageForecastResponse -> Rep GetUsageForecastResponse x # to :: Rep GetUsageForecastResponse x -> GetUsageForecastResponse #
NFData GetUsageForecastResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast Methods rnf :: GetUsageForecastResponse -> () #
type Rep GetUsageForecastResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetUsageForecast type Rep GetUsageForecastResponse = D1 ('MetaData "GetUsageForecastResponse" "Amazonka.CostExplorer.GetUsageForecast" "libZSservicesZSamazonka-cost-explorerZSamazonka-cost-explorer" 'False) (C1 ('MetaCons "GetUsageForecastResponse'" '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))))

newGetUsageForecastResponse Source #

Arguments

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

Create a value of GetUsageForecastResponse 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:GetUsageForecastResponse', getUsageForecastResponse_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:GetUsageForecastResponse', getUsageForecastResponse_total - How much you're forecasted to use over the forecast period.

$sel:httpStatus:GetUsageForecastResponse', getUsageForecastResponse_httpStatus - The response's http status code.

Response Lenses

getUsageForecastResponse_forecastResultsByTime :: Lens' GetUsageForecastResponse (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.

getUsageForecastResponse_total :: Lens' GetUsageForecastResponse (Maybe MetricValue) Source #

How much you're forecasted to use over the forecast period.

getUsageForecastResponse_httpStatus :: Lens' GetUsageForecastResponse Int Source #

The response's http status code.