describeEnrichmentJob method

Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.

Use Cases

• Monitor job progress by checking status updates with DescribeEnrichmentJob
• Retrieve the complete job configuration submitted during creation
• Debug failed jobs by examining the failureMessage field
• Track job lifecycle with creation, update, completion, and cancellation timestamps

Status Monitoring

Jobs progress through statuses: PENDING → RUNNING → terminal state

Terminal states:

• COMPLETED: Job finished successfully; query IoT SiteWise for semantic search results
• FAILED: Job encountered an error; check failureMessage for details
• TIMED_OUT: Job exceeded maximum processing time
• CANCELLED: Job was cancelled via CancelEnrichmentJob

Response Fields

The response includes:

• Current job status and type
• Full job configuration as originally submitted
• Lifecycle timestamps (created, updated, completed, cancelled)
• Failure details if status is FAILED

May throw AccessDeniedException. May throw ConflictingOperationException. May throw InternalFailureException. May throw InvalidRequestException. May throw LimitExceededException. May throw ResourceNotFoundException. May throw ThrottlingException.

Parameter jobId : The unique identifier of the enrichment job to retrieve. This is the jobId returned by CreateEnrichmentJob.

Parameter workspaceName : The name of the IoT SiteWise workspace containing the enrichment job.

Future<DescribeEnrichmentJobResponse> describeEnrichmentJob({
  required String jobId,
  required String workspaceName,
}) async {
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/workspaces/${Uri.encodeComponent(workspaceName)}/enrichment-jobs/${Uri.encodeComponent(jobId)}',
    hostPrefix: 'data.',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeEnrichmentJobResponse.fromJson(response);
}