Class: Aws::IoTSiteWise::Types::EnrichmentJobSummary

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::EnrichmentJobSummary

Defined in:

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

Overview

Summary information for an enrichment job returned by ListEnrichmentJobs. This lightweight representation includes identifiers, status, and key metadata without the full job configuration.

Use DescribeEnrichmentJob to retrieve:

• Complete job configuration (trim settings, full parameters)
• Detailed timestamps (completedAt, cancelledAt)
• Failure messages for failed jobs

The summary is optimized for display in lists and dashboards, providing enough information to identify and filter jobs without the overhead of full configuration details.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  Timestamp when the job was created in ISO 8601 format.

• #dataset_id ⇒ String

  The dataset being enriched.

• #job_id ⇒ String

  Unique identifier for the enrichment job.

• #job_type ⇒ String

  The type of enrichment job.

• #property_alias ⇒ String

  The property alias (human-readable sensor name) of the time series being enriched.

• #status ⇒ String

  Current status of the job: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, or CANCELLED.

• #time_series_id ⇒ String

  The system identifier of the time series being enriched.

• #updated_at ⇒ Time

  Timestamp of the last job status change in ISO 8601 format.

• #workspace_name ⇒ String

  The name of the IoT SiteWise workspace containing this job.

Instance Attribute Details

#created_at ⇒ Time

Timestamp when the job was created in ISO 8601 format.

Returns:

• (Time)

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

class EnrichmentJobSummary < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :dataset_id,
  :property_alias,
  :time_series_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_id ⇒ String

The dataset being enriched. Useful for filtering and identifying jobs without fetching the full configuration. This allows you to quickly find all jobs related to a specific dataset.

Returns:

• (String)

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

class EnrichmentJobSummary < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :dataset_id,
  :property_alias,
  :time_series_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

Unique identifier for the enrichment job.

Returns:

• (String)

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

class EnrichmentJobSummary < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :dataset_id,
  :property_alias,
  :time_series_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#job_type ⇒ String

The type of enrichment job. Currently EVENT_DETECTION is the only supported type.

Returns:

• (String)

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

class EnrichmentJobSummary < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :dataset_id,
  :property_alias,
  :time_series_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#property_alias ⇒ String

The property alias (human-readable sensor name) of the time series being enriched. Present when the job was created using a propertyAlias. Use this to identify which sensor the job analyzes.

Returns:

• (String)

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

class EnrichmentJobSummary < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :dataset_id,
  :property_alias,
  :time_series_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Current status of the job: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, or CANCELLED. Use this to quickly identify active jobs or jobs requiring attention.

Returns:

• (String)

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

class EnrichmentJobSummary < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :dataset_id,
  :property_alias,
  :time_series_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_id ⇒ String

The system identifier of the time series being enriched. Present when the job was created using a timeSeriesId. Use this to identify which time series the job analyzes.

Returns:

• (String)

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

class EnrichmentJobSummary < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :dataset_id,
  :property_alias,
  :time_series_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

Timestamp of the last job status change in ISO 8601 format. Use this to track recent activity and identify stale jobs. For active jobs, this shows the last time the job transitioned to a new status.

Returns:

• (Time)

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

class EnrichmentJobSummary < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :dataset_id,
  :property_alias,
  :time_series_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_name ⇒ String

The name of the IoT SiteWise workspace containing this job.

Returns:

• (String)

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

class EnrichmentJobSummary < Struct.new(
  :job_id,
  :status,
  :workspace_name,
  :job_type,
  :dataset_id,
  :property_alias,
  :time_series_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end