Skip to content

UpdateCollectionRequest

Source code in docs_src/capo_opensearchserverless/types/update_collection_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class UpdateCollectionRequest(TypedDict, closed=True):
    id: "capo_opensearchserverless.types.collection_id.CollectionId"
    """<p>The unique identifier of the collection.</p>"""
    description: NotRequired["str"]
    """<p>A description of the collection.</p>"""
    vector_options: NotRequired[
        "capo_opensearchserverless.types.vector_options.VectorOptions"
    ]
    """<p>Configuration options for vector search capabilities in the collection.</p>"""
    deletion_protection: NotRequired[
        "capo_opensearchserverless.types.deletion_protection.DeletionProtection"
    ]
    """<p>Indicates whether to enable or disable deletion protection for the collection. When set to <code>ENABLED</code>, the collection cannot be deleted.</p>"""
    client_token: NotRequired[
        "capo_opensearchserverless.types.client_token.ClientToken"
    ]
    """<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>"""

client_token instance-attribute 

client_token: NotRequired[ClientToken]

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

deletion_protection instance-attribute 

deletion_protection: NotRequired[DeletionProtection]

Indicates whether to enable or disable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.

description instance-attribute 

description: NotRequired[str]

A description of the collection.

id instance-attribute 

id: CollectionId

The unique identifier of the collection.

vector_options instance-attribute 

vector_options: NotRequired[VectorOptions]

Configuration options for vector search capabilities in the collection.