Amazon WorkSpaces Thin Client

2025/07/23 - Amazon WorkSpaces Thin Client - 3 updated api methods

Changes  Added the lastUserId parameter to the ListDevices and GetDevice API.

GetDevice (updated) Link ¶
Changes (response)
{'device': {'lastUserId': 'string'}}

Returns information for a thin client device.

See also: AWS API Documentation

Request Syntax

client.get_device(
    id='string'
)
type id:

string

param id:

[REQUIRED]

The ID of the device for which to return information.

rtype:

dict

returns:

Response Syntax

{
    'device': {
        'id': 'string',
        'serialNumber': 'string',
        'name': 'string',
        'model': 'string',
        'environmentId': 'string',
        'status': 'REGISTERED'|'DEREGISTERING'|'DEREGISTERED'|'ARCHIVED',
        'currentSoftwareSetId': 'string',
        'currentSoftwareSetVersion': 'string',
        'desiredSoftwareSetId': 'string',
        'pendingSoftwareSetId': 'string',
        'pendingSoftwareSetVersion': 'string',
        'softwareSetUpdateSchedule': 'USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
        'softwareSetComplianceStatus': 'NONE'|'COMPLIANT'|'NOT_COMPLIANT',
        'softwareSetUpdateStatus': 'AVAILABLE'|'IN_PROGRESS'|'UP_TO_DATE',
        'lastConnectedAt': datetime(2015, 1, 1),
        'lastPostureAt': datetime(2015, 1, 1),
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'arn': 'string',
        'kmsKeyArn': 'string',
        'lastUserId': 'string'
    }
}

Response Structure

  • (dict) --

    • device (dict) --

      Describes an 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.

      • currentSoftwareSetVersion (string) --

        The version 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.

      • pendingSoftwareSetVersion (string) --

        The version 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.

      • softwareSetComplianceStatus (string) --

        Describes if the software currently installed on the device is a supported version.

      • softwareSetUpdateStatus (string) --

        Describes if the device has a supported version of software installed.

      • 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.

      • kmsKeyArn (string) --

        The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the device.

      • lastUserId (string) --

        The user ID of the most recent session on the device.

ListDevices (updated) Link ¶
Changes (response)
{'devices': {'lastUserId': 'string'}}

Returns a list of thin client devices.

See also: AWS API Documentation

Request Syntax

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

string

param nextToken:

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.

type maxResults:

integer

param maxResults:

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.

rtype:

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',
            'lastUserId': '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.

        • lastUserId (string) --

          The user ID of the most recent session on 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.

UpdateDevice (updated) Link ¶
Changes (response)
{'device': {'lastUserId': 'string'}}

Updates a thin client device.

See also: AWS API Documentation

Request Syntax

client.update_device(
    id='string',
    name='string',
    desiredSoftwareSetId='string',
    softwareSetUpdateSchedule='USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY'
)
type id:

string

param id:

[REQUIRED]

The ID of the device to update.

type name:

string

param name:

The name of the device to update.

type desiredSoftwareSetId:

string

param desiredSoftwareSetId:

The ID of the software set to apply.

type softwareSetUpdateSchedule:

string

param softwareSetUpdateSchedule:

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

rtype:

dict

returns:

Response Syntax

{
    'device': {
        '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',
        'lastUserId': 'string'
    }
}

Response Structure

  • (dict) --

    • device (dict) --

      Describes a 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.

      • lastUserId (string) --

        The user ID of the most recent session on the device.