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
- Struct
- Aws::ForecastService::Types::DescribeForecastResponse
- Defined in:
- (unknown)
Overview
Returned by:
Instance Attribute Summary collapse
-
#creation_time ⇒ Time
When the forecast creation task was created.
-
#dataset_group_arn ⇒ String
The ARN of the dataset group that provided the data used to train the predictor.
-
#forecast_arn ⇒ String
The forecast ARN as specified in the request.
-
#forecast_name ⇒ String
The name of the forecast.
-
#forecast_types ⇒ Array<String>
The quantiles at which probabilistic forecasts were generated.
-
#last_modification_time ⇒ Time
Initially, the same as
CreationTime
(status isCREATE_PENDING
). -
#message ⇒ String
If an error occurred, an informational message about the error.
-
#predictor_arn ⇒ String
The ARN of the predictor used to generate the forecast.
-
#status ⇒ String
The status of the forecast.
Instance Attribute Details
#creation_time ⇒ Time
When the forecast creation task was created.
#dataset_group_arn ⇒ String
The ARN of the dataset group that provided the data used to train the predictor.
#forecast_arn ⇒ String
The forecast ARN as specified in the request.
#forecast_name ⇒ String
The name of the forecast.
#forecast_types ⇒ Array<String>
The quantiles at which probabilistic forecasts were generated.
#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
).
#message ⇒ String
If an error occurred, an informational message about the error.
#predictor_arn ⇒ 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
Status
of the forecast must be ACTIVE
before you can query or
export the forecast.