Struct rusoto_forecastquery::ForecastQueryClient

pub struct ForecastQueryClient { /* fields omitted */ }

A client for the Amazon Forecast Query Service API.

Implementations

impl ForecastQueryClient

pub fn new(region: Region) -> ForecastQueryClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> ForecastQueryClient where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    D: DispatchSignedRequest + Send + Sync + 'static, 

pub fn new_with_client(client: Client, region: Region) -> ForecastQueryClient

Trait Implementations

impl Clone for ForecastQueryClient

pub fn clone(&self) -> ForecastQueryClient

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ForecastQuery for ForecastQueryClient

pub fn query_forecast<'life0, 'async_trait>(
    &'life0 self,
    input: QueryForecastRequest
) -> Pin<Box<dyn Future<Output = Result<QueryForecastResponse, RusotoError<QueryForecastError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves a forecast for a single item, filtered by the supplied criteria.

The criteria is a key-value pair. The key is either itemid (or the equivalent non-timestamp, non-target field) from the TARGETTIMESERIES 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 <a href="https://docs.aws.amazon.com/enus/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob operation.

The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.