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

Inherits:

Struct

• Object
• Struct
• Aws::ForecastService::Types::DescribeAutoPredictorResponse

Defined in:

gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  The timestamp of the CreateAutoPredictor request.

• #data_config ⇒ Types::DataConfig

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

• #dataset_import_job_arns ⇒ Array<String>

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

• #encryption_config ⇒ Types::EncryptionConfig

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

• #estimated_time_remaining_in_minutes ⇒ Integer

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

• #explainability_info ⇒ Types::ExplainabilityInfo

  Provides the status and ARN of the Predictor Explainability.

• #forecast_dimensions ⇒ Array<String>

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

• #forecast_frequency ⇒ String

  The frequency of predictions in a forecast.

• #forecast_horizon ⇒ Integer

  The number of time-steps that the model predicts.

• #forecast_types ⇒ Array<String>

  The forecast types used during predictor training.

• #last_modification_time ⇒ Time

  The last time the resource was modified.

• #message ⇒ String

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

• #monitor_info ⇒ Types::MonitorInfo

  A object with the Amazon Resource Name (ARN) and status of the monitor resource.

• #optimization_metric ⇒ String

  The accuracy metric used to optimize the predictor.

• #predictor_arn ⇒ String

  The Amazon Resource Name (ARN) of the predictor.

• #predictor_name ⇒ String

  The name of the predictor.

• #reference_predictor_summary ⇒ Types::ReferencePredictorSummary

  The ARN and state of the reference predictor.

• #status ⇒ String

  The status of the predictor.

• #time_alignment_boundary ⇒ Types::TimeAlignmentBoundary

  The time boundary Forecast uses when aggregating data.

Instance Attribute Details

#creation_time ⇒ Time

The timestamp of the CreateAutoPredictor request.

Returns:

• (Time)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#data_config ⇒ Types::DataConfig

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

Returns:

• (Types::DataConfig)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_import_job_arns ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_config ⇒ Types::EncryptionConfig

An Key Management Service (KMS) key and an 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.

Returns:

• (Types::EncryptionConfig)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_time_remaining_in_minutes ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_info ⇒ Types::ExplainabilityInfo

Provides the status and ARN of the Predictor Explainability.

Returns:

• (Types::ExplainabilityInfo)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_dimensions ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_frequency ⇒ String

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)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_horizon ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_types ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#last_modification_time ⇒ Time

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)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#monitor_info ⇒ Types::MonitorInfo

A object with the Amazon Resource Name (ARN) and status of the monitor resource.

Returns:

• (Types::MonitorInfo)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#optimization_metric ⇒ String

The accuracy metric used to optimize the predictor.

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_arn ⇒ String

The Amazon Resource Name (ARN) of the predictor

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_name ⇒ String

The name of the predictor.

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#reference_predictor_summary ⇒ Types::ReferencePredictorSummary

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

Returns:

• (Types::ReferencePredictorSummary)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end

#time_alignment_boundary ⇒ Types::TimeAlignmentBoundary

The time boundary Forecast uses when aggregating data.

Returns:

• (Types::TimeAlignmentBoundary)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2379

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,
  :monitor_info,
  :time_alignment_boundary)
  SENSITIVE = []
  include Aws::Structure
end