Class: Aws::ForecastService::Types::ExplainabilityExportSummary

Inherits:

Struct

• Object
• Struct
• Aws::ForecastService::Types::ExplainabilityExportSummary

Defined in:

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

Overview

Provides a summary of the Explainability export properties used in the ListExplainabilityExports operation. To get a complete set of properties, call the DescribeExplainabilityExport operation, and provide the ExplainabilityExportArn.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  When the Explainability was created.

• #destination ⇒ Types::DataDestination

  The destination for an export job.

• #explainability_export_arn ⇒ String

  The Amazon Resource Name (ARN) of the Explainability export.

• #explainability_export_name ⇒ String

  The name of the Explainability export.

• #last_modification_time ⇒ Time

  The last time the resource was modified.

• #message ⇒ String

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

• #status ⇒ String

  The status of the Explainability export.

Instance Attribute Details

#creation_time ⇒ Time

When the Explainability was created.

Returns:

• (Time)

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

class ExplainabilityExportSummary < Struct.new(
  :explainability_export_arn,
  :explainability_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ Types::DataDestination

The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).

Returns:

• (Types::DataDestination)

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

class ExplainabilityExportSummary < Struct.new(
  :explainability_export_arn,
  :explainability_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_export_arn ⇒ String

The Amazon Resource Name (ARN) of the Explainability export.

Returns:

• (String)

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

class ExplainabilityExportSummary < Struct.new(
  :explainability_export_arn,
  :explainability_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_export_name ⇒ String

The name of the Explainability export

Returns:

• (String)

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

class ExplainabilityExportSummary < Struct.new(
  :explainability_export_arn,
  :explainability_export_name,
  :destination,
  :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 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4002

class ExplainabilityExportSummary < Struct.new(
  :explainability_export_arn,
  :explainability_export_name,
  :destination,
  :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 export.

Returns:

• (String)

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

class ExplainabilityExportSummary < Struct.new(
  :explainability_export_arn,
  :explainability_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the Explainability export. 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 4002

class ExplainabilityExportSummary < Struct.new(
  :explainability_export_arn,
  :explainability_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end