Class: Aws::ForecastService::Types::PredictorSummary

Inherits:

Struct

• Object
• Struct
• Aws::ForecastService::Types::PredictorSummary

Defined in:

gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

Provides a summary of the predictor properties that are used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed PredictorArn.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  When the model training task was created.

• #dataset_group_arn ⇒ String

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

• #is_auto_predictor ⇒ Boolean

  Whether AutoPredictor was used to create the predictor.

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

• #predictor_name ⇒ String

  The name of the predictor.

• #reference_predictor_summary ⇒ Types::ReferencePredictorSummary

  A summary of the reference predictor used if the predictor was retrained or upgraded.

• #status ⇒ String

  The status of the predictor.

Instance Attribute Details

#creation_time ⇒ Time

When the model training task was created.

Returns:

• (Time)

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

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :is_auto_predictor,
  :reference_predictor_summary,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_group_arn ⇒ String

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

Returns:

• (String)

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

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :is_auto_predictor,
  :reference_predictor_summary,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#is_auto_predictor ⇒ Boolean

Whether AutoPredictor was used to create the predictor.

Returns:

• (Boolean)

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

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :is_auto_predictor,
  :reference_predictor_summary,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  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 - 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)

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

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :is_auto_predictor,
  :reference_predictor_summary,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  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 6065

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :is_auto_predictor,
  :reference_predictor_summary,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_arn ⇒ String

The ARN of the predictor.

Returns:

• (String)

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

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :is_auto_predictor,
  :reference_predictor_summary,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_name ⇒ String

The name of the predictor.

Returns:

• (String)

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

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :is_auto_predictor,
  :reference_predictor_summary,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#reference_predictor_summary ⇒ Types::ReferencePredictorSummary

A summary of the reference predictor used if the predictor was retrained or upgraded.

Returns:

• (Types::ReferencePredictorSummary)

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

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :is_auto_predictor,
  :reference_predictor_summary,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the predictor. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Returns:

• (String)

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

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :is_auto_predictor,
  :reference_predictor_summary,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end