POST

/#X-Amz-Target=WorkspacesService.CreateUpdatedWorkspaceImage

http://workspaces.{region}.amazonaws.com/#X-Amz-Target=WorkspacesService.CreateUpdatedWorkspaceImage

Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components. To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html"> DescribeWorkspaceImages</a>. <note> <ul> <li> Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time. </li> <li> Microsoft Windows updates and other application updates are not included in the update process. </li> <li> The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle. </li> </ul> </note>

Access Token Required: API Key

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://workspaces.{region}.amazonaws.com/#X-Amz-Target=WorkspacesService.CreateUpdatedWorkspaceImage' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}