WorkSpaces / Client / describe_client_properties

describe_client_properties#

WorkSpaces.Client.describe_client_properties(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

ResourceIds (list) –

[REQUIRED]

The resource identifier, in the form of directory IDs.

  • (string) –

Return type:

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.

Exceptions