ManagedintegrationsforIoTDeviceManagement / Paginator / ListOtaTasks

ListOtaTasks#

class ManagedintegrationsforIoTDeviceManagement.Paginator.ListOtaTasks#
paginator = client.get_paginator('list_ota_tasks')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ManagedintegrationsforIoTDeviceManagement.Client.list_ota_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

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

{
    'Tasks': [
        {
            'TaskId': 'string',
            'TaskArn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'LastUpdatedAt': datetime(2015, 1, 1),
            'TaskConfigurationId': 'string',
            'Status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS'|'SCHEDULED'
        },
    ],

}

Response Structure

  • (dict) –

    • Tasks (list) –

      A list of all of the over-the-air (OTA) tasks.

      • (dict) –

        Structure representing one over-the-air (OTA) task.

        • TaskId (string) –

          The id of the over-the-air (OTA) task.

        • TaskArn (string) –

          The Amazon Resource Name (ARN) of the over-the-air (OTA) task.

        • CreatedAt (datetime) –

          The timestamp value of when the over-the-air (OTA) task was created at.

        • LastUpdatedAt (datetime) –

          The timestamp value of when the over-the-air (OTA) task was last updated at.

        • TaskConfigurationId (string) –

          The identifier for the over-the-air (OTA) task configuration.

        • Status (string) –

          The status of the over-the-air (OTA) task summary.