IoTSiteWise / Client / describe_enrichment_job

describe_enrichment_job

IoTSiteWise.Client.describe_enrichment_job(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_enrichment_job(
    workspaceName='string',
    jobId='string'
)
Parameters:

  • workspaceName (string) –

    [REQUIRED]

    The name of the IoT SiteWise workspace containing the enrichment job.

  • jobId (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string',
    'status': 'PENDING'|'RUNNING'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELLED',
    'workspaceName': 'string',
    'jobType': 'EVENT_DETECTION',
    'jobConfiguration': {
        'eventDetection': {
            'datasetId': 'string',
            'timeSeriesId': 'string',
            'propertyAlias': 'string',
            'trimSettings': {
                'startTime': {
                    'timeInSeconds': 123,
                    'offsetInNanos': 123
                },
                'endTime': {
                    'timeInSeconds': 123,
                    'offsetInNanos': 123
                }
            }
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'completedAt': datetime(2015, 1, 1),
    'cancelledAt': datetime(2015, 1, 1),
    'failureMessage': 'string'
}

Response Structure

  • (dict) –

    • jobId (string) –

      The unique identifier of the enrichment job.

    • status (string) –

      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

    • workspaceName (string) –

      The name of the IoT SiteWise workspace containing the job.

    • jobType (string) –

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

    • jobConfiguration (dict) –

      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.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: eventDetection. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • eventDetection (dict) –

        Event detection configuration that generates embeddings from video time-series data enabling natural language similarity search on events. The service processes video data and creates embeddings stored in IoT SiteWise for semantic querying.

        • datasetId (string) – <p>The IoT SiteWise dataset ID containing the video time-series data to analyze. Query IoT SiteWise to discover available datasets in your workspace.</p>

        • timeSeriesId (string) – <p>Unique system identifier for the video time series to analyze. Specify either timeSeriesId or propertyAlias, but not both. Use this when you have the system-generated time series identifier from IoT SiteWise.</p>

        • propertyAlias (string) – <p>Human-readable alias for the video time series to analyze (e.g., /camera/warehouse/zone-a). Specify either propertyAlias or timeSeriesId, but not both. Use this when you have configured friendly aliases in IoT SiteWise for better readability.</p>

        • trimSettings (dict) – <p>Time range settings defining which portion of the video time-series data to process. Required to ensure predictable processing time and prevent analyzing unbounded datasets. Start and end times must be within the dataset’s time bounds.</p>

          • startTime (dict) – <p>Start time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or after this time are included in the enrichment. Must be within the dataset’s time bounds.</p> <p>Example (JavaScript): Date.parse(‘2024-01-01T00:00:00Z’) * 1000000 Example (Python): int(datetime.timestamp() * 1e9)</p>

            • timeInSeconds (integer) –

              The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

            • offsetInNanos (integer) –

              The nanosecond offset from timeInSeconds.

          • endTime (dict) – <p>End time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or before this time are included in the enrichment. Must be greater than startTime and within the dataset’s time bounds.</p>

            • timeInSeconds (integer) –

              The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

            • offsetInNanos (integer) –

              The nanosecond offset from timeInSeconds.

    • createdAt (datetime) –

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

    • updatedAt (datetime) –

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

    • completedAt (datetime) –

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

    • cancelledAt (datetime) –

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

    • failureMessage (string) –

      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.

Exceptions