Class: Aws::ForecastService::Types::DescribePredictorResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#algorithm_arnString

The Amazon Resource Name (ARN) of the algorithm used for model training.

Returns:

  • (String)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#auto_ml_algorithm_arnsArray<String>

When PerformAutoML is specified, the ARN of the chosen algorithm.

Returns:

  • (Array<String>)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#auto_ml_override_strategyString

The LatencyOptimized AutoML override strategy is only available in private beta. Contact AWS Support or your account manager to learn more about access privileges.

The AutoML strategy used to train the predictor. Unless LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy.

This parameter is only valid for predictors trained using AutoML.

Returns:

  • (String)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

When the model training task was created.

Returns:

  • (Time)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_import_job_arnsArray<String>

An array of the ARNs of the dataset import jobs used to import training data for the predictor.

Returns:

  • (Array<String>)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configTypes::EncryptionConfig

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.



3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_time_remaining_in_minutesInteger

The estimated time remaining in minutes for the predictor training job to complete.

Returns:

  • (Integer)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_parametersTypes::EvaluationParameters

Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.



3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#featurization_configTypes::FeaturizationConfig

The featurization configuration.



3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_horizonInteger

The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

Returns:

  • (Integer)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_typesArray<String>

The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]

Returns:

  • (Array<String>)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#hpo_configTypes::HyperParameterTuningJobConfig

The hyperparameter override values for the algorithm.



3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_configTypes::InputDataConfig

Describes the dataset group that contains the data to use to train the predictor.



3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#is_auto_predictorBoolean

Whether the predictor was created with CreateAutoPredictor.

Returns:

  • (Boolean)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#last_modification_timeTime

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)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#messageString

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

Returns:

  • (String)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_metricString

The accuracy metric used to optimize the predictor.

Returns:

  • (String)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#perform_auto_mlBoolean

Whether the predictor is set to perform AutoML.

Returns:

  • (Boolean)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#perform_hpoBoolean

Whether the predictor is set to perform hyperparameter optimization (HPO).

Returns:

  • (Boolean)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_arnString

The ARN of the predictor.

Returns:

  • (String)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_execution_detailsTypes::PredictorExecutionDetails

Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.



3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_nameString

The name of the predictor.

Returns:

  • (String)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  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

  • CREATE_STOPPING, CREATE_STOPPED

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

Returns:

  • (String)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end

#training_parametersHash<String,String>

The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

Returns:

  • (Hash<String,String>)


3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3326

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :auto_ml_algorithm_arns,
  :forecast_horizon,
  :forecast_types,
  :perform_auto_ml,
  :auto_ml_override_strategy,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :predictor_execution_details,
  :estimated_time_remaining_in_minutes,
  :is_auto_predictor,
  :dataset_import_job_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric)
  SENSITIVE = []
  include Aws::Structure
end