Amazon WorkSpaces

2020/08/12 - Amazon WorkSpaces - 1 updated api methods

Changes  Adds optional EnableWorkDocs property to WorkspaceCreationProperties in the ModifyWorkspaceCreationProperties API

ModifyWorkspaceCreationProperties (updated) Link ΒΆ
Changes (request)
{'WorkspaceCreationProperties': {'EnableWorkDocs': 'boolean'}}

Modify the default properties used to create WorkSpaces.

See also: AWS API Documentation

Request Syntax

        'EnableWorkDocs': True|False,
        'EnableInternetAccess': True|False,
        'DefaultOu': 'string',
        'CustomSecurityGroupId': 'string',
        'UserEnabledAsLocalAdministrator': True|False,
        'EnableMaintenanceMode': True|False
type ResourceId


param ResourceId


The identifier of the directory.

type WorkspaceCreationProperties


param WorkspaceCreationProperties


The default properties for creating WorkSpaces.

  • EnableWorkDocs (boolean) --

    Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.


    If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide . To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide .

    If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

  • EnableInternetAccess (boolean) --

    Indicates whether internet access is enabled for your WorkSpaces.

  • DefaultOu (string) --

    The default organizational unit (OU) for your WorkSpace directories.

  • CustomSecurityGroupId (string) --

    The identifier of your custom security group.

  • UserEnabledAsLocalAdministrator (boolean) --

    Indicates whether users are local administrators of their WorkSpaces.

  • EnableMaintenanceMode (boolean) --

    Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance .




Response Syntax


Response Structure

  • (dict) --