Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateEnrichmentJob

Creates an asynchronous enrichment job to analyze time-series sensor data. The operation returns immediately with job details while processing continues in the background.

Idempotency

Include a clientToken to make the operation idempotent. If you submit the same request with the same token within the idempotency window, you receive the original job details without creating a duplicate.

Prerequisites

Before creating a job, ensure:

The workspace is in ACTIVE state (not being deleted)
You have IAM permissions for the workspace, dataset, and time-series resources
You have KMS Decrypt permission on the workspace's customer-managed encryption key
No duplicate job (same workspace, dataset, property, and job type) is currently running

Workflow

Submit the job with configuration specifying which video data to analyze and the time range
Capture the jobId from the response
Use DescribeEnrichmentJob to monitor progress and check job status
When status reaches a terminal state (COMPLETED, FAILED, TIMED_OUT, CANCELLED), check results
For COMPLETED jobs, query IoT SiteWise for semantic search on video events

Error Handling

ConflictingOperationException: A duplicate job is already running for the same configuration
InvalidRequestException: Invalid parameters (e.g., both timeSeriesId and propertyAlias specified)
AccessDeniedException: Insufficient IAM or KMS permissions
LimitExceededException: Too many concurrent jobs or requests

Request Syntax


POST /workspaces/workspaceName/enrichment-jobs HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "jobConfiguration": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

workspaceName

The name of the IoT SiteWise workspace containing the video data to analyze.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

Optional unique token that makes the operation idempotent. If you submit the same request with the same token within the idempotency window, the service returns the original job without creating a duplicate. Use a UUID or timestamp-based token for each unique request.

Type: String

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

Pattern: \S{36,64}

Required: No

jobConfiguration

Configuration defining the type of enrichment analysis to perform and which video data to analyze. Currently supports eventDetection for generating embeddings from video data for semantic search.

Type: EnrichmentJobConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "jobId": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdAt

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

Type: Timestamp

jobId

Unique identifier for the enrichment job. Use this ID with DescribeEnrichmentJob to monitor progress or with CancelEnrichmentJob to cancel the 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}$

status

Initial status of the enrichment job, typically PENDING. The job will transition to RUNNING when processing begins, then to a terminal state (COMPLETED, FAILED, TIMED_OUT, or CANCELLED). Use DescribeEnrichmentJob to track status changes.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Access is denied.

HTTP Status Code: 403

ConflictingOperationException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

resourceArn: The ARN of the resource that conflicts with this operation.
resourceId: The ID of the resource that conflicts with this operation.

HTTP Status Code: 409

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

LimitExceededException

You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 410

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429