// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_usage_forecast::_get_usage_forecast_input::GetUsageForecastInputBuilder;
pub use crate::operation::get_usage_forecast::_get_usage_forecast_output::GetUsageForecastOutputBuilder;
impl crate::operation::get_usage_forecast::builders::GetUsageForecastInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::get_usage_forecast::GetUsageForecastOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_usage_forecast::GetUsageForecastError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.get_usage_forecast();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `GetUsageForecast`.
///
/// <p>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.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetUsageForecastFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::get_usage_forecast::builders::GetUsageForecastInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::get_usage_forecast::GetUsageForecastOutput,
crate::operation::get_usage_forecast::GetUsageForecastError,
> for GetUsageForecastFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::get_usage_forecast::GetUsageForecastOutput,
crate::operation::get_usage_forecast::GetUsageForecastError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl GetUsageForecastFluentBuilder {
/// Creates a new `GetUsageForecastFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the GetUsageForecast as a reference.
pub fn as_input(&self) -> &crate::operation::get_usage_forecast::builders::GetUsageForecastInputBuilder {
&self.inner
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::get_usage_forecast::GetUsageForecastOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_usage_forecast::GetUsageForecastError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::get_usage_forecast::GetUsageForecast::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::get_usage_forecast::GetUsageForecast::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::get_usage_forecast::GetUsageForecastOutput,
crate::operation::get_usage_forecast::GetUsageForecastError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>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 <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. The start date must be equal to or later than the current date to avoid a validation error.</p>
pub fn time_period(mut self, input: crate::types::DateInterval) -> Self {
self.inner = self.inner.time_period(input);
self
}
/// <p>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 <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. The start date must be equal to or later than the current date to avoid a validation error.</p>
pub fn set_time_period(mut self, input: ::std::option::Option<crate::types::DateInterval>) -> Self {
self.inner = self.inner.set_time_period(input);
self
}
/// <p>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 <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. The start date must be equal to or later than the current date to avoid a validation error.</p>
pub fn get_time_period(&self) -> &::std::option::Option<crate::types::DateInterval> {
self.inner.get_time_period()
}
/// <p>Which metric Cost Explorer uses to create your forecast.</p>
/// <p>Valid values for a <code>GetUsageForecast</code> call are the following:</p>
/// <ul>
/// <li>
/// <p>USAGE_QUANTITY</p></li>
/// <li>
/// <p>NORMALIZED_USAGE_AMOUNT</p></li>
/// </ul>
pub fn metric(mut self, input: crate::types::Metric) -> Self {
self.inner = self.inner.metric(input);
self
}
/// <p>Which metric Cost Explorer uses to create your forecast.</p>
/// <p>Valid values for a <code>GetUsageForecast</code> call are the following:</p>
/// <ul>
/// <li>
/// <p>USAGE_QUANTITY</p></li>
/// <li>
/// <p>NORMALIZED_USAGE_AMOUNT</p></li>
/// </ul>
pub fn set_metric(mut self, input: ::std::option::Option<crate::types::Metric>) -> Self {
self.inner = self.inner.set_metric(input);
self
}
/// <p>Which metric Cost Explorer uses to create your forecast.</p>
/// <p>Valid values for a <code>GetUsageForecast</code> call are the following:</p>
/// <ul>
/// <li>
/// <p>USAGE_QUANTITY</p></li>
/// <li>
/// <p>NORMALIZED_USAGE_AMOUNT</p></li>
/// </ul>
pub fn get_metric(&self) -> &::std::option::Option<crate::types::Metric> {
self.inner.get_metric()
}
/// <p>How granular you want the forecast to be. You can get 3 months of <code>DAILY</code> forecasts or 18 months of <code>MONTHLY</code> forecasts.</p>
/// <p>The <code>GetUsageForecast</code> operation supports only <code>DAILY</code> and <code>MONTHLY</code> granularities.</p>
pub fn granularity(mut self, input: crate::types::Granularity) -> Self {
self.inner = self.inner.granularity(input);
self
}
/// <p>How granular you want the forecast to be. You can get 3 months of <code>DAILY</code> forecasts or 18 months of <code>MONTHLY</code> forecasts.</p>
/// <p>The <code>GetUsageForecast</code> operation supports only <code>DAILY</code> and <code>MONTHLY</code> granularities.</p>
pub fn set_granularity(mut self, input: ::std::option::Option<crate::types::Granularity>) -> Self {
self.inner = self.inner.set_granularity(input);
self
}
/// <p>How granular you want the forecast to be. You can get 3 months of <code>DAILY</code> forecasts or 18 months of <code>MONTHLY</code> forecasts.</p>
/// <p>The <code>GetUsageForecast</code> operation supports only <code>DAILY</code> and <code>MONTHLY</code> granularities.</p>
pub fn get_granularity(&self) -> &::std::option::Option<crate::types::Granularity> {
self.inner.get_granularity()
}
/// <p>The filters that you want to use to filter your forecast. The <code>GetUsageForecast</code> API supports filtering by the following dimensions:</p>
/// <ul>
/// <li>
/// <p><code>AZ</code></p></li>
/// <li>
/// <p><code>INSTANCE_TYPE</code></p></li>
/// <li>
/// <p><code>LINKED_ACCOUNT</code></p></li>
/// <li>
/// <p><code>LINKED_ACCOUNT_NAME</code></p></li>
/// <li>
/// <p><code>OPERATION</code></p></li>
/// <li>
/// <p><code>PURCHASE_TYPE</code></p></li>
/// <li>
/// <p><code>REGION</code></p></li>
/// <li>
/// <p><code>SERVICE</code></p></li>
/// <li>
/// <p><code>USAGE_TYPE</code></p></li>
/// <li>
/// <p><code>USAGE_TYPE_GROUP</code></p></li>
/// <li>
/// <p><code>RECORD_TYPE</code></p></li>
/// <li>
/// <p><code>OPERATING_SYSTEM</code></p></li>
/// <li>
/// <p><code>TENANCY</code></p></li>
/// <li>
/// <p><code>SCOPE</code></p></li>
/// <li>
/// <p><code>PLATFORM</code></p></li>
/// <li>
/// <p><code>SUBSCRIPTION_ID</code></p></li>
/// <li>
/// <p><code>LEGAL_ENTITY_NAME</code></p></li>
/// <li>
/// <p><code>DEPLOYMENT_OPTION</code></p></li>
/// <li>
/// <p><code>DATABASE_ENGINE</code></p></li>
/// <li>
/// <p><code>INSTANCE_TYPE_FAMILY</code></p></li>
/// <li>
/// <p><code>BILLING_ENTITY</code></p></li>
/// <li>
/// <p><code>RESERVATION_ID</code></p></li>
/// <li>
/// <p><code>SAVINGS_PLAN_ARN</code></p></li>
/// </ul>
pub fn filter(mut self, input: crate::types::Expression) -> Self {
self.inner = self.inner.filter(input);
self
}
/// <p>The filters that you want to use to filter your forecast. The <code>GetUsageForecast</code> API supports filtering by the following dimensions:</p>
/// <ul>
/// <li>
/// <p><code>AZ</code></p></li>
/// <li>
/// <p><code>INSTANCE_TYPE</code></p></li>
/// <li>
/// <p><code>LINKED_ACCOUNT</code></p></li>
/// <li>
/// <p><code>LINKED_ACCOUNT_NAME</code></p></li>
/// <li>
/// <p><code>OPERATION</code></p></li>
/// <li>
/// <p><code>PURCHASE_TYPE</code></p></li>
/// <li>
/// <p><code>REGION</code></p></li>
/// <li>
/// <p><code>SERVICE</code></p></li>
/// <li>
/// <p><code>USAGE_TYPE</code></p></li>
/// <li>
/// <p><code>USAGE_TYPE_GROUP</code></p></li>
/// <li>
/// <p><code>RECORD_TYPE</code></p></li>
/// <li>
/// <p><code>OPERATING_SYSTEM</code></p></li>
/// <li>
/// <p><code>TENANCY</code></p></li>
/// <li>
/// <p><code>SCOPE</code></p></li>
/// <li>
/// <p><code>PLATFORM</code></p></li>
/// <li>
/// <p><code>SUBSCRIPTION_ID</code></p></li>
/// <li>
/// <p><code>LEGAL_ENTITY_NAME</code></p></li>
/// <li>
/// <p><code>DEPLOYMENT_OPTION</code></p></li>
/// <li>
/// <p><code>DATABASE_ENGINE</code></p></li>
/// <li>
/// <p><code>INSTANCE_TYPE_FAMILY</code></p></li>
/// <li>
/// <p><code>BILLING_ENTITY</code></p></li>
/// <li>
/// <p><code>RESERVATION_ID</code></p></li>
/// <li>
/// <p><code>SAVINGS_PLAN_ARN</code></p></li>
/// </ul>
pub fn set_filter(mut self, input: ::std::option::Option<crate::types::Expression>) -> Self {
self.inner = self.inner.set_filter(input);
self
}
/// <p>The filters that you want to use to filter your forecast. The <code>GetUsageForecast</code> API supports filtering by the following dimensions:</p>
/// <ul>
/// <li>
/// <p><code>AZ</code></p></li>
/// <li>
/// <p><code>INSTANCE_TYPE</code></p></li>
/// <li>
/// <p><code>LINKED_ACCOUNT</code></p></li>
/// <li>
/// <p><code>LINKED_ACCOUNT_NAME</code></p></li>
/// <li>
/// <p><code>OPERATION</code></p></li>
/// <li>
/// <p><code>PURCHASE_TYPE</code></p></li>
/// <li>
/// <p><code>REGION</code></p></li>
/// <li>
/// <p><code>SERVICE</code></p></li>
/// <li>
/// <p><code>USAGE_TYPE</code></p></li>
/// <li>
/// <p><code>USAGE_TYPE_GROUP</code></p></li>
/// <li>
/// <p><code>RECORD_TYPE</code></p></li>
/// <li>
/// <p><code>OPERATING_SYSTEM</code></p></li>
/// <li>
/// <p><code>TENANCY</code></p></li>
/// <li>
/// <p><code>SCOPE</code></p></li>
/// <li>
/// <p><code>PLATFORM</code></p></li>
/// <li>
/// <p><code>SUBSCRIPTION_ID</code></p></li>
/// <li>
/// <p><code>LEGAL_ENTITY_NAME</code></p></li>
/// <li>
/// <p><code>DEPLOYMENT_OPTION</code></p></li>
/// <li>
/// <p><code>DATABASE_ENGINE</code></p></li>
/// <li>
/// <p><code>INSTANCE_TYPE_FAMILY</code></p></li>
/// <li>
/// <p><code>BILLING_ENTITY</code></p></li>
/// <li>
/// <p><code>RESERVATION_ID</code></p></li>
/// <li>
/// <p><code>SAVINGS_PLAN_ARN</code></p></li>
/// </ul>
pub fn get_filter(&self) -> &::std::option::Option<crate::types::Expression> {
self.inner.get_filter()
}
/// <p>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.</p>
pub fn billing_view_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.billing_view_arn(input.into());
self
}
/// <p>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.</p>
pub fn set_billing_view_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_billing_view_arn(input);
self
}
/// <p>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.</p>
pub fn get_billing_view_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_billing_view_arn()
}
/// <p>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.</p>
pub fn prediction_interval_level(mut self, input: i32) -> Self {
self.inner = self.inner.prediction_interval_level(input);
self
}
/// <p>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.</p>
pub fn set_prediction_interval_level(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_prediction_interval_level(input);
self
}
/// <p>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.</p>
pub fn get_prediction_interval_level(&self) -> &::std::option::Option<i32> {
self.inner.get_prediction_interval_level()
}
}