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

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

Inherits:

Struct

• Object
• Struct
• Aws::ForecastService::Types::ForecastSummary

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 listed ForecastArn.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #creation_time ⇒ Time

  When the forecast creation task was created.

• #dataset_group_arn ⇒ String

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

• #forecast_arn ⇒ String

  The ARN of the forecast.

• #forecast_name ⇒ String

  The name of the forecast.

• #last_modification_time ⇒ Time

  Initially, the same as CreationTime (status is CREATE_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.

Returns:

• (Time)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1924

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

#dataset_group_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1924

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

#forecast_arn ⇒ String

The ARN of the forecast.

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1924

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

#forecast_name ⇒ String

The name of the forecast.

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1924

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

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

Returns:

• (Time)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1924

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

#message ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1924

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

#predictor_arn ⇒ String

The ARN of the predictor used to generate the forecast.

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1924

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

#status ⇒ String

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)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1924

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