WorkSpaces / Client / modify_workspace_access_properties

modify_workspace_access_properties

WorkSpaces.Client.modify_workspace_access_properties(**kwargs)

Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.

See also: AWS API Documentation

Request Syntax

response = client.modify_workspace_access_properties(
    ResourceId='string',
    WorkspaceAccessProperties={
        'DeviceTypeWindows': 'ALLOW'|'DENY',
        'DeviceTypeOsx': 'ALLOW'|'DENY',
        'DeviceTypeWeb': 'ALLOW'|'DENY',
        'DeviceTypeIos': 'ALLOW'|'DENY',
        'DeviceTypeAndroid': 'ALLOW'|'DENY',
        'DeviceTypeChromeOs': 'ALLOW'|'DENY',
        'DeviceTypeZeroClient': 'ALLOW'|'DENY',
        'DeviceTypeLinux': 'ALLOW'|'DENY',
        'DeviceTypeWorkSpacesThinClient': 'ALLOW'|'DENY',
        'AccessEndpointConfig': {
            'AccessEndpoints': [
                {
                    'AccessEndpointType': 'STREAMING_WSP',
                    'VpcEndpointId': 'string'
                },
            ],
            'InternetFallbackProtocols': [
                'PCOIP',
            ]
        }
    }
)
Parameters:

  • ResourceId (string) –

    [REQUIRED]

    The identifier of the directory.

  • WorkspaceAccessProperties (dict) –

    [REQUIRED]

    The device types and operating systems to enable or disable for access.

    • DeviceTypeWindows (string) –

      Indicates whether users can use Windows clients to access their WorkSpaces.

    • DeviceTypeOsx (string) –

      Indicates whether users can use macOS clients to access their WorkSpaces.

    • DeviceTypeWeb (string) –

      Indicates whether users can access their WorkSpaces through a web browser.

    • DeviceTypeIos (string) –

      Indicates whether users can use iOS devices to access their WorkSpaces.

    • DeviceTypeAndroid (string) –

      Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.

    • DeviceTypeChromeOs (string) –

      Indicates whether users can use Chromebooks to access their WorkSpaces.

    • DeviceTypeZeroClient (string) –

      Indicates whether users can use zero client devices to access their WorkSpaces.

    • DeviceTypeLinux (string) –

      Indicates whether users can use Linux clients to access their WorkSpaces.

    • DeviceTypeWorkSpacesThinClient (string) –

      Indicates whether users can access their WorkSpaces through a WorkSpaces Thin Client.

    • AccessEndpointConfig (dict) –

      Specifies the configuration for accessing the WorkSpace.

      • AccessEndpoints (list) – [REQUIRED]

        Indicates a list of access endpoints associated with this directory.

        • (dict) –

          Describes the access type and endpoint for a WorkSpace.

          • AccessEndpointType (string) –

            Indicates the type of access endpoint.

          • VpcEndpointId (string) –

            Indicates the VPC endpoint to use for access.

      • InternetFallbackProtocols (list) –

        Indicates a list of protocols that fallback to using the public Internet when streaming over a VPC endpoint is not available.

        • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions