Struct GetReservationCoverageInput

#[non_exhaustive]
pub struct GetReservationCoverageInput {
    pub time_period: Option<DateInterval>,
    pub group_by: Option<Vec<GroupDefinition>>,
    pub granularity: Option<Granularity>,
    pub filter: Option<Expression>,
    pub metrics: Option<Vec<String>>,
    pub next_page_token: Option<String>,
    pub sort_by: Option<SortDefinition>,
    pub max_results: Option<i32>,
}

You can use the following request parameters to query for how much of your instance usage a reservation covered.

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 data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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.

group_by: Option<Vec<GroupDefinition>>

You can group the data by the following attributes:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• INVOICING_ENTITY

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• TENANCY

granularity: Option<Granularity>

The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

filter: Option<Expression>

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• TAG

• TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

metrics: Option<Vec<String>>

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

next_page_token: Option<String>

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

sort_by: Option<SortDefinition>

The value by which you want to sort the data.

The following values are supported for Key:

• OnDemandCost

• CoverageHoursPercentage

• OnDemandHours

• ReservedHours

• TotalRunningHours

• CoverageNormalizedUnitsPercentage

• OnDemandNormalizedUnits

• ReservedNormalizedUnits

• TotalRunningNormalizedUnits

• Time

Supported values for SortOrder are ASCENDING or DESCENDING.

max_results: Option<i32>

The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

Implementations

impl GetReservationCoverageInput

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

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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.

pub fn group_by(&self) -> &[GroupDefinition]

You can group the data by the following attributes:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• INVOICING_ENTITY

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• TENANCY

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .group_by.is_none().

pub fn granularity(&self) -> Option<&Granularity>

The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

pub fn filter(&self) -> Option<&Expression>

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• TAG

• TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

pub fn metrics(&self) -> &[String]

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .metrics.is_none().

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

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

pub fn sort_by(&self) -> Option<&SortDefinition>

The value by which you want to sort the data.

The following values are supported for Key:

• OnDemandCost

• CoverageHoursPercentage

• OnDemandHours

• ReservedHours

• TotalRunningHours

• CoverageNormalizedUnitsPercentage

• OnDemandNormalizedUnits

• ReservedNormalizedUnits

• TotalRunningNormalizedUnits

• Time

Supported values for SortOrder are ASCENDING or DESCENDING.

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

The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

impl GetReservationCoverageInput

pub fn builder() -> GetReservationCoverageInputBuilder

Creates a new builder-style object to manufacture GetReservationCoverageInput.

Trait Implementations

impl Clone for GetReservationCoverageInput

fn clone(&self) -> GetReservationCoverageInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetReservationCoverageInput

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

Formats the value using the given formatter.

impl PartialEq for GetReservationCoverageInput

fn eq(&self, other: &GetReservationCoverageInput) -> 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 GetReservationCoverageInput