Skip to content

ListCollectionsRequest

Source code in docs_src/capo_opensearchserverless/types/list_collections_request.py 
11
12
13
14
15
16
17
18
19
class ListCollectionsRequest(TypedDict, closed=True):
    collection_filters: NotRequired[
        "capo_opensearchserverless.types.collection_filters.CollectionFilters"
    ]
    """<p> A list of filter names and values that you can use for requests.</p>"""
    next_token: NotRequired["str"]
    """<p>If your initial <code>ListCollections</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListCollections</code> operations, which returns results in the next page.</p>"""
    max_results: NotRequired["int"]
    """<p>The maximum number of results to return. Default is 20. You can use <code>nextToken</code> to get the next page of results.</p>"""

collection_filters instance-attribute 

collection_filters: NotRequired[CollectionFilters]

A list of filter names and values that you can use for requests.

max_results instance-attribute 

max_results: NotRequired[int]

The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

next_token instance-attribute 

next_token: NotRequired[str]

If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.