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

Class: Aws::ForecastService::Types::DescribeForecastResponse

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

When the forecast creation task was created.

Returns:

  • (Time)

    When the forecast creation task was created.

#dataset_group_arnString

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

Returns:

  • (String)

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

#forecast_arnString

The same forecast ARN as given in the request.

Returns:

  • (String)

    The same forecast ARN as given in the request.

#forecast_nameString

The name of the forecast.

Returns:

  • (String)

    The name of the forecast.

#last_modification_timeTime

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

#messageString

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

Returns:

  • (String)

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

#predictor_arnString

The ARN of the predictor used to generate the forecast.

Returns:

  • (String)

    The ARN of the predictor used to generate the forecast.

#statusString

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.