OpenSearchServiceServerless / Client / delete_collection_group

delete_collection_group

OpenSearchServiceServerless.Client.delete_collection_group(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_collection_group(
    id='string',
    clientToken='string'
)
Parameters:
  • id (string) –

    [REQUIRED]

    The unique identifier of the collection group to delete.

  • clientToken (string) –

    Unique, case-sensitive identifier to ensure idempotency of the request.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • OpenSearchServiceServerless.Client.exceptions.InternalServerException

  • OpenSearchServiceServerless.Client.exceptions.ConflictException

  • OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundException

  • OpenSearchServiceServerless.Client.exceptions.ValidationException