IoT / Paginator / ListJobExecutionsForThing

ListJobExecutionsForThing

class IoT.Paginator.ListJobExecutionsForThing

paginator = client.get_paginator('list_job_executions_for_thing')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• thingName (string) –

  [REQUIRED]

  The thing name.

• status (string) – An optional filter that lets you search for jobs that have the specified status.

• namespaceId (string) –

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

  When you specify a value for this parameter, Amazon Web Services 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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

• jobId (string) – The unique identifier you assigned to this job when it was created.

• 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': [
        {
            'jobId': '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) –

      The job execution summary for a thing.

      • jobId (string) –

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

      • 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.