Struct aws_sdk_forecastquery::Client

pub struct Client { /* private fields */ }

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

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn query_forecast(&self) -> QueryForecast

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>

pub fn query_what_if_forecast(&self) -> QueryWhatIfForecast

Constructs a fluent builder for the QueryWhatIfForecast operation.

• The fluent builder is configurable:
  • what_if_forecast_arn(impl Into<String>) / set_what_if_forecast_arn(Option<String>):

    The Amazon Resource Name (ARN) of the what-if forecast to query.

  • start_date(impl Into<String>) / set_start_date(Option<String>):

    The start date for the what-if 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 what-if 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 what-if 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 QueryWhatIfForecastOutput with field(s):
  • forecast(Option<Forecast>):

    Provides information about a forecast. Returned as part of the QueryForecast response.

• On failure, responds with SdkError<QueryWhatIfForecastError>

impl Client

pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
    C: SmithyConnector<Error = E> + Send + 'static,
    E: Into<ConnectorError>, 

Creates a client with the given service config and connector override.

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.