WorkSpacesThinClient / Paginator / ListDevices

ListDevices

class WorkSpacesThinClient.Paginator.ListDevices

paginator = client.get_paginator('list_devices')

paginate(**kwargs)

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

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

{
    'devices': [
        {
            'id': 'string',
            'serialNumber': 'string',
            'name': 'string',
            'model': 'string',
            'environmentId': 'string',
            'status': 'REGISTERED'|'DEREGISTERING'|'DEREGISTERED'|'ARCHIVED',
            'currentSoftwareSetId': 'string',
            'desiredSoftwareSetId': 'string',
            'pendingSoftwareSetId': 'string',
            'softwareSetUpdateSchedule': 'USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
            'lastConnectedAt': datetime(2015, 1, 1),
            'lastPostureAt': datetime(2015, 1, 1),
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • devices (list) –

    Describes devices.

    • (dict) –

      Describes a thin client device.

      • id (string) –

        The ID of the device.

      • serialNumber (string) –

        The hardware serial number of the device.

      • name (string) –

        The name of the device.

      • model (string) –

        The model number of the device.

      • environmentId (string) –

        The ID of the environment the device is associated with.

      • status (string) –

        The status of the device.

      • currentSoftwareSetId (string) –

        The ID of the software set currently installed on the device.

      • desiredSoftwareSetId (string) –

        The ID of the software set which the device has been set to.

      • pendingSoftwareSetId (string) –

        The ID of the software set that is pending to be installed on the device.

      • softwareSetUpdateSchedule (string) –

        An option to define if software updates should be applied within a maintenance window.

      • lastConnectedAt (datetime) –

        The timestamp of the most recent session on the device.

      • lastPostureAt (datetime) –

        The timestamp of the most recent check-in of the device.

      • createdAt (datetime) –

        The timestamp of when the device was created.

      • updatedAt (datetime) –

        The timestamp of when the device was updated.

      • arn (string) –

        The Amazon Resource Name (ARN) of the device.

  • NextToken (string) –

    A token to resume pagination.