Struct GetUsageForecastInput

#[non_exhaustive]
pub struct GetUsageForecastInput {
    pub time_period: Option<DateInterval>,
    pub metric: Option<Metric>,
    pub granularity: Option<Granularity>,
    pub filter: Option<Expression>,
    pub billing_view_arn: Option<String>,
    pub prediction_interval_level: Option<i32>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

time_period: Option<DateInterval>

The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. 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: Option<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: Option<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.

filter: Option<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

billing_view_arn: Option<String>

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.

prediction_interval_level: Option<i32>

Amazon Web Services 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.

Implementations

impl GetUsageForecastInput

pub fn time_period(&self) -> Option<&DateInterval>

The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. 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.

pub fn metric(&self) -> Option<&Metric>

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

• USAGE_QUANTITY

• NORMALIZED_USAGE_AMOUNT

pub fn granularity(&self) -> Option<&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.

pub fn filter(&self) -> Option<&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

pub fn billing_view_arn(&self) -> Option<&str>

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.

pub fn prediction_interval_level(&self) -> Option<i32>

Amazon Web Services 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.

impl GetUsageForecastInput

pub fn builder() -> GetUsageForecastInputBuilder

Creates a new builder-style object to manufacture GetUsageForecastInput.

Trait Implementations

impl Clone for GetUsageForecastInput

fn clone(&self) -> GetUsageForecastInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetUsageForecastInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetUsageForecastInput

fn eq(&self, other: &GetUsageForecastInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetUsageForecastInput