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 DescribeWorkspaceImages.
Note
-
Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
-
Microsoft Windows updates and other application updates are not included in the update process.
-
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.
Request Syntax
{
"Description": "string",
"Name": "string",
"SourceImageId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}Request Parameters
The request accepts the following data in JSON format.
- Description
-
A description of whether updates for the WorkSpace image are available.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[a-zA-Z0-9_./() -]+$Required: Yes
- Name
-
The name of the new updated WorkSpace image.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_./()\\-]+$Required: Yes
- SourceImageId
-
The identifier of the source WorkSpace image.
Type: String
Pattern:
wsi-[0-9a-z]{9,63}$Required: Yes
- Tags
-
The tags that you want to add to the new updated WorkSpace image.
Note
To add tags at the same time when you're creating the updated image, you must create an IAM policy that grants your IAM user permissions to use
workspaces:CreateTags.Type: Array of Tag objects
Required: No
Response Syntax
{
"ImageId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ImageId
-
The identifier of the new updated WorkSpace image.
Type: String
Pattern:
wsi-[0-9a-z]{9,63}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The user is not authorized to access a resource.
HTTP Status Code: 400
- InvalidParameterValuesException
-
One or more parameter values are not valid.
HTTP Status Code: 400
- InvalidResourceStateException
-
The state of the resource is not valid for this operation.
HTTP Status Code: 400
- OperationNotSupportedException
-
This operation is not supported.
HTTP Status Code: 400
- ResourceAlreadyExistsException
-
The specified resource already exists.
HTTP Status Code: 400
- ResourceLimitExceededException
-
Your resource limits have been exceeded.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
