1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[derive(Debug)]
pub(crate) struct Handle<
C = aws_smithy_client::erase::DynConnector,
M = aws_hyper::AwsMiddleware,
R = aws_smithy_client::retry::Standard,
> {
client: aws_smithy_client::Client<C, M, R>,
conf: crate::Config,
}
/// An ergonomic service client for `AmazonForecastRuntime`.
///
/// This client allows ergonomic access to a `AmazonForecastRuntime`-shaped service.
/// Each method corresponds to an endpoint defined in the service's Smithy model,
/// and the request and response shapes are auto-generated from that same model.
///
/// # Using a Client
///
/// Once you have a client set up, you can access the service's endpoints
/// by calling the appropriate method on [`Client`]. Each such method
/// returns a request builder for that endpoint, with methods for setting
/// the various fields of the request. Once your request is complete, use
/// the `send` method to send the request. `send` returns a future, which
/// you then have to `.await` to get the service's response.
///
/// [builder pattern]: https://rust-lang.github.io/api-guidelines/type-safety.html#c-builder
/// [SigV4-signed requests]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
#[derive(std::fmt::Debug)]
pub struct Client<
C = aws_smithy_client::erase::DynConnector,
M = aws_hyper::AwsMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<Handle<C, M, R>>,
}
impl<C, M, R> std::clone::Clone for Client<C, M, R> {
fn clone(&self) -> Self {
Self {
handle: self.handle.clone(),
}
}
}
#[doc(inline)]
pub use aws_smithy_client::Builder;
impl<C, M, R> From<aws_smithy_client::Client<C, M, R>> for Client<C, M, R> {
fn from(client: aws_smithy_client::Client<C, M, R>) -> Self {
Self::with_config(client, crate::Config::builder().build())
}
}
impl<C, M, R> Client<C, M, R> {
/// Creates a client with the given service configuration.
pub fn with_config(client: aws_smithy_client::Client<C, M, R>, conf: crate::Config) -> Self {
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
/// Returns the client's configuration.
pub fn conf(&self) -> &crate::Config {
&self.handle.conf
}
}
impl<C, M, R> Client<C, M, R>
where
C: aws_smithy_client::bounds::SmithyConnector,
M: aws_smithy_client::bounds::SmithyMiddleware<C>,
R: aws_smithy_client::retry::NewRequestPolicy,
{
/// Constructs a fluent builder for the `QueryForecast` operation.
///
/// See [`QueryForecast`](crate::client::fluent_builders::QueryForecast) for more information about the
/// operation and its arguments.
pub fn query_forecast(&self) -> fluent_builders::QueryForecast<C, M, R> {
fluent_builders::QueryForecast::new(self.handle.clone())
}
}
pub mod fluent_builders {
//!
//! Utilities to ergonomically construct a request to the service.
//!
//! Fluent builders are created through the [`Client`](crate::client::Client) by calling
//! one if its operation methods. After parameters are set using the builder methods,
//! the `send` method can be called to initiate the request.
//!
/// Fluent builder constructing a request to `QueryForecast`.
///
/// <p>Retrieves a forecast for a single item, filtered by the supplied criteria.</p>
/// <p>The criteria is a key-value pair. The key is either <code>item_id</code> (or the
/// equivalent non-timestamp, non-target field) from the <code>TARGET_TIME_SERIES</code> dataset,
/// or one of the forecast dimensions specified as part of the <code>FeaturizationConfig</code>
/// object.</p>
/// <p>By default, <code>QueryForecast</code> returns the complete date range for the filtered
/// forecast. You can request a specific date range.</p>
/// <p>To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</a> operation.</p>
/// <note>
/// <p>The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was
/// used to create the predictor.</p>
/// </note>
#[derive(std::fmt::Debug)]
pub struct QueryForecast<
C = aws_smithy_client::erase::DynConnector,
M = aws_hyper::AwsMiddleware,
R = aws_smithy_client::retry::Standard,
> {
handle: std::sync::Arc<super::Handle<C, M, R>>,
inner: crate::input::query_forecast_input::Builder,
}
impl<C, M, R> QueryForecast<C, M, R>
where
C: aws_smithy_client::bounds::SmithyConnector,
M: aws_smithy_client::bounds::SmithyMiddleware<C>,
R: aws_smithy_client::retry::NewRequestPolicy,
{
/// Creates a new `QueryForecast`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle<C, M, R>>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// 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::output::QueryForecastOutput,
aws_smithy_http::result::SdkError<crate::error::QueryForecastError>,
>
where
R::Policy: aws_smithy_client::bounds::SmithyRetryPolicy<
crate::input::QueryForecastInputOperationOutputAlias,
crate::output::QueryForecastOutput,
crate::error::QueryForecastError,
crate::input::QueryForecastInputOperationRetryAlias,
>,
{
let input = self.inner.build().map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
let op = input
.make_operation(&self.handle.conf)
.await
.map_err(|err| {
aws_smithy_http::result::SdkError::ConstructionFailure(err.into())
})?;
self.handle.client.call(op).await
}
/// <p>The Amazon Resource Name (ARN) of the forecast to query.</p>
pub fn forecast_arn(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.forecast_arn(inp);
self
}
/// <p>The Amazon Resource Name (ARN) of the forecast to query.</p>
pub fn set_forecast_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_forecast_arn(input);
self
}
/// <p>The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss
/// (ISO 8601 format). For example, 2015-01-01T08:00:00.</p>
pub fn start_date(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.start_date(inp);
self
}
/// <p>The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss
/// (ISO 8601 format). For example, 2015-01-01T08:00:00.</p>
pub fn set_start_date(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_start_date(input);
self
}
/// <p>The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss
/// (ISO 8601 format). For example, 2015-01-01T20:00:00. </p>
pub fn end_date(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.end_date(inp);
self
}
/// <p>The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss
/// (ISO 8601 format). For example, 2015-01-01T20:00:00. </p>
pub fn set_end_date(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_end_date(input);
self
}
/// Adds a key-value pair to `Filters`.
///
/// To override the contents of this collection use [`set_filters`](Self::set_filters).
///
/// <p>The filtering criteria to apply when retrieving the forecast. For example, to get the
/// forecast for <code>client_21</code> in the electricity usage dataset, specify the
/// following:</p>
/// <p>
/// <code>{"item_id" : "client_21"}</code>
/// </p>
///
///
/// <p>To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</a> operation.</p>
pub fn filters(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.filters(k, v);
self
}
/// <p>The filtering criteria to apply when retrieving the forecast. For example, to get the
/// forecast for <code>client_21</code> in the electricity usage dataset, specify the
/// following:</p>
/// <p>
/// <code>{"item_id" : "client_21"}</code>
/// </p>
///
///
/// <p>To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</a> operation.</p>
pub fn set_filters(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_filters(input);
self
}
/// <p>If the result of the previous request was truncated, the response includes a
/// <code>NextToken</code>. To retrieve the next set of results, use the token in the next
/// request. Tokens expire after 24 hours.</p>
pub fn next_token(mut self, inp: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(inp);
self
}
/// <p>If the result of the previous request was truncated, the response includes a
/// <code>NextToken</code>. To retrieve the next set of results, use the token in the next
/// request. Tokens expire after 24 hours.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
}
impl<C> Client<C, aws_hyper::AwsMiddleware, aws_smithy_client::retry::Standard> {
/// Creates a client with the given service config and connector override.
pub fn from_conf_conn(conf: crate::Config, conn: C) -> Self {
let retry_config = conf.retry_config.as_ref().cloned().unwrap_or_default();
let client = aws_hyper::Client::new(conn).with_retry_config(retry_config.into());
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
}
impl
Client<
aws_smithy_client::erase::DynConnector,
aws_hyper::AwsMiddleware,
aws_smithy_client::retry::Standard,
>
{
/// Creates a new client from a shared config.
#[cfg(any(feature = "rustls", feature = "native-tls"))]
pub fn new(config: &aws_types::config::Config) -> Self {
Self::from_conf(config.into())
}
/// Creates a new client from the service [`Config`](crate::Config).
#[cfg(any(feature = "rustls", feature = "native-tls"))]
pub fn from_conf(conf: crate::Config) -> Self {
let retry_config = conf.retry_config.as_ref().cloned().unwrap_or_default();
let client = aws_hyper::Client::https().with_retry_config(retry_config.into());
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
}