AWS API Changes

2018/11/20 - Amazon WorkSpaces - 2 new api methods

Changes Added new APIs to Modify and Describe WorkSpaces client properties for users in a directory. With the new APIs, you can enable/disable remember me option in WorkSpaces client for users in a directory.

DescribeClientProperties (new)

Link ¶

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 identifiers, in the form of directory IDs.

(string) --

rtype

dict

returns

Response Syntax

{
    'ClientPropertiesList': [
        {
            'ResourceId': 'string',
            'ClientProperties': {
                'ReconnectEnabled': '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.

ModifyClientProperties (new)

Link ¶

Modifies the properties of the specified Amazon WorkSpaces client.

See also: AWS API Documentation

Request Syntax

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

type ResourceId

string

param ResourceId

[REQUIRED]

The resource identifiers, in the form of directory IDs.

type ClientProperties

dict

param ClientProperties

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.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --