OpenSearchService / Client / create_index

create_index

OpenSearchService.Client.create_index(**kwargs)

Creates an OpenSearch index with optional automatic semantic enrichment for specified text fields. Automatic semantic enrichment enables semantic search capabilities without requiring machine learning expertise, improving search relevance by up to 20% by understanding search intent and contextual meaning beyond keyword matching. The semantic enrichment process has zero impact on search latency as sparse encodings are stored directly within the index during indexing. For more information, see Automatic semantic enrichment.

See also: AWS API Documentation

Request Syntax

response = client.create_index(
    DomainName='string',
    IndexName='string',
    IndexSchema={...}|[...]|123|123.4|'string'|True|None
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

  • IndexName (string) –

    [REQUIRED]

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

  • IndexSchema (document) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'CREATED'|'UPDATED'|'DELETED'
}

Response Structure

  • (dict) –

    • Status (string) –

      The status of the index creation operation.

Exceptions