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.

Synopsis¶

  get-pending-job-executions
--thing-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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
    --endpoint-url https://1234567890abcd.jobs.iot.us-west-2.amazonaws.com

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.

Table Of Contents

Feedback

User Guide