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

Inherits:
Struct
  • Object
show all
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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ Time

When the model training task was created.

Returns:

  • (Time) 


6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6094

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) 


6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6094

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) 


6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6094

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) 


6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6094

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) 


6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6094

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) 


6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6094

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) 


6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6094

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:



6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6094

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) 


6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6094

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