Use this operation to delete a workforce.
If you want to create a new workforce in an AWS Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.
Important
If a private workforce contains one or more work teams, you must use
the DeleteWorkteam
operation to delete all work teams before you delete the workforce.
If you try to delete a workforce that contains one or more work teams,
you will receive a ResourceInUse error.
Request Syntax
{
"WorkforceName": "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.
- WorkforceName
-
The name of the workforce.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9]([a-zA-Z0-9\-]){0,62}$Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
