WorkSpacesThinClient / Client / list_devices

list_devices#

WorkSpacesThinClient.Client.list_devices(**kwargs)#

Returns a list of thin client devices.

Request Syntax

response = client.list_devices(
    nextToken='string',
    maxResults=123
)

Parameters:

nextToken (string) – If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
maxResults (integer) –
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

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) –
  
  If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Exceptions

WorkSpacesThinClient.Client.exceptions.ValidationException
WorkSpacesThinClient.Client.exceptions.AccessDeniedException
WorkSpacesThinClient.Client.exceptions.ThrottlingException
WorkSpacesThinClient.Client.exceptions.InternalServerException