Class: Aws::ForecastService::Types::DescribeExplainabilityResponse

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

When the Explainability resource was created.

Returns:

  • (Time)


2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#data_sourceTypes::DataSource

The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an AWS Key Management Service (KMS) key.

Returns:



2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#enable_visualizationBoolean

Whether the visualization was enabled for the Explainability resource.

Returns:

  • (Boolean)


2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#end_date_timeString

If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.

Returns:

  • (String)


2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_time_remaining_in_minutesInteger

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

Returns:

  • (Integer)


2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_arnString

The Amazon Resource Name (ARN) of the Explainability.

Returns:

  • (String)


2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_configTypes::ExplainabilityConfig

The configuration settings that define the granularity of time series and time points for the Explainability.



2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_nameString

The name of the Explainability.

Returns:

  • (String)


2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  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)


2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#messageString

If an error occurred, a message about the error.

Returns:

  • (String)


2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arnString

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.

Returns:

  • (String)


2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#schemaTypes::Schema

Defines the fields of a dataset.

Returns:



2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_date_timeString

If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.

Returns:

  • (String)


2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the Explainability resource. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Returns:

  • (String)


2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2855

class DescribeExplainabilityResponse < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :enable_visualization,
  :data_source,
  :schema,
  :start_date_time,
  :end_date_time,
  :estimated_time_remaining_in_minutes,
  :message,
  :status,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end