describe_enrichment_job ¶

describe_enrichment_job(
    workspace_name: WorkspaceName,
    job_id: ID,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
) -> DescribeEnrichmentJobResponse

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

Parameters:

workspace_name (WorkspaceName) –

The name of the IoT SiteWise workspace containing the enrichment job.
job_id (ID) –

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

Raises:

AccessDeniedException –

Access is denied.
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.
InternalFailureException –

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

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
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 IoT SiteWise User Guide.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iotsitewise/_services/io_t_site_wise.py

def describe_enrichment_job(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    job_id: "capo_iotsitewise.types.id.ID",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
) -> "capo_iotsitewise.types.describe_enrichment_job_response.DescribeEnrichmentJobResponse":
    """<p>Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.</p> <h2>Use Cases</h2> <ul> <li>Monitor job progress by checking status updates with DescribeEnrichmentJob</li> <li>Retrieve the complete job configuration submitted during creation</li> <li>Debug failed jobs by examining the failureMessage field</li> <li>Track job lifecycle with creation, update, completion, and cancellation timestamps</li> </ul> <h2>Status Monitoring</h2> <p>Jobs progress through statuses: PENDING → RUNNING → terminal state</p> <p>Terminal states:</p> <ul> <li>COMPLETED: Job finished successfully; query IoT SiteWise for semantic search results</li> <li>FAILED: Job encountered an error; check failureMessage for details</li> <li>TIMED_OUT: Job exceeded maximum processing time</li> <li>CANCELLED: Job was cancelled via CancelEnrichmentJob</li> </ul> <h2>Response Fields</h2> <p>The response includes:</p> <ul> <li>Current job status and type</li> <li>Full job configuration as originally submitted</li> <li>Lifecycle timestamps (created, updated, completed, cancelled)</li> <li>Failure details if status is FAILED</li> </ul>

    Args:
        workspace_name: <p>The name of the IoT SiteWise workspace containing the enrichment job.</p>
        job_id: <p>The unique identifier of the enrichment job to retrieve. This is the jobId returned by CreateEnrichmentJob.</p>

    Raises:
        capo_iotsitewise.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iotsitewise.errors.conflicting_operation_exception.ConflictingOperationException: <p>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.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.limit_exceeded_exception.LimitExceededException: <p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.describe_enrichment_job_request.DescribeEnrichmentJobRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.describe_enrichment_job_response.DescribeEnrichmentJobResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.describe_enrichment_job

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.describe_enrichment_job.describe_enrichment_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEnrichmentJob")
    )
    input_: capo_iotsitewise.types.describe_enrichment_job_request.DescribeEnrichmentJobRequest = {
        "workspace_name": workspace_name,
        "job_id": job_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output