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

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 used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed PredictorArn.

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

When the model training task was created.

Returns:

  • (Time)


2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2665

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#dataset_group_arnString

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

Returns:

  • (String)


2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2665

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#last_modification_timeTime

Initially, the same as CreationTime (status is CREATE_PENDING). Updated when training starts (status changed to CREATE_IN_PROGRESS), and when training is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).

Returns:

  • (Time)


2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2665

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#messageString

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

Returns:

  • (String)


2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2665

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#predictor_arnString

The ARN of the predictor.

Returns:

  • (String)


2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2665

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#predictor_nameString

The name of the predictor.

Returns:

  • (String)


2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2665

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#statusString

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The Status of the predictor must be ACTIVE before using the predictor to create a forecast.

Returns:

  • (String)


2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2665

class PredictorSummary < Struct.new(
  :predictor_arn,
  :predictor_name,
  :dataset_group_arn,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end