Class: Aws::ForecastService::Types::ExplainabilitySummary

Inherits:

Struct

• Object
• Struct
• Aws::ForecastService::Types::ExplainabilitySummary

Includes:

Structure

Defined in:

lib/aws-sdk-forecastservice/types.rb

Overview

Provides a summary of the Explainability properties used in the ListExplainabilities operation. To get a complete set of properties, call the DescribeExplainability operation, and provide the listed ‘ExplainabilityArn`.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  When the Explainability was created.

• #explainability_arn ⇒ String

  The Amazon Resource Name (ARN) of the Explainability.

• #explainability_config ⇒ Types::ExplainabilityConfig

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

• #explainability_name ⇒ String

  The name of the Explainability.

• #last_modification_time ⇒ Time

  The last time the resource was modified.

• #message ⇒ String

  Information about any errors that may have occurred during the Explainability creation process.

• #resource_arn ⇒ String

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

• #status ⇒ String

  The status of the Explainability.

Instance Attribute Details

#creation_time ⇒ Time

When the Explainability was created.

Returns:

• (Time)

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

class ExplainabilitySummary < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_arn ⇒ String

The Amazon Resource Name (ARN) of the Explainability.

Returns:

• (String)

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

class ExplainabilitySummary < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_config ⇒ Types::ExplainabilityConfig

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

Returns:

• (Types::ExplainabilityConfig)

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

class ExplainabilitySummary < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_name ⇒ String

The name of the Explainability.

Returns:

• (String)

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

class ExplainabilitySummary < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  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 'lib/aws-sdk-forecastservice/types.rb', line 4102

class ExplainabilitySummary < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

Information about any errors that may have occurred during the Explainability creation process.

Returns:

• (String)

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

class ExplainabilitySummary < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

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

Returns:

• (String)

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

class ExplainabilitySummary < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the Explainability. States include:

• ‘ACTIVE`

• ‘CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

• ‘CREATE_STOPPING`, `CREATE_STOPPED`

• ‘DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

Returns:

• (String)

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

class ExplainabilitySummary < Struct.new(
  :explainability_arn,
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end