Struct aws_sdk_forecastquery::operation::query_forecast::QueryForecastInput

#[non_exhaustive]
pub struct QueryForecastInput {
    pub forecast_arn: Option<String>,
    pub start_date: Option<String>,
    pub end_date: Option<String>,
    pub filters: Option<HashMap<String, String>>,
    pub next_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

forecast_arn: Option<String>

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

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: 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: 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: 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.

Implementations

impl QueryForecastInput

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

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

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

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.

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

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.

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 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.

impl QueryForecastInput

pub fn builder() -> QueryForecastInputBuilder

Creates a new builder-style object to manufacture QueryForecastInput.

Trait Implementations

impl Clone for QueryForecastInput

fn clone(&self) -> QueryForecastInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryForecastInput

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

Formats the value using the given formatter.

impl PartialEq for QueryForecastInput

fn eq(&self, other: &QueryForecastInput) -> 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 QueryForecastInput