WorkSpaces / Client / modify_streaming_properties

modify_streaming_properties#

WorkSpaces.Client.modify_streaming_properties(**kwargs)#

Modifies the specified streaming properties.

Request Syntax

response = client.modify_streaming_properties(
    ResourceId='string',
    StreamingProperties={
        'StreamingExperiencePreferredProtocol': 'TCP'|'UDP',
        'UserSettings': [
            {
                'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'PRINTING_TO_LOCAL_DEVICE'|'SMART_CARD',
                'Permission': 'ENABLED'|'DISABLED',
                'MaximumLength': 123
            },
        ],
        'StorageConnectors': [
            {
                'ConnectorType': 'HOME_FOLDER',
                'Status': 'ENABLED'|'DISABLED'
            },
        ],
        'GlobalAccelerator': {
            'Mode': 'ENABLED_AUTO'|'DISABLED',
            'PreferredProtocol': 'TCP'|'NONE'
        }
    }
)

Parameters:

ResourceId (string) –
[REQUIRED]

The identifier of the resource.
StreamingProperties (dict) –
The streaming properties to configure.
- StreamingExperiencePreferredProtocol (string) –
  
  Indicates the type of preferred protocol for the streaming experience.
- UserSettings (list) –
  
  Indicates the permission settings asscoiated with the user.
  - (dict) –
    
    Information about the user’s permission settings.
    - Action (string) – [REQUIRED]
      
      Indicates the type of action.
    - Permission (string) – [REQUIRED]
      
      Indicates if the setting is enabled or disabled.
    - MaximumLength (integer) –
      
      Indicates the maximum character length for the specified user setting.
- StorageConnectors (list) –
  
  Indicates the storage connector used
  - (dict) –
    
    Describes the storage connector.
    - ConnectorType (string) – [REQUIRED]
      
      The type of connector used to save user files.
    - Status (string) – [REQUIRED]
      
      Indicates if the storage connetor is enabled or disabled.
- GlobalAccelerator (dict) –
  
  Indicates the Global Accelerator properties.
  - Mode (string) – [REQUIRED]
    
    Indicates if Global Accelerator for directory is enabled or disabled.
  - PreferredProtocol (string) –
    
    Indicates the preferred protocol for Global Accelerator.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

WorkSpaces.Client.exceptions.AccessDeniedException
WorkSpaces.Client.exceptions.InvalidParameterValuesException
WorkSpaces.Client.exceptions.ResourceNotFoundException
WorkSpaces.Client.exceptions.OperationNotSupportedException