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

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#algorithm_arnString

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

Returns:

  • (String)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#auto_ml_algorithm_arnsArray<String>

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

Returns:

  • (Array<String>)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#creation_timeTime

When the model training task was created.

Returns:

  • (Time)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#dataset_import_job_arnsArray<String>

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

Returns:

  • (Array<String>)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  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.



1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  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.



1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#featurization_configTypes::FeaturizationConfig

The featurization configuration.



1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  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)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#hpo_configTypes::HyperParameterTuningJobConfig

The hyperparameter override values for the algorithm.



1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#input_data_configTypes::InputDataConfig

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



1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :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)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#messageString

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

Returns:

  • (String)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#perform_auto_mlBoolean

Whether the predictor is set to perform AutoML.

Returns:

  • (Boolean)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#perform_hpoBoolean

Whether the predictor is set to perform HPO.

Returns:

  • (Boolean)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#predictor_arnString

The ARN of the predictor.

Returns:

  • (String)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#predictor_nameString

The name of the predictor.

Returns:

  • (String)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :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)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#training_parametersHash<String,String>

The training parameters to override for model training. The parameters that you can override are listed in the individual algorithms in aws-forecast-choosing-recipes.

Returns:

  • (Hash<String,String>)


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1477

class DescribePredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :algorithm_arn,
  :forecast_horizon,
  :perform_auto_ml,
  :perform_hpo,
  :training_parameters,
  :evaluation_parameters,
  :hpo_config,
  :input_data_config,
  :featurization_config,
  :encryption_config,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end