Skip to content

CreateEnrichmentJobRequest

Source code in docs_src/capo_iotsitewise/types/create_enrichment_job_request.py 
15
16
17
18
19
20
21
22
23
class CreateEnrichmentJobRequest(TypedDict, closed=True):
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the IoT SiteWise workspace containing the video data to analyze.</p>"""
    job_configuration: (
        "capo_iotsitewise.types.enrichment_job_configuration.EnrichmentJobConfiguration"
    )
    """<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: NotRequired["capo_iotsitewise.types.client_token.ClientToken"]
    """<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>"""

client_token instance-attribute 

client_token: NotRequired[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.

job_configuration instance-attribute 

job_configuration: EnrichmentJobConfiguration

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.

workspace_name instance-attribute 

workspace_name: WorkspaceName

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