WorkSpacesThinClient / Client / get_device

get_device#

WorkSpacesThinClient.Client.get_device(**kwargs)#

Returns information for a thin client device.

See also: AWS API Documentation

Request Syntax

response = client.get_device(
    id='string'
)
Parameters:

id (string) –

[REQUIRED]

The ID of the device for which to return information.

Return type:

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

      • 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