Struct aws_sdk_forecastquery::input::QueryWhatIfForecastInput

#[non_exhaustive]
pub struct QueryWhatIfForecastInput { /* private fields */ }

Implementations

impl QueryWhatIfForecastInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<QueryWhatIfForecast, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<QueryWhatIfForecast>

Examples found in repository

src/client.rs (line 298)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::QueryWhatIfForecast,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::QueryWhatIfForecastError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::QueryWhatIfForecastOutput,
            aws_smithy_http::result::SdkError<crate::error::QueryWhatIfForecastError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

pub fn builder() -> Builder

Creates a new builder-style object to manufacture QueryWhatIfForecastInput.

impl QueryWhatIfForecastInput

pub fn what_if_forecast_arn(&self) -> Option<&str>

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

pub fn start_date(&self) -> Option<&str>

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.

pub fn end_date(&self) -> Option<&str>

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.

pub fn filters(&self) -> 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.

pub fn next_token(&self) -> Option<&str>

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

impl Clone for QueryWhatIfForecastInput

fn clone(&self) -> QueryWhatIfForecastInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryWhatIfForecastInput

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

Formats the value using the given formatter.

impl PartialEq<QueryWhatIfForecastInput> for QueryWhatIfForecastInput

fn eq(&self, other: &QueryWhatIfForecastInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for QueryWhatIfForecastInput