AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

  • 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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateUpdatedWorkspaceImage and EndCreateUpdatedWorkspaceImage.

Namespace: Amazon.WorkSpaces
Assembly: AWSSDK.WorkSpaces.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<CreateUpdatedWorkspaceImageResponse> CreateUpdatedWorkspaceImageAsync(
         CreateUpdatedWorkspaceImageRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.WorkSpaces.Model.CreateUpdatedWorkspaceImageRequest

Container for the necessary parameters to execute the CreateUpdatedWorkspaceImage service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateUpdatedWorkspaceImage service method, as returned by WorkSpaces.

Exceptions

ExceptionCondition
AccessDeniedException The user is not authorized to access a resource.
InvalidParameterValuesException One or more parameter values are not valid.
InvalidResourceStateException The state of the resource is not valid for this operation.
OperationNotSupportedException This operation is not supported.
ResourceAlreadyExistsException The specified resource already exists.
ResourceLimitExceededException Your resource limits have been exceeded.
ResourceNotFoundException The resource could not be found.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also