Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot-jobs-data ]

get-pending-job-executions

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-pending-job-executions
--thing-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--thing-name (string)

The name of the thing that is executing the job.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To get a list of all jobs that are not in a terminal status for a thing

The following get-pending-job-executions example displays a list of all jobs that aren't in a terminal state for the specified thing.

aws iot-jobs-data get-pending-job-executions \
    --thing-name MotionSensor1

Output:

{
    "inProgressJobs": [
    ],
    "queuedJobs": [
        {
            "executionNumber": 2939653338,
            "jobId": "SampleJob",
            "lastUpdatedAt": 1567701875.743,
            "queuedAt": 1567701902.444,
            "versionNumber": 3
      }
    ]
}

For more information, see Devices and Jobs in the AWS IoT Developer Guide.

Output

inProgressJobs -> (list)

A list of JobExecutionSummary objects with status IN_PROGRESS.

(structure)

Contains a subset of information about a job execution.

jobId -> (string)

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

queuedAt -> (long)

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

startedAt -> (long)

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

lastUpdatedAt -> (long)

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

versionNumber -> (long)

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

executionNumber -> (long)

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

queuedJobs -> (list)

A list of JobExecutionSummary objects with status QUEUED.

(structure)

Contains a subset of information about a job execution.

jobId -> (string)

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

queuedAt -> (long)

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

startedAt -> (long)

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

lastUpdatedAt -> (long)

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

versionNumber -> (long)

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

executionNumber -> (long)

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