WorkSpaces Core API actions

You can use the following APIs to perform various actions for WorkSpaces Core. We have provided some recommendations next to these actions to help you create your workflow.

Note

These APIs for for WorkSpaces Core only. APIs for using Amazon WorkSpaces Instances are available in the WorkSpaces Instances API Reference.

• Deployment and setup

  • CreateTags - Possible

  • CreateWorkspaceBundle - Required

  • CreateWorkspaces - Required

  • DescribeAccount - Required

  • DescribeAccountModifications - Possible

  • ImportWorkspaceImage - Possible, but we highly recommend partners have an interface to import images into Amazon WorkSpaces using this API.

  • ModifyAccount - Possible

  • ListAvailableManagementCidrRanges - Possible, but we highly recommend partners have an interface to onboard customers into Amazon WorkSpaces BYOL using this API.

  • RegisterWorkspaceDirectory - Required

    • EnableInternetAccess - Optional

    • EnableWorkDocs - Optional

    • Tags - Optional

• Operations

  • CopyWorkspaceImage - Possible, but we highly recommend this action. It supports an UpdateWorkspaceBundle image process and copying from one region to another.

  • CreateWorkspaceImage - Required

  • DescribeTags - Possible, but we highly recommend partners have an interface to use and modify tags on Amazon WorkSpaces desktops using this API.

  • DescribeWorkspaceBundles - Required

  • DescribeWorkspaceDirectories - Required

  • DescribeWorkspaceImagePermissions - Required

  • DescribeWorkspaceImages - Required for creation of new desktops and within a workflow to use the UpdateWorkspaceBundle API that updates an image within a bundle.

  • DescribeWorkspaces - Required

  • DescribeWorkspaceSnapshots - Possible, but we highly recommend partners have an interface to view snapshots into Amazon WorkSpaces desktops using this API.

  • MigrateWorkspace - Possible, but we highly recommend partners have an interface to migrate an Amazon WorkSpaces desktop from one bundle to another using this API.

  • ModifyWorkspaceCreationProperties - Possible, but we highly recommend partners have an interface to modify the following properties:

    • Custom Security Group

    • Default OU

    • EnableInternetAccess

    • EnableMaintenanceMode

    • EnableWorkDocs

    • UserEnabledAsLocalAdministrator

  • ModifyWorkspaceProperties - Possible, but we highly recommend partners have an interface to modify the following properties:

    • ComputeTypeName

    • RootVolumeSizeGib

    • RunningMode (can change to Manual)

    • RunningModeAutoStopTimeoutInMinutes

    • UserVolumeSizeGib

  • ModifyWorkspaceState - Required

  • RebootWorkspaces - Required

  • RebuildWorkspaces - Required

  • RestoreWorkspace - Required

  • StartWorkspaces - Required

  • StopWorkspaces - Required

  • UpdateWorkspaceBundle - Required

  • UpdateWorkspaceImagePermission - Possible, but we highly recommend partners have an interface to modify these properties.

• Termination

  • DeleteTags - Possible

  • DeleteWorkspaceBundle - Required

  • DeleteWorkspaceImage - Required

  • DeregisterWorkspaceDirectory - Required

  • TerminateWorkspaces - Required