IoTSiteWise / Client / list_enrichment_jobs

list_enrichment_jobs¶

IoTSiteWise.Client.list_enrichment_jobs(**kwargs)¶

Lists enrichment jobs within a workspace with optional filtering and pagination. Results are ordered by createdAt timestamp descending (newest first).

Filtering

Combine filters to narrow results:

datasetId: Filter by dataset
propertyAlias OR timeSeriesId: Filter by time series (specify one, not both)
status: Filter by job status (e.g., RUNNING to find active jobs)
jobType: Filter by enrichment type (currently only EVENT_DETECTION)
startDate and endDate: Filter by job creation time range

Important Constraints

You must specify either propertyAlias OR timeSeriesId, but not both
Attempting to specify both results in an InvalidRequestException
Date filters use ISO 8601 format
startDate is exclusive, endDate is inclusive

Pagination

The operation returns up to maxResults jobs per page (default 50). If more results exist, the response includes a nextToken. Submit this token in a subsequent request to retrieve the next page.

Common Use Cases

Find all running jobs: Filter by status=RUNNING
List recent jobs for a dataset: Filter by datasetId with optional date range
Monitor jobs for a specific sensor: Filter by propertyAlias or timeSeriesId
Track all event detection jobs: Filter by jobType=EVENT_DETECTION

Performance

Performance is optimal when filtering by supported fields (datasetId, propertyAlias, timeSeriesId, status, jobType).

Request Syntax

response = client.list_enrichment_jobs(
    workspaceName='string',
    datasetId='string',
    propertyAlias='string',
    timeSeriesId='string',
    status='PENDING'|'RUNNING'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELLED',
    jobType='EVENT_DETECTION',
    startDate=datetime(2015, 1, 1),
    endDate=datetime(2015, 1, 1),
    maxResults=123,
    nextToken='string'
)

Parameters:

workspaceName (string) –
[REQUIRED]

The name of the IoT SiteWise workspace to list enrichment jobs from.
datasetId (string) – Filter jobs by dataset ID. Returns only jobs analyzing data from the specified dataset.
propertyAlias (string) – Filter by property alias (human-readable sensor name). Specify either propertyAlias or timeSeriesId, but not both. Returns only jobs analyzing the specified property alias.
timeSeriesId (string) – Filter by time series ID (system identifier). Specify either timeSeriesId or propertyAlias, but not both. Returns only jobs analyzing the specified time series.
status (string) – Filter by job status. Returns only jobs in the specified status. Use RUNNING to find active jobs, or FAILED to identify jobs requiring attention.
jobType (string) – Filter by enrichment job type. Currently only EVENT_DETECTION is supported. Use this filter to future-proof queries when additional job types are added.
startDate (datetime) – The exclusive start of the date range for filtering jobs by creation time. Jobs created after this timestamp are included. Use ISO 8601 format (e.g., 2024-01-01T00:00:00Z).
endDate (datetime) – The inclusive end of the date range for filtering jobs by creation time. Jobs created on or before this timestamp are included. Use ISO 8601 format (e.g., 2024-01-31T23:59:59Z).
maxResults (integer) – Maximum number of jobs to return per page. Defaults to 50 if not specified. Use smaller values for faster responses, larger values to reduce API calls.
nextToken (string) – Pagination token from a previous ListEnrichmentJobs response. Include this token to retrieve the next page of results. Omit for the first request.

Return type:

dict

Returns:

Response Syntax

{
    'jobs': [
        {
            'jobId': 'string',
            'status': 'PENDING'|'RUNNING'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELLED',
            'workspaceName': 'string',
            'jobType': 'EVENT_DETECTION',
            'datasetId': 'string',
            'propertyAlias': 'string',
            'timeSeriesId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- jobs (list) –
  
  Array of job summaries matching the filter criteria, ordered by creation time descending (newest first). Each summary includes key identifiers (jobId, datasetId, propertyAlias/timeSeriesId) and status information without the full job configuration. Use DescribeEnrichmentJob to retrieve complete details.
  - (dict) –
    
    Summary information for an enrichment job returned by ListEnrichmentJobs. This lightweight representation includes identifiers, status, and key metadata without the full job configuration.
    
    Use DescribeEnrichmentJob to retrieve:
    - Complete job configuration (trim settings, full parameters)
    - Detailed timestamps (completedAt, cancelledAt)
    - Failure messages for failed jobs
    The summary is optimized for display in lists and dashboards, providing enough information to identify and filter jobs without the overhead of full configuration details.
    - jobId (string) –
      
      Unique identifier for the enrichment job.
    - status (string) –
      
      Current status of the job: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, or CANCELLED. Use this to quickly identify active jobs or jobs requiring attention.
    - workspaceName (string) –
      
      The name of the IoT SiteWise workspace containing this job.
    - jobType (string) –
      
      The type of enrichment job. Currently EVENT_DETECTION is the only supported type.
    - datasetId (string) –
      
      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.
    - propertyAlias (string) –
      
      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.
    - timeSeriesId (string) –
      
      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.
    - createdAt (datetime) –
      
      Timestamp when the job was created in ISO 8601 format.
    - updatedAt (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.
- nextToken (string) –
  
  Pagination token to retrieve the next page of results. If present, more jobs exist that match the filter criteria. Include this token in a subsequent ListEnrichmentJobs request to retrieve the next page. If absent, you have retrieved all matching jobs.

list_enrichment_jobs¶

Request Syntax

Response Syntax

Response Structure

Exceptions