- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateWorkspaceBundleCommand
Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle .
Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { WorkSpacesClient, UpdateWorkspaceBundleCommand } from "@aws-sdk/client-workspaces"; // ES Modules import
// const { WorkSpacesClient, UpdateWorkspaceBundleCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import
const client = new WorkSpacesClient(config);
const input = { // UpdateWorkspaceBundleRequest
BundleId: "STRING_VALUE",
ImageId: "STRING_VALUE",
};
const command = new UpdateWorkspaceBundleCommand(input);
const response = await client.send(command);
// {};
UpdateWorkspaceBundleCommand Input
See UpdateWorkspaceBundleCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
BundleId | string | undefined | The identifier of the bundle. |
ImageId | string | undefined | The identifier of the image. |
UpdateWorkspaceBundleCommand Output
See UpdateWorkspaceBundleCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | The user is not authorized to access a resource. |
| InvalidParameterValuesException | client | One or more parameter values are not valid. |
| OperationNotSupportedException | client | This operation is not supported. |
| ResourceNotFoundException | client | The resource could not be found. |
| ResourceUnavailableException | client | The specified resource is not available. |
| WorkSpacesServiceException | Base exception class for all service exceptions from WorkSpaces service. |