Class: Aws::ForecastService::Types::DescribeAutoPredictorResponse

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

#creation_timeTime

The timestamp of the CreateAutoPredictor request.

Returns:

  • (Time)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end

#data_configTypes::DataConfig

The data configuration for your dataset group and any additional datasets.

Returns:



2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  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>)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configTypes::EncryptionConfig

An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.



2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  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)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_infoTypes::ExplainabilityInfo

Provides the status and ARN of the Predictor Explainability.



2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_dimensionsArray<String>

An array of dimension (field) names that specify the attributes used to group your time series.

Returns:

  • (Array<String>)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_frequencyString

The frequency of predictions in a forecast.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.

Returns:

  • (String)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_horizonInteger

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

Returns:

  • (Integer)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  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>)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  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)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end

#messageString

In the event of an error, a message detailing the cause of the error.

Returns:

  • (String)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_metricString

The accuracy metric used to optimize the predictor.

Returns:

  • (String)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_arnString

The Amazon Resource Name (ARN) of the predictor

Returns:

  • (String)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_nameString

The name of the predictor.

Returns:

  • (String)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end

#reference_predictor_summaryTypes::ReferencePredictorSummary

The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.



2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Returns:

  • (String)


2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2311

class DescribeAutoPredictorResponse < Struct.new(
  :predictor_arn,
  :predictor_name,
  :forecast_horizon,
  :forecast_types,
  :forecast_frequency,
  :forecast_dimensions,
  :dataset_import_job_arns,
  :data_config,
  :encryption_config,
  :reference_predictor_summary,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :optimization_metric,
  :explainability_info)
  SENSITIVE = []
  include Aws::Structure
end