SnowDeviceManagement / Paginator / ListDevices

ListDevices

class SnowDeviceManagement.Paginator.ListDevices

paginator = client.get_paginator('list_devices')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SnowDeviceManagement.Client.list_devices().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• jobId (string) – The ID of the job used to order the device.

• 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

{
    'devices': [
        {
            'associatedWithJob': 'string',
            'managedDeviceArn': 'string',
            'managedDeviceId': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • devices (list) –

    A list of device structures that contain information about the device.

    • (dict) –

      Identifying information about the device.

      • associatedWithJob (string) –

        The ID of the job used to order the device.

      • managedDeviceArn (string) –

        The Amazon Resource Name (ARN) of the device.

      • managedDeviceId (string) –

        The ID of the device.

      • tags (dict) –

        Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.