Skip to content

BatchGetCollectionRequest

Source code in docs_src/capo_opensearchserverless/types/batch_get_collection_request.py 
12
13
14
15
16
17
18
class BatchGetCollectionRequest(TypedDict, closed=True):
    ids: NotRequired["capo_opensearchserverless.types.collection_ids.CollectionIds"]
    """<p>A list of collection IDs. You can't provide names and IDs in the same request. 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>"""
    names: NotRequired[
        "capo_opensearchserverless.types.collection_names.CollectionNames"
    ]
    """<p>A list of collection names. You can't provide names and IDs in the same request.</p>"""

ids instance-attribute 

ids: NotRequired[CollectionIds]

A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

names instance-attribute 

names: NotRequired[CollectionNames]

A list of collection names. You can't provide names and IDs in the same request.