Amazon WorkSpaces Thin Client

2024/04/10 - Amazon WorkSpaces Thin Client - 3 updated api methods

Changes  Adding tags field to SoftwareSet. Removing tags fields from Summary objects. Changing the list of exceptions in tagging APIs. Fixing an issue where the SDK returns empty tags in Get APIs.

GetDevice (updated) Link ¶
Changes (response) 
{'device': {'tags': {'string': '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',
        'tags': {
            'string': '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.

        • (string) --

          • (string) --

GetEnvironment (updated) Link ¶
Changes (response) 
{'environment': {'tags': {'string': 'string'}}}

Returns information for an environment.

See also: AWS API Documentation

Request Syntax

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

string

param id:

[REQUIRED]

The ID of the environment for which to return information.

rtype:

dict

returns:

Response Syntax

{
    'environment': {
        'id': 'string',
        'name': 'string',
        'desktopArn': 'string',
        'desktopEndpoint': 'string',
        'desktopType': 'workspaces'|'appstream'|'workspaces-web',
        'activationCode': 'string',
        'registeredDevicesCount': 123,
        'softwareSetUpdateSchedule': 'USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
        'maintenanceWindow': {
            'type': 'SYSTEM'|'CUSTOM',
            'startTimeHour': 123,
            'startTimeMinute': 123,
            'endTimeHour': 123,
            'endTimeMinute': 123,
            'daysOfTheWeek': [
                'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
            ],
            'applyTimeOf': 'UTC'|'DEVICE'
        },
        'softwareSetUpdateMode': 'USE_LATEST'|'USE_DESIRED',
        'desiredSoftwareSetId': 'string',
        'pendingSoftwareSetId': 'string',
        'pendingSoftwareSetVersion': 'string',
        'softwareSetComplianceStatus': 'NO_REGISTERED_DEVICES'|'COMPLIANT'|'NOT_COMPLIANT',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'arn': 'string',
        'kmsKeyArn': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • environment (dict) --

      Describes an environment.

      • id (string) --

        The ID of the environment.

      • name (string) --

        The name of the environment.

      • desktopArn (string) --

        The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

      • desktopEndpoint (string) --

        The URL for the identity provider login (only for environments that use AppStream 2.0).

      • desktopType (string) --

        The type of streaming desktop for the environment.

      • activationCode (string) --

        The activation code to register a device to the environment.

      • registeredDevicesCount (integer) --

        The number of devices registered to the environment.

      • softwareSetUpdateSchedule (string) --

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

      • maintenanceWindow (dict) --

        A specification for a time window to apply software updates.

        • type (string) --

          An option to select the default or custom maintenance window.

        • startTimeHour (integer) --

          The hour for the maintenance window start ( 00- 23).

        • startTimeMinute (integer) --

          The minutes past the hour for the maintenance window start ( 00- 59).

        • endTimeHour (integer) --

          The hour for the maintenance window end ( 00- 23).

        • endTimeMinute (integer) --

          The minutes for the maintenance window end ( 00- 59).

        • daysOfTheWeek (list) --

          The days of the week during which the maintenance window is open.

          • (string) --

        • applyTimeOf (string) --

          The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

      • softwareSetUpdateMode (string) --

        An option to define which software updates to apply.

      • desiredSoftwareSetId (string) --

        The ID of the software set to apply.

      • pendingSoftwareSetId (string) --

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

      • pendingSoftwareSetVersion (string) --

        The version of the software set that is pending to be installed.

      • softwareSetComplianceStatus (string) --

        Describes if the software currently installed on all devices in the environment is a supported version.

      • createdAt (datetime) --

        The timestamp of when the environment was created.

      • updatedAt (datetime) --

        The timestamp of when the device was updated.

      • arn (string) --

        The Amazon Resource Name (ARN) of the environment.

      • kmsKeyArn (string) --

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

      • tags (dict) --

        The tag keys and optional values for the resource.

        • (string) --

          • (string) --

GetSoftwareSet (updated) Link ¶
Changes (response) 
{'softwareSet': {'tags': {'string': 'string'}}}

Returns information for a software set.

See also: AWS API Documentation

Request Syntax

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

string

param id:

[REQUIRED]

The ID of the software set for which to return information.

rtype:

dict

returns:

Response Syntax

{
    'softwareSet': {
        'id': 'string',
        'version': 'string',
        'releasedAt': datetime(2015, 1, 1),
        'supportedUntil': datetime(2015, 1, 1),
        'validationStatus': 'VALIDATED'|'NOT_VALIDATED',
        'software': [
            {
                'name': 'string',
                'version': 'string'
            },
        ],
        'arn': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • softwareSet (dict) --

      Describes a software set.

      • id (string) --

        The ID of the software set.

      • version (string) --

        The version of the software set.

      • releasedAt (datetime) --

        The timestamp of when the software set was released.

      • supportedUntil (datetime) --

        The timestamp of the end of support for the software set.

      • validationStatus (string) --

        An option to define if the software set has been validated.

      • software (list) --

        A list of the software components in the software set.

        • (dict) --

          Describes software.

          • name (string) --

            The name of the software component.

          • version (string) --

            The version of the software component.

      • arn (string) --

        The Amazon Resource Name (ARN) of the software set.

      • tags (dict) --

        The tag keys and optional values for the resource.

        • (string) --

          • (string) --