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)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#auto_ml_algorithm_arnsArray<String>

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

Returns:

  • (Array<String>)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

When the model training task was created.

Returns:

  • (Time)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  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>)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  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.



1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  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.



1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#featurization_configTypes::FeaturizationConfig

The featurization configuration.



1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  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)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#hpo_configTypes::HyperParameterTuningJobConfig

The hyperparameter override values for the algorithm.



1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_configTypes::InputDataConfig

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



1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_modification_timeTime

Initially, the same as CreationTime (when the status is CREATE_PENDING). This value is updated when training starts (when the status changes to CREATE_IN_PROGRESS), and when training has completed (when the status changes to ACTIVE) or fails (when the status changes to CREATE_FAILED).

Returns:

  • (Time)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#messageString

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

Returns:

  • (String)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#perform_auto_mlBoolean

Whether the predictor is set to perform AutoML.

Returns:

  • (Boolean)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#perform_hpoBoolean

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

Returns:

  • (Boolean)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_arnString

The ARN of the predictor.

Returns:

  • (String)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  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.



1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_nameString

The name of the predictor.

Returns:

  • (String)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  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

  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

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

Returns:

  • (String)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#training_parametersHash<String,String>

The default training parameters or overrides selected during model training. If using the AutoML algorithm or if HPO is turned on while using the DeepAR+ algorithms, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

Returns:

  • (Hash<String,String>)


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1828

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,
  :predictor_execution_details,
  :dataset_import_job_arns,
  :auto_ml_algorithm_arns,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end