Skip to content

CreateIndexRequest

Source code in docs_src/capo_opensearchserverless/types/create_index_request.py 
15
16
17
18
19
20
21
22
23
class CreateIndexRequest(TypedDict, closed=True):
    id: "capo_opensearchserverless.types.collection_id.CollectionId"
    """<p>The unique identifier of the collection in which to create the index.</p>"""
    index_name: "capo_opensearchserverless.types.index_name.IndexName"
    """<p>The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).</p>"""
    index_schema: NotRequired[
        "capo_opensearchserverless.types.index_schema.IndexSchema"
    ]
    """<p>The JSON schema definition for the index, including field mappings and settings.</p>"""

id instance-attribute 

id: CollectionId

The unique identifier of the collection in which to create the index.

index_name instance-attribute 

index_name: IndexName

The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).

index_schema instance-attribute 

index_schema: NotRequired[IndexSchema]

The JSON schema definition for the index, including field mappings and settings.