AWS API Changes

2022/09/29 - Amazon WorkSpaces - 2 updated api methods

Changes This release includes diagnostic log uploading feature. If it is enabled, the log files of WorkSpaces Windows client will be sent to Amazon WorkSpaces automatically for troubleshooting. You can use modifyClientProperty api to enable/disable this feature.

DescribeClientProperties (updated)

Link ¶
Changes (response)

{'ClientPropertiesList': {'ClientProperties': {'LogUploadEnabled': 'ENABLED | '
                                                                   'DISABLED'}}}

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

See also: AWS API Documentation

Request Syntax

client.describe_client_properties(
    ResourceIds=[
        'string',
    ]
)

type ResourceIds:

list

param ResourceIds:

[REQUIRED]

The resource identifier, in the form of directory IDs.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'ClientPropertiesList': [
        {
            'ResourceId': 'string',
            'ClientProperties': {
                'ReconnectEnabled': 'ENABLED'|'DISABLED',
                'LogUploadEnabled': 'ENABLED'|'DISABLED'
            }
        },
    ]
}

Response Structure

(dict) --
- ClientPropertiesList (list) --
  
  Information about the specified Amazon WorkSpaces clients.
  - (dict) --
    
    Information about the Amazon WorkSpaces client.
    - ResourceId (string) --
      
      The resource identifier, in the form of a directory ID.
    - ClientProperties (dict) --
      
      Information about the Amazon WorkSpaces client.
      - ReconnectEnabled (string) --
        
        Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
      - LogUploadEnabled (string) --
        
        Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory.

ModifyClientProperties (updated)

Link ¶
Changes (request)

{'ClientProperties': {'LogUploadEnabled': 'ENABLED | DISABLED'}}

Modifies the properties of the specified Amazon WorkSpaces clients.

See also: AWS API Documentation

Request Syntax

client.modify_client_properties(
    ResourceId='string',
    ClientProperties={
        'ReconnectEnabled': 'ENABLED'|'DISABLED',
        'LogUploadEnabled': 'ENABLED'|'DISABLED'
    }
)

type ResourceId:

string

param ResourceId:

[REQUIRED]

The resource identifiers, in the form of directory IDs.

type ClientProperties:

dict

param ClientProperties:

[REQUIRED]

Information about the Amazon WorkSpaces client.

ReconnectEnabled (string) --

Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
LogUploadEnabled (string) --

Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --