Skip to content

DescribeEnrichmentJobResponse

Source code in docs_src/capo_iotsitewise/types/describe_enrichment_job_response.py
class DescribeEnrichmentJobResponse(TypedDict, closed=True):
    job_id: "capo_iotsitewise.types.id.ID"
    """<p>The unique identifier of the enrichment job.</p>"""
    status: "capo_iotsitewise.types.enrichment_job_status.EnrichmentJobStatus"
    """<p>Current status of the enrichment job. Possible values:</p> <ul> <li>PENDING: Job is waiting to start processing</li> <li>RUNNING: Job is actively processing video data</li> <li>COMPLETED: Job finished successfully; embeddings available in IoT SiteWise</li> <li>FAILED: Job encountered an error; see failureMessage for details</li> <li>TIMED_OUT: Job exceeded maximum processing time limit</li> <li>CANCELLED: Job was cancelled by user request</li> </ul>"""
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the IoT SiteWise workspace containing the job.</p>"""
    job_type: "capo_iotsitewise.types.job_type.JobType"
    """<p>The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.</p>"""
    job_configuration: (
        "capo_iotsitewise.types.enrichment_job_configuration.EnrichmentJobConfiguration"
    )
    """<p>The complete job configuration as originally submitted, including the analysis type and parameters. For event detection jobs, this includes the dataset ID, time series identifier, and trim settings defining the analysis time range.</p>"""
    created_at: "datetime.datetime"
    """<p>Timestamp when the enrichment job was created in ISO 8601 format.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>Timestamp when the job status was last updated in ISO 8601 format. Useful for tracking recent activity.</p>"""
    completed_at: NotRequired["datetime.datetime"]
    """<p>Timestamp when the job completed successfully in ISO 8601 format. Only present if status is COMPLETED.</p>"""
    cancelled_at: NotRequired["datetime.datetime"]
    """<p>Timestamp when the job was cancelled in ISO 8601 format. Only present if status is CANCELLED.</p>"""
    failure_message: NotRequired["str"]
    """<p>Human-readable error message explaining why the job failed. Only present if status is FAILED. Use this information to diagnose configuration issues, permission problems, or data processing errors.</p>"""

cancelled_at instance-attribute

cancelled_at: NotRequired[datetime]

Timestamp when the job was cancelled in ISO 8601 format. Only present if status is CANCELLED.

completed_at instance-attribute

completed_at: NotRequired[datetime]

Timestamp when the job completed successfully in ISO 8601 format. Only present if status is COMPLETED.

created_at instance-attribute

created_at: datetime

Timestamp when the enrichment job was created in ISO 8601 format.

failure_message instance-attribute

failure_message: NotRequired[str]

Human-readable error message explaining why the job failed. Only present if status is FAILED. Use this information to diagnose configuration issues, permission problems, or data processing errors.

job_configuration instance-attribute

job_configuration: EnrichmentJobConfiguration

The complete job configuration as originally submitted, including the analysis type and parameters. For event detection jobs, this includes the dataset ID, time series identifier, and trim settings defining the analysis time range.

job_id instance-attribute

job_id: ID

The unique identifier of the enrichment job.

job_type instance-attribute

job_type: JobType

The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.

status instance-attribute

Current status of the enrichment job. Possible values:

  • PENDING: Job is waiting to start processing
  • RUNNING: Job is actively processing video data
  • COMPLETED: Job finished successfully; embeddings available in IoT SiteWise
  • FAILED: Job encountered an error; see failureMessage for details
  • TIMED_OUT: Job exceeded maximum processing time limit
  • CANCELLED: Job was cancelled by user request

updated_at instance-attribute

updated_at: NotRequired[datetime]

Timestamp when the job status was last updated in ISO 8601 format. Useful for tracking recent activity.

workspace_name instance-attribute

workspace_name: WorkspaceName

The name of the IoT SiteWise workspace containing the job.