IoT / Client / list_job_executions_for_job

list_job_executions_for_job#

IoT.Client.list_job_executions_for_job(**kwargs)#

Lists the job executions for a job.

Requires permission to access the ListJobExecutionsForJob action.

See also: AWS API Documentation

Request Syntax

response = client.list_job_executions_for_job(
    jobId='string',
    status='QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • jobId (string) –

    [REQUIRED]

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

  • status (string) – The status of the job.

  • maxResults (integer) – The maximum number of results to be returned per request.

  • nextToken (string) – The token to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'executionSummaries': [
        {
            'thingArn': 'string',
            'jobExecutionSummary': {
                'status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
                'queuedAt': datetime(2015, 1, 1),
                'startedAt': datetime(2015, 1, 1),
                'lastUpdatedAt': datetime(2015, 1, 1),
                'executionNumber': 123,
                'retryAttempt': 123
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • executionSummaries (list) –

      A list of job execution summaries.

      • (dict) –

        Contains a summary of information about job executions for a specific job.

        • thingArn (string) –

          The ARN of the thing on which the job execution is running.

        • jobExecutionSummary (dict) –

          Contains a subset of information about a job execution.

          • status (string) –

            The status of the job execution.

          • queuedAt (datetime) –

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

          • startedAt (datetime) –

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

          • lastUpdatedAt (datetime) –

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

          • executionNumber (integer) –

            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.

          • retryAttempt (integer) –

            The number that indicates how many retry attempts have been completed for this job on this device.

    • nextToken (string) –

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

Exceptions

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ResourceNotFoundException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.ServiceUnavailableException