Skip to content

CreateIndexRequest

Source code in docs_src/capo_opensearch/types/create_index_request.py
class CreateIndexRequest(TypedDict, closed=True):
    domain_name: "capo_opensearch.types.domain_name.DomainName"
    index_name: "capo_opensearch.types.index_name.IndexName"
    """<p>The name of the index to create. Must be between 1 and 255 characters and follow OpenSearch naming conventions.</p>"""
    index_schema: "capo_opensearch.types.index_schema.IndexSchema"
    """<p>The JSON schema defining index mappings, settings, and semantic enrichment configuration. The schema specifies which text fields should be automatically enriched for semantic search capabilities and includes OpenSearch index configuration parameters.</p>"""

domain_name instance-attribute

domain_name: DomainName

index_name instance-attribute

index_name: IndexName

The name of the index to create. Must be between 1 and 255 characters and follow OpenSearch naming conventions.

index_schema instance-attribute

index_schema: IndexSchema

The JSON schema defining index mappings, settings, and semantic enrichment configuration. The schema specifies which text fields should be automatically enriched for semantic search capabilities and includes OpenSearch index configuration parameters.