IoTSiteWise / Paginator / ListEnrichmentJobs

ListEnrichmentJobs

class IoTSiteWise.Paginator.ListEnrichmentJobs
paginator = client.get_paginator('list_enrichment_jobs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_enrichment_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    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),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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).

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

      A token to resume pagination.