- 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.
TerminateWorkspacesPoolCommand
Terminates the specified pool.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { WorkSpacesClient, TerminateWorkspacesPoolCommand } from "@aws-sdk/client-workspaces"; // ES Modules import
// const { WorkSpacesClient, TerminateWorkspacesPoolCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import
const client = new WorkSpacesClient(config);
const input = { // TerminateWorkspacesPoolRequest
PoolId: "STRING_VALUE", // required
};
const command = new TerminateWorkspacesPoolCommand(input);
const response = await client.send(command);
// {};
TerminateWorkspacesPoolCommand Input
See TerminateWorkspacesPoolCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
PoolIdRequired | string | undefined | The identifier of the pool. |
TerminateWorkspacesPoolCommand Output
See TerminateWorkspacesPoolCommandOutput 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. |
| InvalidResourceStateException | client | The state of the resource is not valid for this operation. |
| OperationInProgressException | client | The properties of this WorkSpace are currently being modified. Try again in a moment. |
| ResourceNotFoundException | client | The resource could not be found. |
| WorkSpacesServiceException | Base exception class for all service exceptions from WorkSpaces service. |