Class: Aws::IoTSiteWise::Types::DescribeEnrichmentJobResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::DescribeEnrichmentJobResponse

Defined in:

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cancelled_at ⇒ Time

  Timestamp when the job was cancelled in ISO 8601 format.

• #completed_at ⇒ Time

  Timestamp when the job completed successfully in ISO 8601 format.

• #created_at ⇒ Time

  Timestamp when the enrichment job was created in ISO 8601 format.

• #failure_message ⇒ String

  Human-readable error message explaining why the job failed.

• #job_configuration ⇒ Types::EnrichmentJobConfiguration

  The complete job configuration as originally submitted, including the analysis type and parameters.

• #job_id ⇒ String

  The unique identifier of the enrichment job.

• #job_type ⇒ String

  The type of enrichment job, derived from the job configuration.

• #status ⇒ String

  Current status of the enrichment job.

• #updated_at ⇒ Time

  Timestamp when the job status was last updated in ISO 8601 format.

• #workspace_name ⇒ String

  The name of the IoT SiteWise workspace containing the job.

Instance Attribute Details

#cancelled_at ⇒ Time

Timestamp when the job was cancelled in ISO 8601 format. Only present if status is CANCELLED.

Returns:

• (Time)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7292

class DescribeEnrichmentJobResponse < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :job_configuration,
  :created_at,
  :updated_at,
  :completed_at,
  :cancelled_at,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#completed_at ⇒ Time

Timestamp when the job completed successfully in ISO 8601 format. Only present if status is COMPLETED.

Returns:

• (Time)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7292

class DescribeEnrichmentJobResponse < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :job_configuration,
  :created_at,
  :updated_at,
  :completed_at,
  :cancelled_at,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

Timestamp when the enrichment job was created in ISO 8601 format.

Returns:

• (Time)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7292

class DescribeEnrichmentJobResponse < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :job_configuration,
  :created_at,
  :updated_at,
  :completed_at,
  :cancelled_at,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#failure_message ⇒ String

Human-readable error message explaining why the job failed. Only present if status is FAILED. Use this information to diagnose configuration issues, permission problems, or data processing errors.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7292

class DescribeEnrichmentJobResponse < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :job_configuration,
  :created_at,
  :updated_at,
  :completed_at,
  :cancelled_at,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#job_configuration ⇒ Types::EnrichmentJobConfiguration

The complete job configuration as originally submitted, including the analysis type and parameters. For event detection jobs, this includes the dataset ID, time series identifier, and trim settings defining the analysis time range.

Returns:

• (Types::EnrichmentJobConfiguration)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7292

class DescribeEnrichmentJobResponse < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :job_configuration,
  :created_at,
  :updated_at,
  :completed_at,
  :cancelled_at,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

The unique identifier of the enrichment job.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7292

class DescribeEnrichmentJobResponse < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :job_configuration,
  :created_at,
  :updated_at,
  :completed_at,
  :cancelled_at,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#job_type ⇒ String

The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7292

class DescribeEnrichmentJobResponse < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :job_configuration,
  :created_at,
  :updated_at,
  :completed_at,
  :cancelled_at,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Current status of the enrichment job. Possible values:

• PENDING: Job is waiting to start processing
• RUNNING: Job is actively processing video data
• COMPLETED: Job finished successfully; embeddings available in IoT SiteWise
• FAILED: Job encountered an error; see failureMessage for details
• TIMED_OUT: Job exceeded maximum processing time limit
• CANCELLED: Job was cancelled by user request

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7292

class DescribeEnrichmentJobResponse < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :job_configuration,
  :created_at,
  :updated_at,
  :completed_at,
  :cancelled_at,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

Timestamp when the job status was last updated in ISO 8601 format. Useful for tracking recent activity.

Returns:

• (Time)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7292

class DescribeEnrichmentJobResponse < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :job_configuration,
  :created_at,
  :updated_at,
  :completed_at,
  :cancelled_at,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_name ⇒ String

The name of the IoT SiteWise workspace containing the job.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7292

class DescribeEnrichmentJobResponse < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :job_configuration,
  :created_at,
  :updated_at,
  :completed_at,
  :cancelled_at,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end