IoT / Paginator / ListOTAUpdates

ListOTAUpdates#

class IoT.Paginator.ListOTAUpdates#
paginator = client.get_paginator('list_ota_updates')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    otaUpdateStatus='CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • otaUpdateStatus (string) – The OTA update job status.

  • 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

{
    'otaUpdates': [
        {
            'otaUpdateId': 'string',
            'otaUpdateArn': 'string',
            'creationDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • otaUpdates (list) –

      A list of OTA update jobs.

      • (dict) –

        An OTA update summary.

        • otaUpdateId (string) –

          The OTA update ID.

        • otaUpdateArn (string) –

          The OTA update ARN.

        • creationDate (datetime) –

          The date when the OTA update was created.

    • NextToken (string) –

      A token to resume pagination.