create_enrichment_job ¶

def create_enrichment_job(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    job_configuration: "capo_iotsitewise.types.enrichment_job_configuration.EnrichmentJobConfiguration",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
) -> "capo_iotsitewise.types.create_enrichment_job_response.CreateEnrichmentJobResponse":
    """<p>Creates an asynchronous enrichment job to analyze time-series sensor data. The operation returns immediately with job details while processing continues in the background.</p> <h2>Idempotency</h2> <p>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.</p> <h2>Prerequisites</h2> <p>Before creating a job, ensure:</p> <ul> <li>The workspace is in ACTIVE state (not being deleted)</li> <li>You have IAM permissions for the workspace, dataset, and time-series resources</li> <li>You have KMS Decrypt permission on the workspace's customer-managed encryption key</li> <li>No duplicate job (same workspace, dataset, property, and job type) is currently running</li> </ul> <h2>Workflow</h2> <ol> <li>Submit the job with configuration specifying which video data to analyze and the time range</li> <li>Capture the jobId from the response</li> <li>Use DescribeEnrichmentJob to monitor progress and check job status</li> <li>When status reaches a terminal state (COMPLETED, FAILED, TIMED_OUT, CANCELLED), check results</li> <li>For COMPLETED jobs, query IoT SiteWise for semantic search on video events</li> </ol> <h2>Error Handling</h2> <ul> <li>ConflictingOperationException: A duplicate job is already running for the same configuration</li> <li>InvalidRequestException: Invalid parameters (e.g., both timeSeriesId and propertyAlias specified)</li> <li>AccessDeniedException: Insufficient IAM or KMS permissions</li> <li>LimitExceededException: Too many concurrent jobs or requests</li> </ul>

    Args:
        workspace_name: <p>The name of the IoT SiteWise workspace containing the video data to analyze.</p>
        job_configuration: <p>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.</p>
        client_token: <p>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.</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.create_enrichment_job_request.CreateEnrichmentJobRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.create_enrichment_job_response.CreateEnrichmentJobResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.create_enrichment_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateEnrichmentJob")
    )
    input_: capo_iotsitewise.types.create_enrichment_job_request.CreateEnrichmentJobRequest = {
        "workspace_name": workspace_name,
        "job_configuration": job_configuration,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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