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.

IdempotencyInclude 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.

PrerequisitesBefore 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