aws_sdk_autoscaling/operation/get_predictive_scaling_forecast/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_predictive_scaling_forecast::_get_predictive_scaling_forecast_output::GetPredictiveScalingForecastOutputBuilder;
3
4pub use crate::operation::get_predictive_scaling_forecast::_get_predictive_scaling_forecast_input::GetPredictiveScalingForecastInputBuilder;
5
6impl crate::operation::get_predictive_scaling_forecast::builders::GetPredictiveScalingForecastInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::get_predictive_scaling_forecast::GetPredictiveScalingForecastOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_predictive_scaling_forecast::GetPredictiveScalingForecastError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_predictive_scaling_forecast();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetPredictiveScalingForecast`.
24///
25/// <p>Retrieves the forecast data for a predictive scaling policy.</p>
26/// <p>Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.</p>
27/// <p>A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.</p>
28/// <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html">Predictive scaling for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct GetPredictiveScalingForecastFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::get_predictive_scaling_forecast::builders::GetPredictiveScalingForecastInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::get_predictive_scaling_forecast::GetPredictiveScalingForecastOutput,
38        crate::operation::get_predictive_scaling_forecast::GetPredictiveScalingForecastError,
39    > for GetPredictiveScalingForecastFluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::get_predictive_scaling_forecast::GetPredictiveScalingForecastOutput,
47            crate::operation::get_predictive_scaling_forecast::GetPredictiveScalingForecastError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl GetPredictiveScalingForecastFluentBuilder {
54    /// Creates a new `GetPredictiveScalingForecastFluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the GetPredictiveScalingForecast as a reference.
63    pub fn as_input(&self) -> &crate::operation::get_predictive_scaling_forecast::builders::GetPredictiveScalingForecastInputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::get_predictive_scaling_forecast::GetPredictiveScalingForecastOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::get_predictive_scaling_forecast::GetPredictiveScalingForecastError,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::get_predictive_scaling_forecast::GetPredictiveScalingForecast::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::get_predictive_scaling_forecast::GetPredictiveScalingForecast::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::get_predictive_scaling_forecast::GetPredictiveScalingForecastOutput,
100        crate::operation::get_predictive_scaling_forecast::GetPredictiveScalingForecastError,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    /// <p>The name of the Auto Scaling group.</p>
115    pub fn auto_scaling_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116        self.inner = self.inner.auto_scaling_group_name(input.into());
117        self
118    }
119    /// <p>The name of the Auto Scaling group.</p>
120    pub fn set_auto_scaling_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
121        self.inner = self.inner.set_auto_scaling_group_name(input);
122        self
123    }
124    /// <p>The name of the Auto Scaling group.</p>
125    pub fn get_auto_scaling_group_name(&self) -> &::std::option::Option<::std::string::String> {
126        self.inner.get_auto_scaling_group_name()
127    }
128    /// <p>The name of the policy.</p>
129    pub fn policy_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
130        self.inner = self.inner.policy_name(input.into());
131        self
132    }
133    /// <p>The name of the policy.</p>
134    pub fn set_policy_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
135        self.inner = self.inner.set_policy_name(input);
136        self
137    }
138    /// <p>The name of the policy.</p>
139    pub fn get_policy_name(&self) -> &::std::option::Option<::std::string::String> {
140        self.inner.get_policy_name()
141    }
142    /// <p>The inclusive start time of the time range for the forecast data to get. At most, the date and time can be one year before the current date and time.</p>
143    pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
144        self.inner = self.inner.start_time(input);
145        self
146    }
147    /// <p>The inclusive start time of the time range for the forecast data to get. At most, the date and time can be one year before the current date and time.</p>
148    pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
149        self.inner = self.inner.set_start_time(input);
150        self
151    }
152    /// <p>The inclusive start time of the time range for the forecast data to get. At most, the date and time can be one year before the current date and time.</p>
153    pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
154        self.inner.get_start_time()
155    }
156    /// <p>The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days.</p>
157    /// <p>Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for periods of two days in advance.</p>
158    pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
159        self.inner = self.inner.end_time(input);
160        self
161    }
162    /// <p>The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days.</p>
163    /// <p>Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for periods of two days in advance.</p>
164    pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
165        self.inner = self.inner.set_end_time(input);
166        self
167    }
168    /// <p>The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days.</p>
169    /// <p>Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for periods of two days in advance.</p>
170    pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
171        self.inner.get_end_time()
172    }
173}
aws_sdk_autoscaling/operation/get_predictive_scaling_forecast/builders.rs

aws_sdk_autoscaling/operation/get_predictive_scaling_forecast/
builders.rs
