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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-forecastservice/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

When the Explainability was created.

Returns:

  • (Time)


3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3986

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_arnString

The Amazon Resource Name (ARN) of the Explainability.

Returns:

  • (String)


3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3986

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_configTypes::ExplainabilityConfig

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



3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3986

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_nameString

The name of the Explainability.

Returns:

  • (String)


3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3986

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_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)


3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3986

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

#messageString

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

Returns:

  • (String)


3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3986

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_arnString

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

Returns:

  • (String)


3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3986

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

#statusString

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)


3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3986

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