You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ForecastService::Types::ForecastSummary

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Provides a summary of the forecast properties used in the ListForecasts operation. To get the complete set of properties, call the DescribeForecast operation, and provide the ForecastArn that is listed in the summary.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ Time

When the forecast creation task was created.

Returns:

  • (Time) —

    When the forecast creation task was created.

#dataset_group_arn ⇒ String

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

#forecast_arn ⇒ String

The ARN of the forecast.

Returns:

  • (String) —

    The ARN of the forecast.

#forecast_name ⇒ String

The name of the forecast.

Returns:

  • (String) —

    The name of the forecast.

#last_modification_time ⇒ Time

Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).

Returns:

  • (Time) —

    Initially, the same as CreationTime (status is CREATE_PENDING).

#message ⇒ String

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

Returns:

  • (String) —

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

#predictor_arn ⇒ String

The ARN of the predictor used to generate the forecast.

Returns:

  • (String) —

    The ARN of the predictor used to generate the forecast.

#status ⇒ String

The status of the forecast. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

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

Returns:

  • (String) —

    The status of the forecast.