Class: Aws::ForecastService::Types::DescribeExplainabilityExportResponse

Inherits:

Struct

• Object
• Struct
• Aws::ForecastService::Types::DescribeExplainabilityExportResponse

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

  When the Explainability export was created.

• #destination ⇒ Types::DataDestination

  The destination for an export job.

• #explainability_arn ⇒ String

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

• #explainability_export_arn ⇒ String

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

• #explainability_export_name ⇒ String

  The name of the Explainability export.

• #format ⇒ String

  The format of the exported data, CSV or PARQUET.

• #last_modification_time ⇒ Time

  The last time the resource was modified.

• #message ⇒ String

  Information about any errors that occurred during the export.

• #status ⇒ String

  The status of the Explainability export.

Instance Attribute Details

#creation_time ⇒ Time

When the Explainability export was created.

Returns:

• (Time)

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

class DescribeExplainabilityExportResponse < Struct.new(
  :explainability_export_arn,
  :explainability_export_name,
  :explainability_arn,
  :destination,
  :message,
  :status,
  :creation_time,
  :last_modification_time,
  :format)
  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 2810

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

#explainability_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 2810

class DescribeExplainabilityExportResponse < Struct.new(
  :explainability_export_arn,
  :explainability_export_name,
  :explainability_arn,
  :destination,
  :message,
  :status,
  :creation_time,
  :last_modification_time,
  :format)
  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 2810

class DescribeExplainabilityExportResponse < Struct.new(
  :explainability_export_arn,
  :explainability_export_name,
  :explainability_arn,
  :destination,
  :message,
  :status,
  :creation_time,
  :last_modification_time,
  :format)
  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 2810

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

#format ⇒ String

The format of the exported data, CSV or PARQUET.

Returns:

• (String)

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

class DescribeExplainabilityExportResponse < Struct.new(
  :explainability_export_arn,
  :explainability_export_name,
  :explainability_arn,
  :destination,
  :message,
  :status,
  :creation_time,
  :last_modification_time,
  :format)
  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 2810

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

#message ⇒ String

Information about any errors that occurred during the export.

Returns:

• (String)

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

class DescribeExplainabilityExportResponse < Struct.new(
  :explainability_export_arn,
  :explainability_export_name,
  :explainability_arn,
  :destination,
  :message,
  :status,
  :creation_time,
  :last_modification_time,
  :format)
  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 2810

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