Class: Aws::ForecastService::Types::DescribeForecastResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::ForecastService::Types::DescribeForecastResponse
- Defined in:
- gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
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.
-
#estimated_time_remaining_in_minutes ⇒ Integer
The estimated time remaining in minutes for the forecast job to complete.
-
#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
The last time the resource was modified.
-
#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.
-
#time_series_selector ⇒ Types::TimeSeriesSelector
The time series to include in the forecast.
Instance Attribute Details
#creation_time ⇒ Time
When the forecast creation task was created.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3368 class DescribeForecastResponse < Struct.new( :forecast_arn, :forecast_name, :forecast_types, :predictor_arn, :dataset_group_arn, :estimated_time_remaining_in_minutes, :status, :message, :creation_time, :last_modification_time, :time_series_selector) SENSITIVE = [] include Aws::Structure end |
#dataset_group_arn ⇒ String
The ARN of the dataset group that provided the data used to train the predictor.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3368 class DescribeForecastResponse < Struct.new( :forecast_arn, :forecast_name, :forecast_types, :predictor_arn, :dataset_group_arn, :estimated_time_remaining_in_minutes, :status, :message, :creation_time, :last_modification_time, :time_series_selector) SENSITIVE = [] include Aws::Structure end |
#estimated_time_remaining_in_minutes ⇒ Integer
The estimated time remaining in minutes for the forecast job to complete.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3368 class DescribeForecastResponse < Struct.new( :forecast_arn, :forecast_name, :forecast_types, :predictor_arn, :dataset_group_arn, :estimated_time_remaining_in_minutes, :status, :message, :creation_time, :last_modification_time, :time_series_selector) SENSITIVE = [] include Aws::Structure end |
#forecast_arn ⇒ String
The forecast ARN as specified in the request.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3368 class DescribeForecastResponse < Struct.new( :forecast_arn, :forecast_name, :forecast_types, :predictor_arn, :dataset_group_arn, :estimated_time_remaining_in_minutes, :status, :message, :creation_time, :last_modification_time, :time_series_selector) SENSITIVE = [] include Aws::Structure end |
#forecast_name ⇒ String
The name of the forecast.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3368 class DescribeForecastResponse < Struct.new( :forecast_arn, :forecast_name, :forecast_types, :predictor_arn, :dataset_group_arn, :estimated_time_remaining_in_minutes, :status, :message, :creation_time, :last_modification_time, :time_series_selector) SENSITIVE = [] include Aws::Structure end |
#forecast_types ⇒ Array<String>
The quantiles at which probabilistic forecasts were generated.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3368 class DescribeForecastResponse < Struct.new( :forecast_arn, :forecast_name, :forecast_types, :predictor_arn, :dataset_group_arn, :estimated_time_remaining_in_minutes, :status, :message, :creation_time, :last_modification_time, :time_series_selector) SENSITIVE = [] include Aws::Structure end |
#last_modification_time ⇒ Time
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3368 class DescribeForecastResponse < Struct.new( :forecast_arn, :forecast_name, :forecast_types, :predictor_arn, :dataset_group_arn, :estimated_time_remaining_in_minutes, :status, :message, :creation_time, :last_modification_time, :time_series_selector) SENSITIVE = [] include Aws::Structure end |
#message ⇒ String
If an error occurred, an informational message about the error.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3368 class DescribeForecastResponse < Struct.new( :forecast_arn, :forecast_name, :forecast_types, :predictor_arn, :dataset_group_arn, :estimated_time_remaining_in_minutes, :status, :message, :creation_time, :last_modification_time, :time_series_selector) SENSITIVE = [] include Aws::Structure end |
#predictor_arn ⇒ String
The ARN of the predictor used to generate the forecast.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3368 class DescribeForecastResponse < Struct.new( :forecast_arn, :forecast_name, :forecast_types, :predictor_arn, :dataset_group_arn, :estimated_time_remaining_in_minutes, :status, :message, :creation_time, :last_modification_time, :time_series_selector) SENSITIVE = [] include Aws::Structure end |
#status ⇒ 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
Status
of the forecast must be ACTIVE
before you can query
or export the forecast.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3368 class DescribeForecastResponse < Struct.new( :forecast_arn, :forecast_name, :forecast_types, :predictor_arn, :dataset_group_arn, :estimated_time_remaining_in_minutes, :status, :message, :creation_time, :last_modification_time, :time_series_selector) SENSITIVE = [] include Aws::Structure end |
#time_series_selector ⇒ Types::TimeSeriesSelector
The time series to include in the forecast.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3368 class DescribeForecastResponse < Struct.new( :forecast_arn, :forecast_name, :forecast_types, :predictor_arn, :dataset_group_arn, :estimated_time_remaining_in_minutes, :status, :message, :creation_time, :last_modification_time, :time_series_selector) SENSITIVE = [] include Aws::Structure end |