EnrichmentJobSummary

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.

createdAt

Timestamp when the job was created in ISO 8601 format.

Type: Timestamp

Required: Yes

datasetId

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.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

jobId

Unique identifier for the enrichment job.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

jobType

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

Type: String

Valid Values: EVENT_DETECTION

Required: Yes

status

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

Type: String

Required: Yes

workspaceName

The name of the IoT SiteWise workspace containing this job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

propertyAlias

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\u0000-\u001F\u007F]+

Required: No

timeSeriesId

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.

Type: String

Length Constraints: Minimum length of 36. Maximum length of 73.

Required: No

updatedAt

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.

Type: Timestamp

Required: No

EnrichmentJobSummary

Contents

See Also