Struct aws_sdk_forecastquery::client::fluent_builders::QueryForecast [−][src]
pub struct QueryForecast<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to QueryForecast
.
Retrieves a forecast for a single item, filtered by the supplied criteria.
The criteria is a key-value pair. The key is either item_id
(or the
equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES
dataset,
or one of the forecast dimensions specified as part of the FeaturizationConfig
object.
By default, QueryForecast
returns the complete date range for the filtered
forecast. You can request a specific date range.
To get the full forecast, use the CreateForecastExportJob operation.
The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.
Implementations
impl<C, M, R> QueryForecast<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> QueryForecast<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<QueryForecastOutput, SdkError<QueryForecastError>> where
R::Policy: SmithyRetryPolicy<QueryForecastInputOperationOutputAlias, QueryForecastOutput, QueryForecastError, QueryForecastInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<QueryForecastOutput, SdkError<QueryForecastError>> where
R::Policy: SmithyRetryPolicy<QueryForecastInputOperationOutputAlias, QueryForecastOutput, QueryForecastError, QueryForecastInputOperationRetryAlias>,
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.
The Amazon Resource Name (ARN) of the forecast to query.
The Amazon Resource Name (ARN) of the forecast to query.
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.
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.
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.
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.
Adds a key-value pair to Filters
.
To override the contents of this collection use set_filters
.
The filtering criteria to apply when retrieving the forecast. For example, to get the
forecast for client_21
in the electricity usage dataset, specify the
following:
{"item_id" : "client_21"}
To get the full forecast, use the CreateForecastExportJob operation.
The filtering criteria to apply when retrieving the forecast. For example, to get the
forecast for client_21
in the electricity usage dataset, specify the
following:
{"item_id" : "client_21"}
To get the full forecast, use the CreateForecastExportJob operation.
If the result of the previous request was truncated, the response includes a
NextToken
. To retrieve the next set of results, use the token in the next
request. Tokens expire after 24 hours.
If the result of the previous request was truncated, the response includes a
NextToken
. To retrieve the next set of results, use the token in the next
request. Tokens expire after 24 hours.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for QueryForecast<C, M, R>
impl<C, M, R> Unpin for QueryForecast<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for QueryForecast<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more