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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_using_auto_predictorBoolean

Whether the Forecast was created from an AutoPredictor.

Returns:

  • (Boolean)


4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4110

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :created_using_auto_predictor,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

When the forecast creation task was created.

Returns:

  • (Time)


4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4110

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :created_using_auto_predictor,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_group_arnString

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

Returns:

  • (String)


4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4110

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :created_using_auto_predictor,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_arnString

The ARN of the forecast.

Returns:

  • (String)


4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4110

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :created_using_auto_predictor,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_nameString

The name of the forecast.

Returns:

  • (String)


4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4110

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :created_using_auto_predictor,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_modification_timeTime

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.

Returns:

  • (Time)


4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4110

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :created_using_auto_predictor,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#messageString

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

Returns:

  • (String)


4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4110

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :created_using_auto_predictor,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_arnString

The ARN of the predictor used to generate the forecast.

Returns:

  • (String)


4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4110

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :created_using_auto_predictor,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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

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

Returns:

  • (String)


4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4110

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :created_using_auto_predictor,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end