Skip to content

EnrichmentJobSummary

Source code in docs_src/capo_iotsitewise/types/enrichment_job_summary.py
class EnrichmentJobSummary(TypedDict, closed=True):
    job_id: "capo_iotsitewise.types.id.ID"
    """<p>Unique identifier for the enrichment job.</p>"""
    status: "capo_iotsitewise.types.enrichment_job_status.EnrichmentJobStatus"
    """<p>Current status of the job: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, or CANCELLED. Use this to quickly identify active jobs or jobs requiring attention.</p>"""
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the IoT SiteWise workspace containing this job.</p>"""
    job_type: "capo_iotsitewise.types.job_type.JobType"
    """<p>The type of enrichment job. Currently EVENT_DETECTION is the only supported type.</p>"""
    dataset_id: "capo_iotsitewise.types.id.ID"
    """<p>The dataset being enriched. Useful for filtering and identifying jobs without fetching the full configuration. This allows you to quickly find all jobs related to a specific dataset.</p>"""
    property_alias: NotRequired[
        "capo_iotsitewise.types.asset_property_alias.AssetPropertyAlias"
    ]
    """<p>The property alias (human-readable sensor name) of the time series being enriched. Present when the job was created using a propertyAlias. Use this to identify which sensor the job analyzes.</p>"""
    time_series_id: NotRequired["capo_iotsitewise.types.time_series_id.TimeSeriesId"]
    """<p>The system identifier of the time series being enriched. Present when the job was created using a timeSeriesId. Use this to identify which time series the job analyzes.</p>"""
    created_at: "datetime.datetime"
    """<p>Timestamp when the job was created in ISO 8601 format.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>Timestamp of the last job status change in ISO 8601 format. Use this to track recent activity and identify stale jobs. For active jobs, this shows the last time the job transitioned to a new status.</p>"""

created_at instance-attribute

created_at: datetime

Timestamp when the job was created in ISO 8601 format.

dataset_id instance-attribute

dataset_id: ID

The dataset being enriched. Useful for filtering and identifying jobs without fetching the full configuration. This allows you to quickly find all jobs related to a specific dataset.

job_id instance-attribute

job_id: ID

Unique identifier for the enrichment job.

job_type instance-attribute

job_type: JobType

The type of enrichment job. Currently EVENT_DETECTION is the only supported type.

property_alias instance-attribute

property_alias: NotRequired[AssetPropertyAlias]

The property alias (human-readable sensor name) of the time series being enriched. Present when the job was created using a propertyAlias. Use this to identify which sensor the job analyzes.

status instance-attribute

Current status of the job: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, or CANCELLED. Use this to quickly identify active jobs or jobs requiring attention.

time_series_id instance-attribute

time_series_id: NotRequired[TimeSeriesId]

The system identifier of the time series being enriched. Present when the job was created using a timeSeriesId. Use this to identify which time series the job analyzes.

updated_at instance-attribute

updated_at: NotRequired[datetime]

Timestamp of the last job status change in ISO 8601 format. Use this to track recent activity and identify stale jobs. For active jobs, this shows the last time the job transitioned to a new status.

workspace_name instance-attribute

workspace_name: WorkspaceName

The name of the IoT SiteWise workspace containing this job.