WorkSpacesThinClient / Client / update_device

update_device

WorkSpacesThinClient.Client.update_device(**kwargs)

Updates a thin client device.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• id (string) –

  [REQUIRED]

  The ID of the device to update.

• name (string) – The name of the device to update.

• desiredSoftwareSetId (string) – The ID of the software set to apply.

• softwareSetUpdateSchedule (string) – An option to define if software updates should be applied within a maintenance window.

• kmsKeyArn (string) – The Amazon Resource Name (ARN) of the Key Management Service key to use for the update.

Return type:

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',
        'tags': {
            'resourceArn': 'string',
            'internalId': '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.

    • tags (dict) –

      The tag keys and optional values for the resource.

      • resourceArn (string) –

        The Amazon Resource Name (ARN) of a resource to tag.

      • internalId (string) –

        The internal ID of a resource to tag.

Exceptions

• WorkSpacesThinClient.Client.exceptions.ValidationException

• WorkSpacesThinClient.Client.exceptions.AccessDeniedException

• WorkSpacesThinClient.Client.exceptions.ResourceNotFoundException

• WorkSpacesThinClient.Client.exceptions.ThrottlingException

• WorkSpacesThinClient.Client.exceptions.InternalServerException