DeleteCollectionGroup
Deletes a collection group. You can only delete empty collection groups that contain no collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Request Syntax
{
"clientToken": "string",
"id": "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.
- clientToken
-
Unique, case-sensitive identifier to ensure idempotency of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Required: No
- id
-
The unique identifier of the collection group to delete.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 40.
Pattern:
[a-z0-9]{3,40}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.
- ConflictException
-
When creating a resource, thrown when a resource with the same name already exists or is being created.
HTTP Status Code: 400
- InternalServerException
-
Thrown when an error internal to the service occurs while processing a request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Thrown when accessing or deleting a resource that does not exist.
HTTP Status Code: 400
- ValidationException
-
Thrown when the HTTP request contains invalid input or is missing required input.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: