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

#creation_timeTime

When the forecast creation task was created.

Returns:

  • (Time)


2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2313

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :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)


2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2313

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

#forecast_arnString

The ARN of the forecast.

Returns:

  • (String)


2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2313

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

#forecast_nameString

The name of the forecast.

Returns:

  • (String)


2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2313

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

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


2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2313

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :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)


2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2313

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :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)


2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2313

class ForecastSummary < Struct.new(
  :forecast_arn,
  :forecast_name,
  :predictor_arn,
  :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

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


2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2313

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