IoTJobsDataPlane / Client / get_pending_job_executions

get_pending_job_executions#

IoTJobsDataPlane.Client.get_pending_job_executions(**kwargs)#

Gets the list of all jobs for a thing that are not in a terminal status.

Requires permission to access the GetPendingJobExecutions action.

See also: AWS API Documentation

Request Syntax

response = client.get_pending_job_executions(
    thingName='string'
)
Parameters:

thingName (string) –

[REQUIRED]

The name of the thing that is executing the job.

Return type:

dict

Returns:

Response Syntax

{
    'inProgressJobs': [
        {
            'jobId': 'string',
            'queuedAt': 123,
            'startedAt': 123,
            'lastUpdatedAt': 123,
            'versionNumber': 123,
            'executionNumber': 123
        },
    ],
    'queuedJobs': [
        {
            'jobId': 'string',
            'queuedAt': 123,
            'startedAt': 123,
            'lastUpdatedAt': 123,
            'versionNumber': 123,
            'executionNumber': 123
        },
    ]
}

Response Structure

  • (dict) –

    • inProgressJobs (list) –

      A list of JobExecutionSummary objects with status IN_PROGRESS.

      • (dict) –

        Contains a subset of information about a job execution.

        • jobId (string) –

          The unique identifier you assigned to this job when it was created.

        • queuedAt (integer) –

          The time, in seconds since the epoch, when the job execution was enqueued.

        • startedAt (integer) –

          The time, in seconds since the epoch, when the job execution started.

        • lastUpdatedAt (integer) –

          The time, in seconds since the epoch, when the job execution was last updated.

        • versionNumber (integer) –

          The version of the job execution. Job execution versions are incremented each time IoT Jobs receives an update from a device.

        • executionNumber (integer) –

          A number that identifies a particular job execution on a particular device.

    • queuedJobs (list) –

      A list of JobExecutionSummary objects with status QUEUED.

      • (dict) –

        Contains a subset of information about a job execution.

        • jobId (string) –

          The unique identifier you assigned to this job when it was created.

        • queuedAt (integer) –

          The time, in seconds since the epoch, when the job execution was enqueued.

        • startedAt (integer) –

          The time, in seconds since the epoch, when the job execution started.

        • lastUpdatedAt (integer) –

          The time, in seconds since the epoch, when the job execution was last updated.

        • versionNumber (integer) –

          The version of the job execution. Job execution versions are incremented each time IoT Jobs receives an update from a device.

        • executionNumber (integer) –

          A number that identifies a particular job execution on a particular device.

Exceptions