Skip to content

UpdateCollectionGroupRequest

Source code in docs_src/capo_opensearchserverless/types/update_collection_group_request.py
class UpdateCollectionGroupRequest(TypedDict, closed=True):
    id: "capo_opensearchserverless.types.collection_group_id.CollectionGroupId"
    """<p>The unique identifier of the collection group to update.</p>"""
    description: NotRequired["str"]
    """<p>A new description for the collection group.</p>"""
    capacity_limits: NotRequired[
        "capo_opensearchserverless.types.collection_group_capacity_limits.CollectionGroupCapacityLimits"
    ]
    """<p>Updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs).</p>"""
    client_token: NotRequired[
        "capo_opensearchserverless.types.client_token.ClientToken"
    ]
    """<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>"""

capacity_limits instance-attribute

capacity_limits: NotRequired[CollectionGroupCapacityLimits]

Updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs).

client_token instance-attribute

client_token: NotRequired[ClientToken]

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

description instance-attribute

description: NotRequired[str]

A new description for the collection group.

id instance-attribute

The unique identifier of the collection group to update.