DeleteWorkgroup
Deletes a workgroup.
Request Syntax
{
"workgroupName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- workgroupName
-
The name of the workgroup to be deleted.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 64.
Pattern:
^[a-z0-9-]+$Required: Yes
Response Syntax
{
"workgroup": {
"baseCapacity": number,
"configParameters": [
{
"parameterKey": "string",
"parameterValue": "string"
}
],
"creationDate": "string",
"crossAccountVpcs": [ "string" ],
"customDomainCertificateArn": "string",
"customDomainCertificateExpiryTime": "string",
"customDomainName": "string",
"endpoint": {
"address": "string",
"port": number,
"vpcEndpoints": [
{
"networkInterfaces": [
{
"availabilityZone": "string",
"ipv6Address": "string",
"networkInterfaceId": "string",
"privateIpAddress": "string",
"subnetId": "string"
}
],
"vpcEndpointId": "string",
"vpcId": "string"
}
]
},
"enhancedVpcRouting": boolean,
"ipAddressType": "string",
"maxCapacity": number,
"namespaceName": "string",
"patchVersion": "string",
"pendingTrackName": "string",
"port": number,
"pricePerformanceTarget": {
"level": number,
"status": "string"
},
"publiclyAccessible": boolean,
"securityGroupIds": [ "string" ],
"status": "string",
"subnetIds": [ "string" ],
"trackName": "string",
"workgroupArn": "string",
"workgroupId": "string",
"workgroupName": "string",
"workgroupVersion": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The submitted action has conflicts.
HTTP Status Code: 400
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 400
- ValidationException
-
The input failed to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
