DeleteWorkgroupCommand

Suggest an Edit

Deletes a workgroup.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RedshiftServerlessClient, DeleteWorkgroupCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import
// const { RedshiftServerlessClient, DeleteWorkgroupCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import
const client = new RedshiftServerlessClient(config);
const input = { // DeleteWorkgroupRequest
  workgroupName: "STRING_VALUE", // required
};
const command = new DeleteWorkgroupCommand(input);
const response = await client.send(command);
// { // DeleteWorkgroupResponse
//   workgroup: { // Workgroup
//     workgroupId: "STRING_VALUE",
//     workgroupArn: "STRING_VALUE",
//     workgroupName: "STRING_VALUE",
//     namespaceName: "STRING_VALUE",
//     baseCapacity: Number("int"),
//     enhancedVpcRouting: true || false,
//     configParameters: [ // ConfigParameterList
//       { // ConfigParameter
//         parameterKey: "STRING_VALUE",
//         parameterValue: "STRING_VALUE",
//       },
//     ],
//     securityGroupIds: [ // SecurityGroupIdList
//       "STRING_VALUE",
//     ],
//     subnetIds: [ // SubnetIdList
//       "STRING_VALUE",
//     ],
//     status: "STRING_VALUE",
//     endpoint: { // Endpoint
//       address: "STRING_VALUE",
//       port: Number("int"),
//       vpcEndpoints: [ // VpcEndpointList
//         { // VpcEndpoint
//           vpcEndpointId: "STRING_VALUE",
//           vpcId: "STRING_VALUE",
//           networkInterfaces: [ // NetworkInterfaceList
//             { // NetworkInterface
//               networkInterfaceId: "STRING_VALUE",
//               subnetId: "STRING_VALUE",
//               privateIpAddress: "STRING_VALUE",
//               availabilityZone: "STRING_VALUE",
//               ipv6Address: "STRING_VALUE",
//             },
//           ],
//         },
//       ],
//     },
//     publiclyAccessible: true || false,
//     creationDate: new Date("TIMESTAMP"),
//     port: Number("int"),
//     customDomainName: "STRING_VALUE",
//     customDomainCertificateArn: "STRING_VALUE",
//     customDomainCertificateExpiryTime: new Date("TIMESTAMP"),
//     workgroupVersion: "STRING_VALUE",
//     patchVersion: "STRING_VALUE",
//     maxCapacity: Number("int"),
//     crossAccountVpcs: [ // VpcIds
//       "STRING_VALUE",
//     ],
//     ipAddressType: "STRING_VALUE",
//     pricePerformanceTarget: { // PerformanceTarget
//       status: "STRING_VALUE",
//       level: Number("int"),
//     },
//     trackName: "STRING_VALUE",
//     pendingTrackName: "STRING_VALUE",
//   },
// };

DeleteWorkgroupCommand Input

See DeleteWorkgroupCommandInput for more details

Parameter
Type
Description
workgroupName
Required
string | undefined

The name of the workgroup to be deleted.

DeleteWorkgroupCommand Output

See DeleteWorkgroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
workgroup
Required
Workgroup | undefined

The deleted workgroup object.

Throws

Name
Fault
Details
ConflictException
client

The submitted action has conflicts.

InternalServerException
server

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The resource could not be found.

ValidationException
client

The input failed to satisfy the constraints specified by an AWS service.

RedshiftServerlessServiceException
Base exception class for all service exceptions from RedshiftServerless service.