Skip to content

DeleteCollectionRequest

Source code in docs_src/capo_opensearchserverless/types/delete_collection_request.py 
14
15
16
17
18
19
20
class DeleteCollectionRequest(TypedDict, closed=True):
    id: "capo_opensearchserverless.types.collection_id.CollectionId"
    """<p>The unique identifier of the collection. For example, <code>1iu5usc406kd</code>. The ID is part of the collection endpoint. You can also retrieve it using the <a href="https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html">ListCollections</a> API.</p>"""
    client_token: NotRequired[
        "capo_opensearchserverless.types.client_token.ClientToken"
    ]
    """<p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>"""

client_token instance-attribute 

client_token: NotRequired[ClientToken]

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

id instance-attribute 

id: CollectionId

The unique identifier of the collection. For example, 1iu5usc406kd. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.