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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_forecastquery::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_forecastquery::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the QueryForecast operation has a Client::query_forecast, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.query_forecast()
    .forecast_arn("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn query_forecast(&self) -> QueryForecastFluentBuilder

Constructs a fluent builder for the QueryForecast operation.

• The fluent builder is configurable:
  • forecast_arn(impl Into<String>) / set_forecast_arn(Option<String>):
    required: true
    

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

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

    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>):
    required: false
    

    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(impl Into<String>, impl Into<String>) / set_filters(Option<HashMap::<String, String>>):
    required: true
    

    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>):
    required: false
    

    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>

impl Client

pub fn query_what_if_forecast(&self) -> QueryWhatIfForecastFluentBuilder

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>):
    required: true
    

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

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

    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>):
    required: false
    

    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(impl Into<String>, impl Into<String>) / set_filters(Option<HashMap::<String, String>>):
    required: true
    

    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>):
    required: false
    

    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(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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.