WorkSpacesThinClient ******************** Client ====== class WorkSpacesThinClient.Client A low-level client representing Amazon WorkSpaces Thin Client Amazon WorkSpaces Thin Client is an affordable device built to work with Amazon Web Services End User Computing (EUC) virtual desktops to provide users with a complete cloud desktop solution. WorkSpaces Thin Client is a compact device designed to connect up to two monitors and USB devices like a keyboard, mouse, headset, and webcam. To maximize endpoint security, WorkSpaces Thin Client devices do not allow local data storage or installation of unapproved applications. The WorkSpaces Thin Client device ships preloaded with device management software. You can use these APIs to complete WorkSpaces Thin Client tasks, such as creating environments or viewing devices. For more information about WorkSpaces Thin Client, including the required permissions to use the service, see the Amazon WorkSpaces Thin Client Administrator Guide. For more information about using the Command Line Interface (CLI) to manage your WorkSpaces Thin Client resources, see the WorkSpaces Thin Client section of the CLI Reference. import boto3 client = boto3.client('workspaces-thin-client') These are the available methods: * can_paginate * close * create_environment * delete_device * delete_environment * deregister_device * get_device * get_environment * get_paginator * get_software_set * get_waiter * list_devices * list_environments * list_software_sets * list_tags_for_resource * tag_resource * untag_resource * update_device * update_environment * update_software_set Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListDevices * ListEnvironments * ListSoftwareSets WorkSpacesThinClient / Paginator / ListDevices ListDevices *********** class WorkSpacesThinClient.Paginator.ListDevices paginator = client.get_paginator('list_devices') paginate(**kwargs) Creates an iterator that will paginate through responses from "WorkSpacesThinClient.Client.list_devices()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. 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', '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) --* A token to resume pagination. WorkSpacesThinClient / Paginator / ListSoftwareSets ListSoftwareSets **************** class WorkSpacesThinClient.Paginator.ListSoftwareSets paginator = client.get_paginator('list_software_sets') paginate(**kwargs) Creates an iterator that will paginate through responses from "WorkSpacesThinClient.Client.list_software_sets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'softwareSets': [ { 'id': 'string', 'version': 'string', 'releasedAt': datetime(2015, 1, 1), 'supportedUntil': datetime(2015, 1, 1), 'validationStatus': 'VALIDATED'|'NOT_VALIDATED', 'arn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **softwareSets** *(list) --* Describes software sets. * *(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. * **arn** *(string) --* The Amazon Resource Name (ARN) of the software set. * **NextToken** *(string) --* A token to resume pagination. WorkSpacesThinClient / Paginator / ListEnvironments ListEnvironments **************** class WorkSpacesThinClient.Paginator.ListEnvironments paginator = client.get_paginator('list_environments') paginate(**kwargs) Creates an iterator that will paginate through responses from "WorkSpacesThinClient.Client.list_environments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'environments': [ { 'id': 'string', 'name': 'string', 'desktopArn': 'string', 'desktopEndpoint': 'string', 'desktopType': 'workspaces'|'appstream'|'workspaces-web', 'activationCode': 'string', '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', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'arn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **environments** *(list) --* Describes environments. * *(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 Secure Browser, 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. * **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. * **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. * **NextToken** *(string) --* A token to resume pagination. WorkSpacesThinClient / Client / get_environment get_environment *************** WorkSpacesThinClient.Client.get_environment(**kwargs) Returns information for an environment. See also: AWS API Documentation **Request Syntax** response = client.get_environment( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the environment for which to return information. Return type: 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', 'deviceCreationTags': { '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 Secure Browser, 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. * **deviceCreationTags** *(dict) --* The tag keys and optional values for the newly created devices for this environment. * *(string) --* * *(string) --* **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" WorkSpacesThinClient / Client / get_paginator get_paginator ************* WorkSpacesThinClient.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. WorkSpacesThinClient / Client / deregister_device deregister_device ***************** WorkSpacesThinClient.Client.deregister_device(**kwargs) Deregisters a thin client device. See also: AWS API Documentation **Request Syntax** response = client.deregister_device( id='string', targetDeviceStatus='DEREGISTERED'|'ARCHIVED', clientToken='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the device to deregister. * **targetDeviceStatus** (*string*) -- The desired new status for the device. * **clientToken** (*string*) -- Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same "ClientToken", but with different parameters, the retry fails with an "IdempotentParameterMismatch" error. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ConflictException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" WorkSpacesThinClient / Client / delete_environment delete_environment ****************** WorkSpacesThinClient.Client.delete_environment(**kwargs) Deletes an environment. See also: AWS API Documentation **Request Syntax** response = client.delete_environment( id='string', clientToken='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the environment to delete. * **clientToken** (*string*) -- Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same "ClientToken", but with different parameters, the retry fails with an "IdempotentParameterMismatch" error. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ConflictException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" WorkSpacesThinClient / Client / can_paginate can_paginate ************ WorkSpacesThinClient.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. WorkSpacesThinClient / Client / create_environment create_environment ****************** WorkSpacesThinClient.Client.create_environment(**kwargs) Creates an environment for your thin client devices. See also: AWS API Documentation **Request Syntax** response = client.create_environment( name='string', desktopArn='string', desktopEndpoint='string', 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', kmsKeyArn='string', clientToken='string', tags={ 'string': 'string' }, deviceCreationTags={ 'string': 'string' } ) Parameters: * **name** (*string*) -- The name for the environment. * **desktopArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0. * **desktopEndpoint** (*string*) -- The URL for the identity provider login (only for environments that use AppStream 2.0). * **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) --* **[REQUIRED]** 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. * **kmsKeyArn** (*string*) -- The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment. * **clientToken** (*string*) -- Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same "ClientToken", but with different parameters, the retry fails with an "IdempotentParameterMismatch" error. This field is autopopulated if not provided. * **tags** (*dict*) -- A map of the key-value pairs of the tag or tags to assign to the resource. * *(string) --* * *(string) --* * **deviceCreationTags** (*dict*) -- A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'environment': { 'id': 'string', 'name': 'string', 'desktopArn': 'string', 'desktopEndpoint': 'string', 'desktopType': 'workspaces'|'appstream'|'workspaces-web', 'activationCode': 'string', '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', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'arn': '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 Secure Browser, 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. * **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. * **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. **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ServiceQuotaExceededExce ption" * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ConflictException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" WorkSpacesThinClient / Client / list_environments list_environments ***************** WorkSpacesThinClient.Client.list_environments(**kwargs) Returns a list of environments. See also: AWS API Documentation **Request Syntax** response = client.list_environments( 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** { 'environments': [ { 'id': 'string', 'name': 'string', 'desktopArn': 'string', 'desktopEndpoint': 'string', 'desktopType': 'workspaces'|'appstream'|'workspaces-web', 'activationCode': 'string', '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', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'arn': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **environments** *(list) --* Describes environments. * *(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 Secure Browser, 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. * **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. * **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. * **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" WorkSpacesThinClient / Client / list_software_sets list_software_sets ****************** WorkSpacesThinClient.Client.list_software_sets(**kwargs) Returns a list of software sets. See also: AWS API Documentation **Request Syntax** response = client.list_software_sets( 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** { 'softwareSets': [ { 'id': 'string', 'version': 'string', 'releasedAt': datetime(2015, 1, 1), 'supportedUntil': datetime(2015, 1, 1), 'validationStatus': 'VALIDATED'|'NOT_VALIDATED', 'arn': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **softwareSets** *(list) --* Describes software sets. * *(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. * **arn** *(string) --* The Amazon Resource Name (ARN) of the software set. * **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" WorkSpacesThinClient / Client / list_devices list_devices ************ WorkSpacesThinClient.Client.list_devices(**kwargs) Returns a list of thin client devices. See also: AWS API Documentation **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', '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*. **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" WorkSpacesThinClient / Client / list_tags_for_resource list_tags_for_resource ********************** WorkSpacesThinClient.Client.list_tags_for_resource(**kwargs) Returns a list of tags for a resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* A map of the key-value pairs for the tag or tags assigned to the specified resource. * *(string) --* * *(string) --* **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" 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', '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. **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" WorkSpacesThinClient / Client / update_environment update_environment ****************** WorkSpacesThinClient.Client.update_environment(**kwargs) Updates an environment. See also: AWS API Documentation **Request Syntax** response = client.update_environment( id='string', name='string', desktopArn='string', desktopEndpoint='string', 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', deviceCreationTags={ 'string': 'string' } ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the environment to update. * **name** (*string*) -- The name of the environment to update. * **desktopArn** (*string*) -- The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0. * **desktopEndpoint** (*string*) -- The URL for the identity provider login (only for environments that use AppStream 2.0). * **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) --* **[REQUIRED]** 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. * **deviceCreationTags** (*dict*) -- A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'environment': { 'id': 'string', 'name': 'string', 'desktopArn': 'string', 'desktopEndpoint': 'string', 'desktopType': 'workspaces'|'appstream'|'workspaces-web', 'activationCode': 'string', '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', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'arn': '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 Secure Browser, 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. * **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. * **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. **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ConflictException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" WorkSpacesThinClient / Client / untag_resource untag_resource ************** WorkSpacesThinClient.Client.untag_resource(**kwargs) Removes a tag or tags from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to untag. * **tagKeys** (*list*) -- **[REQUIRED]** The keys of the key-value pairs for the tag or tags you want to remove from the specified resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ConflictException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" WorkSpacesThinClient / Client / get_waiter get_waiter ********** WorkSpacesThinClient.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" WorkSpacesThinClient / Client / update_software_set update_software_set ******************* WorkSpacesThinClient.Client.update_software_set(**kwargs) Updates a software set. See also: AWS API Documentation **Request Syntax** response = client.update_software_set( id='string', validationStatus='VALIDATED'|'NOT_VALIDATED' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the software set to update. * **validationStatus** (*string*) -- **[REQUIRED]** An option to define if the software set has been validated. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" WorkSpacesThinClient / Client / close close ***** WorkSpacesThinClient.Client.close() Closes underlying endpoint connections. 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' ) 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. 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', '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. **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" WorkSpacesThinClient / Client / get_software_set get_software_set **************** WorkSpacesThinClient.Client.get_software_set(**kwargs) Returns information for a software set. See also: AWS API Documentation **Request Syntax** response = client.get_software_set( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The ID of the software set for which to return information. Return type: 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' } } **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. **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" WorkSpacesThinClient / Client / tag_resource tag_resource ************ WorkSpacesThinClient.Client.tag_resource(**kwargs) Assigns one or more tags (key-value pairs) to the specified resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to tag. * **tags** (*dict*) -- **[REQUIRED]** A map of the key-value pairs of the tag or tags to assign to the resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ConflictException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException" WorkSpacesThinClient / Client / delete_device delete_device ************* WorkSpacesThinClient.Client.delete_device(**kwargs) Deletes a thin client device. See also: AWS API Documentation **Request Syntax** response = client.delete_device( id='string', clientToken='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The ID of the device to delete. * **clientToken** (*string*) -- Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same "ClientToken", but with different parameters, the retry fails with an "IdempotentParameterMismatch" error. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesThinClient.Client.exceptions.ValidationException" * "WorkSpacesThinClient.Client.exceptions.AccessDeniedException" * "WorkSpacesThinClient.Client.exceptions.ConflictException" * "WorkSpacesThinClient.Client.exceptions.ResourceNotFoundExceptio n" * "WorkSpacesThinClient.Client.exceptions.ThrottlingException" * "WorkSpacesThinClient.Client.exceptions.InternalServerException"