[ aws . iot ]

list-job-executions-for-thing

Description

Lists the job executions for the specified thing.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-job-executions-for-thing is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: executionSummaries

Synopsis

  list-job-executions-for-thing
--thing-name <value>
[--status <value>]
[--namespace-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--thing-name (string)

The thing name.

--status (string)

An optional filter that lets you search for jobs that have the specified status.

Possible values:

• QUEUED

• IN_PROGRESS

• SUCCEEDED

• FAILED

• TIMED_OUT

• REJECTED

• REMOVED

• CANCELED

--namespace-id (string)

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/*THING_NAME* /jobs/*JOB_ID* /notify-namespace-*NAMESPACE_ID* /

Note

The namespaceId feature is in public preview.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--starting-token (string)

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

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 list the jobs that were executed for a thing

The following list-job-executions-for-thing example lists all jobs that were executed for the thing named MyRaspberryPi.

aws iot list-job-executions-for-thing \
    --thing-name "MyRaspberryPi"

Output:

{
    "executionSummaries": [
        {
            "jobId": "example-job-01",
            "jobExecutionSummary": {
                "status": "QUEUED",
                "queuedAt": 1560787023.636,
                "lastUpdatedAt": 1560787023.636,
                "executionNumber": 1
            }
        }
    ]
}

For more information, see Creating and Managing Jobs (CLI) in the AWS IoT Developer Guide.

Output

executionSummaries -> (list)

A list of job execution summaries.

(structure)

The job execution summary for a thing.

jobId -> (string)

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

jobExecutionSummary -> (structure)

Contains a subset of information about a job execution.

status -> (string)

The status of the job execution.

queuedAt -> (timestamp)

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

startedAt -> (timestamp)

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

lastUpdatedAt -> (timestamp)

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

executionNumber -> (long)

A string (consisting of the digits “0” through “9”) which identifies this particular job execution on this particular device. It can be used later in commands which return or update job execution information.

nextToken -> (string)

The token for the next set of results, or null if there are no additional results.