Struct aws_sdk_forecast::operation::describe_what_if_forecast_export::DescribeWhatIfForecastExportOutput

#[non_exhaustive]
pub struct DescribeWhatIfForecastExportOutput {
    pub what_if_forecast_export_arn: Option<String>,
    pub what_if_forecast_export_name: Option<String>,
    pub what_if_forecast_arns: Option<Vec<String>>,
    pub destination: Option<DataDestination>,
    pub message: Option<String>,
    pub status: Option<String>,
    pub creation_time: Option<DateTime>,
    pub estimated_time_remaining_in_minutes: Option<i64>,
    pub last_modification_time: Option<DateTime>,
    pub format: Option<String>,
    /* 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.

what_if_forecast_export_arn: Option<String>

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

what_if_forecast_export_name: Option<String>

The name of the what-if forecast export.

what_if_forecast_arns: Option<Vec<String>>

An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.

destination: Option<DataDestination>

The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).

message: Option<String>

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

status: Option<String>

The status of the what-if 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 what-if forecast export must be ACTIVE before you can access the forecast export.

creation_time: Option<DateTime>

When the what-if forecast export was created.

estimated_time_remaining_in_minutes: Option<i64>

The approximate time remaining to complete the what-if forecast export, in minutes.

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.

format: Option<String>

The format of the exported data, CSV or PARQUET.

Implementations

impl DescribeWhatIfForecastExportOutput

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

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

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

The name of the what-if forecast export.

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

An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.

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

pub fn destination(&self) -> Option<&DataDestination>

The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).

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

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

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

The status of the what-if 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 what-if forecast export must be ACTIVE before you can access the forecast export.

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

When the what-if forecast export was created.

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

The approximate time remaining to complete the what-if forecast export, in minutes.

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 format(&self) -> Option<&str>

The format of the exported data, CSV or PARQUET.

impl DescribeWhatIfForecastExportOutput

pub fn builder() -> DescribeWhatIfForecastExportOutputBuilder

Creates a new builder-style object to manufacture DescribeWhatIfForecastExportOutput.

Trait Implementations

impl Clone for DescribeWhatIfForecastExportOutput

fn clone(&self) -> DescribeWhatIfForecastExportOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeWhatIfForecastExportOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeWhatIfForecastExportOutput

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

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

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

impl StructuralPartialEq for DescribeWhatIfForecastExportOutput