Struct aws_sdk_forecastquery::client::Client

source · [−]

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Expand description

Client for Amazon Forecast Query Service

Client for invoking operations on Amazon Forecast Query Service. Each operation on Amazon Forecast Query Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_forecastquery::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_forecastquery::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_forecastquery::Client::from_conf(config);

Implementations

source

impl<C, M, R> Client<C, M, R>

source

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl<C, M, R> Client<C, M, R> where
 C: SmithyConnector,
 M: SmithyMiddleware<C>,
 R: NewRequestPolicy,

source

pub fn query_forecast(&self) -> QueryForecast<C, M, R>

Constructs a fluent builder for the QueryForecast operation.

The fluent builder is configurable:
- forecast_arn(impl Into<String>) / set_forecast_arn(Option<String>):
 The Amazon Resource Name (ARN) of the forecast to query.
- start_date(impl Into<String>) / set_start_date(Option<String>):
 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.
- end_date(impl Into<String>) / set_end_date(Option<String>):
 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.
- filters(HashMap<String, String>) / set_filters(Option<HashMap<String, String>>):
 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.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 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.
On success, responds with QueryForecastOutput with field(s):
- forecast(Option<Forecast>):
 The forecast.
On failure, responds with SdkError<QueryForecastError>