IoT / Paginator / ListJobExecutionsForJob

ListJobExecutionsForJob

class IoT.Paginator.ListJobExecutionsForJob

paginator = client.get_paginator('list_job_executions_for_job')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_job_executions_for_job().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    jobId='string',
    status='QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• jobId (string) –

  [REQUIRED]

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

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

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) –

    A token to resume pagination.