pub struct GetReservationCoverageFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetReservationCoverage
.
Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data about reservation usage by the following dimensions:
-
AZ
-
CACHE_ENGINE
-
DATABASE_ENGINE
-
DEPLOYMENT_OPTION
-
INSTANCE_TYPE
-
LINKED_ACCOUNT
-
OPERATING_SYSTEM
-
PLATFORM
-
REGION
-
SERVICE
-
TAG
-
TENANCY
To determine valid values for a dimension, use the GetDimensionValues
operation.
Implementations§
Source§impl GetReservationCoverageFluentBuilder
impl GetReservationCoverageFluentBuilder
Sourcepub fn as_input(&self) -> &GetReservationCoverageInputBuilder
pub fn as_input(&self) -> &GetReservationCoverageInputBuilder
Access the GetReservationCoverage as a reference.
Sourcepub async fn send(
self,
) -> Result<GetReservationCoverageOutput, SdkError<GetReservationCoverageError, HttpResponse>>
pub async fn send( self, ) -> Result<GetReservationCoverageOutput, SdkError<GetReservationCoverageError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<GetReservationCoverageOutput, GetReservationCoverageError, Self>
pub fn customize( self, ) -> CustomizableOperation<GetReservationCoverageOutput, GetReservationCoverageError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn time_period(self, input: DateInterval) -> Self
pub fn time_period(self, input: DateInterval) -> Self
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
.
Sourcepub fn set_time_period(self, input: Option<DateInterval>) -> Self
pub fn set_time_period(self, input: Option<DateInterval>) -> Self
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
.
Sourcepub fn get_time_period(&self) -> &Option<DateInterval>
pub fn get_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
.
Sourcepub fn group_by(self, input: GroupDefinition) -> Self
pub fn group_by(self, input: GroupDefinition) -> Self
Appends an item to GroupBy
.
To override the contents of this collection use set_group_by
.
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
Sourcepub fn set_group_by(self, input: Option<Vec<GroupDefinition>>) -> Self
pub fn set_group_by(self, input: Option<Vec<GroupDefinition>>) -> Self
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
Sourcepub fn get_group_by(&self) -> &Option<Vec<GroupDefinition>>
pub fn get_group_by(&self) -> &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
Sourcepub fn granularity(self, input: Granularity) -> Self
pub fn granularity(self, input: Granularity) -> Self
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.
Sourcepub fn set_granularity(self, input: Option<Granularity>) -> Self
pub fn set_granularity(self, input: Option<Granularity>) -> Self
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.
Sourcepub fn get_granularity(&self) -> &Option<Granularity>
pub fn get_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.
Sourcepub fn filter(self, input: Expression) -> Self
pub fn filter(self, input: Expression) -> Self
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.
Sourcepub fn set_filter(self, input: Option<Expression>) -> Self
pub fn set_filter(self, input: Option<Expression>) -> Self
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.
Sourcepub fn get_filter(&self) -> &Option<Expression>
pub fn get_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.
Sourcepub fn metrics(self, input: impl Into<String>) -> Self
pub fn metrics(self, input: impl Into<String>) -> Self
Appends an item to Metrics
.
To override the contents of this collection use set_metrics
.
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.
Sourcepub fn set_metrics(self, input: Option<Vec<String>>) -> Self
pub fn set_metrics(self, input: Option<Vec<String>>) -> Self
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.
Sourcepub fn get_metrics(&self) -> &Option<Vec<String>>
pub fn get_metrics(&self) -> &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.
Sourcepub fn next_page_token(self, input: impl Into<String>) -> Self
pub fn next_page_token(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_next_page_token(self, input: Option<String>) -> Self
pub fn set_next_page_token(self, input: Option<String>) -> Self
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.
Sourcepub fn get_next_page_token(&self) -> &Option<String>
pub fn get_next_page_token(&self) -> &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.
Sourcepub fn sort_by(self, input: SortDefinition) -> Self
pub fn sort_by(self, input: SortDefinition) -> Self
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
.
Sourcepub fn set_sort_by(self, input: Option<SortDefinition>) -> Self
pub fn set_sort_by(self, input: Option<SortDefinition>) -> Self
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
.
Sourcepub fn get_sort_by(&self) -> &Option<SortDefinition>
pub fn get_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
.
Sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
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.
Sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
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.
Sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_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.
Trait Implementations§
Source§impl Clone for GetReservationCoverageFluentBuilder
impl Clone for GetReservationCoverageFluentBuilder
Source§fn clone(&self) -> GetReservationCoverageFluentBuilder
fn clone(&self) -> GetReservationCoverageFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for GetReservationCoverageFluentBuilder
impl !RefUnwindSafe for GetReservationCoverageFluentBuilder
impl Send for GetReservationCoverageFluentBuilder
impl Sync for GetReservationCoverageFluentBuilder
impl Unpin for GetReservationCoverageFluentBuilder
impl !UnwindSafe for GetReservationCoverageFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);