aws_sdk_forecastquery/client/
query_forecast.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`QueryForecast`](crate::operation::query_forecast::builders::QueryForecastFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`forecast_arn(impl Into<String>)`](crate::operation::query_forecast::builders::QueryForecastFluentBuilder::forecast_arn) / [`set_forecast_arn(Option<String>)`](crate::operation::query_forecast::builders::QueryForecastFluentBuilder::set_forecast_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the forecast to query.</p><br>
7    ///   - [`start_date(impl Into<String>)`](crate::operation::query_forecast::builders::QueryForecastFluentBuilder::start_date) / [`set_start_date(Option<String>)`](crate::operation::query_forecast::builders::QueryForecastFluentBuilder::set_start_date):<br>required: **false**<br><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><br>
8    ///   - [`end_date(impl Into<String>)`](crate::operation::query_forecast::builders::QueryForecastFluentBuilder::end_date) / [`set_end_date(Option<String>)`](crate::operation::query_forecast::builders::QueryForecastFluentBuilder::set_end_date):<br>required: **false**<br><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><br>
9    ///   - [`filters(impl Into<String>, impl Into<String>)`](crate::operation::query_forecast::builders::QueryForecastFluentBuilder::filters) / [`set_filters(Option<HashMap::<String, String>>)`](crate::operation::query_forecast::builders::QueryForecastFluentBuilder::set_filters):<br>required: **true**<br><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><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::query_forecast::builders::QueryForecastFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::query_forecast::builders::QueryForecastFluentBuilder::set_next_token):<br>required: **false**<br><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><br>
11    /// - On success, responds with [`QueryForecastOutput`](crate::operation::query_forecast::QueryForecastOutput) with field(s):
12    ///   - [`forecast(Option<Forecast>)`](crate::operation::query_forecast::QueryForecastOutput::forecast): <p>The forecast.</p>
13    /// - On failure, responds with [`SdkError<QueryForecastError>`](crate::operation::query_forecast::QueryForecastError)
14    pub fn query_forecast(&self) -> crate::operation::query_forecast::builders::QueryForecastFluentBuilder {
15        crate::operation::query_forecast::builders::QueryForecastFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_forecastquery/client/query_forecast.rs

aws_sdk_forecastquery/client/
query_forecast.rs
