Struct DescribeForecastOutput 

#[non_exhaustive]
pub struct DescribeForecastOutput {
    pub forecast_arn: Option<String>,
    pub forecast_name: Option<String>,
    pub forecast_types: Option<Vec<String>>,
    pub predictor_arn: Option<String>,
    pub dataset_group_arn: Option<String>,
    pub estimated_time_remaining_in_minutes: Option<i64>,
    pub status: Option<String>,
    pub message: Option<String>,
    pub creation_time: Option<DateTime>,
    pub last_modification_time: Option<DateTime>,
    pub time_series_selector: Option<TimeSeriesSelector>,
    /* private fields */
}

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 forecast ARN as specified in the request.

forecast_name: Option<String>

The name of the forecast.

forecast_types: Option<Vec<String>>

The quantiles at which probabilistic forecasts were generated.

predictor_arn: Option<String>

The ARN of the predictor used to generate the forecast.

dataset_group_arn: Option<String>

The ARN of the dataset group that provided the data used to train the predictor.

estimated_time_remaining_in_minutes: Option<i64>

The estimated time remaining in minutes for the forecast job to complete.

status: Option<String>

The status of the forecast. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

message: Option<String>

If an error occurred, an informational message about the error.

creation_time: Option<DateTime>

When the forecast creation task was created.

last_modification_time: Option<DateTime>

The last time the resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• CREATE_STOPPING - The current timestamp.

• CREATE_STOPPED - When the job stopped.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

time_series_selector: Option<TimeSeriesSelector>

The time series to include in the forecast.

Implementations

impl DescribeForecastOutput

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

The forecast ARN as specified in the request.

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

The name of the forecast.

pub fn forecast_types(&self) -> &[String]

The quantiles at which probabilistic forecasts were generated.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .forecast_types.is_none().

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

The ARN of the predictor used to generate the forecast.

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

The ARN of the dataset group that provided the data used to train the predictor.

pub fn estimated_time_remaining_in_minutes(&self) -> Option<i64>

The estimated time remaining in minutes for the forecast job to complete.

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

The status of the forecast. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

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

If an error occurred, an informational message about the error.

pub fn creation_time(&self) -> Option<&DateTime>

When the forecast creation task was created.

pub fn last_modification_time(&self) -> Option<&DateTime>

The last time the resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• CREATE_STOPPING - The current timestamp.

• CREATE_STOPPED - When the job stopped.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

pub fn time_series_selector(&self) -> Option<&TimeSeriesSelector>

The time series to include in the forecast.

impl DescribeForecastOutput

pub fn builder() -> DescribeForecastOutputBuilder

Creates a new builder-style object to manufacture DescribeForecastOutput.

Trait Implementations

impl Clone for DescribeForecastOutput

fn clone(&self) -> DescribeForecastOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeForecastOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeForecastOutput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RequestId for DescribeForecastOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeForecastOutput