# Indices

class elasticsearch.client.IndicesClient

  To use this client, access `client.indices` from an `Elasticsearch` client. For example:

      from elasticsearch import Elasticsearch

      # Create the client instance
      client = Elasticsearch(...)
      # Use the indices client
      client.indices.<method>(...)

  add_block(*, index, block, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, master_timeout=None, pretty=None, timeout=None)

    Add an index block.

    Add an index block to an index. Index blocks limit the operations allowed on an index by blocking specific operation types.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-add-block

    Parameters:

      - index (str | Sequence[str]) – A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are adding blocks to. To allow the adding of blocks to indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the elasticsearch.yml file or by using the cluster update settings API.

      - block (str | Literal['metadata', 'read', 'read_only', 'write']) – The block type to add to the index.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to -1 to indicate that the request should never timeout.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  analyze(*, index=None, analyzer=None, attributes=None, char_filter=None, error_trace=None, explain=None, field=None, filter=None, filter_path=None, human=None, normalizer=None, pretty=None, text=None, tokenizer=None, body=None)

    Get tokens from text analysis.

    The analyze API performs analysis on a text string and returns the resulting tokens.

    Generating excessive amount of tokens may cause a node to run out of memory. The `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced. If more than this limit of tokens gets generated, an error occurs. The `_analyze` endpoint without a specified index will always use `10000` as its limit.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze

    Parameters:

      - index (str | None) – Index used to derive the analyzer. If specified, the analyzer or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.

      - analyzer (str | None) – The name of the analyzer that should be applied to the provided text. This could be a built-in analyzer, or an analyzer that’s been configured in the index.

      - attributes (Sequence[str] | None) – Array of token attributes used to filter the output of the explain parameter.

      - char_filter (Sequence[str | Mapping[str, Any]] | None) – Array of character filters used to preprocess characters before the tokenizer.

      - explain (bool | None) – If true, the response includes token attributes and additional details.

      - field (str | None) – Field used to derive the analyzer. To use this parameter, you must specify an index. If specified, the analyzer parameter overrides this value.

      - filter (Sequence[str | Mapping[str, Any]] | None) – Array of token filters used to apply after the tokenizer.

      - normalizer (str | None) – Normalizer to use to convert text into a single token.

      - text (str | Sequence[str] | None) – Text to analyze. If an array of strings is provided, it is analyzed as a multi-value field.

      - tokenizer (str | Mapping[str, Any] | None) – Tokenizer to use to convert text into tokens.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  cancel_migrate_reindex(*, index, error_trace=None, filter_path=None, human=None, pretty=None)

    Cancel a migration reindex operation.

    Cancel a migration reindex attempt for a data stream or index.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-cancel-migrate-reindex

    Parameters:

      - index (str | Sequence[str]) – The index or data stream name

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  clear_cache(*, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, fielddata=None, fields=None, filter_path=None, human=None, ignore_unavailable=None, pretty=None, query=None, request=None)

    Clear the cache.

    Clear the cache of one or more indices. For data streams, the API clears the caches of the stream's backing indices.

    By default, the clear cache API clears all caches. To clear only specific caches, use the `fielddata`, `query`, or `request` parameters. To clear the cache only of specific fields, use the `fields` parameter.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clear-cache

    Parameters:

      - index (str | Sequence[str] | None) – Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - fielddata (bool | None) – If true, clears the fields cache. Use the fields parameter to clear the cache of specific fields only.

      - fields (str | Sequence[str] | None) – Comma-separated list of field names used to limit the fielddata parameter.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - query (bool | None) – If true, clears the query cache.

      - request (bool | None) – If true, clears the request cache.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  clone(*, index, target, aliases=None, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, settings=None, timeout=None, wait_for_active_shards=None, body=None)

    Clone an index.

    Clone an existing index into a new index. Each original primary shard is cloned into a new primary shard in the new index.

    IMPORTANT: Elasticsearch does not apply index templates to the resulting index. The API also does not copy index metadata from the original index. Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. For example, if you clone a CCR follower index, the resulting clone will not be a follower index.

    The clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`. To set the number of replicas in the resulting index, configure these settings in the clone request.

    Cloning works as follows:

    - First, it creates a new target index with the same definition as the source index.
    - Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.
    - Finally, it recovers the target index as though it were a closed index which had just been re-opened.

    IMPORTANT: Indices can only be cloned if they meet the following requirements:

    - The index must be marked as read-only and have a cluster health status of green.
    - The target index must not exist.
    - The source index must have the same number of primary shards as the target index.
    - The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.

    The current write index on a data stream cannot be cloned. In order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned.

    NOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index.

    Monitor the cloning process

    The cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`.

    The `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated. At this point, all shards are in the state unassigned. If, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node.

    Once the primary shard is allocated, it moves to state initializing, and the clone process begins. When the clone operation completes, the shard will become active. At that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node.

    Wait for active shards

    Because the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone

    Parameters:

      - index (str) – Name of the source index to clone.

      - target (str) – Name of the target index to create.

      - aliases (Mapping[str, Mapping[str, Any]] | None) – Aliases for the resulting index.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - settings (Mapping[str, Any] | None) – Configuration options for the target index.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - wait_for_active_shards (int | str | Literal['all', 'index-setting'] | None) – The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  close(*, index, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, master_timeout=None, pretty=None, timeout=None, wait_for_active_shards=None)

    Close an index.

    A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. It is not possible to index documents or to search for documents in a closed index. Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster.

    When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. The shards will then go through the normal recovery process. The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.

    You can open and close multiple indices. An error is thrown if the request explicitly refers to a missing index. This behaviour can be turned off using the `ignore_unavailable=true` parameter.

    By default, you must explicitly name the indices you are opening or closing. To open or close indices with `_all`, `*`, or other wildcard expressions, change the`action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API.

    Closed indices consume a significant amount of disk-space which can cause problems in managed environments. Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-close

    Parameters:

      - index (str | Sequence[str]) – Comma-separated list or wildcard expression of index names used to limit the request.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - wait_for_active_shards (int | str | Literal['all', 'index-setting'] | None) – The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  create(*, index, aliases=None, error_trace=None, filter_path=None, human=None, mappings=None, master_timeout=None, pretty=None, settings=None, timeout=None, wait_for_active_shards=None, body=None)

    Create an index.

    You can use the create index API to add a new index to an Elasticsearch cluster. When creating an index, you can specify the following:

    - Settings for the index.
    - Mappings for fields in the index.
    - Index aliases

    Wait for active shards

    By default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out. The index creation response will indicate what happened. For example, `acknowledged` indicates whether the index was successfully created in the cluster, `while shards_acknowledged` indicates whether the requisite number of shard copies were started for each shard in the index before timing out. Note that it is still possible for either `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation to be successful. These values simply indicate whether the operation completed before the timeout. If `acknowledged` is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon. If `shards_acknowledged` is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, `acknowledged` is `true`).

    You can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`. Note that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create

    Parameters:

      - index (str) – Name of the index you wish to create. Index names must meet the following criteria: * Lowercase only * Cannot include `, `/, *, ?, “, <, >, |, ` ` (space character), ,, or # * Indices prior to 7.0 could contain a colon (:), but that has been deprecated and will not be supported in later versions * Cannot start with -, _, or + * Cannot be . or .. * Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster) * Names starting with . are deprecated, except for hidden indices and internal indices managed by plugins

      - aliases (Mapping[str, Mapping[str, Any]] | None) – Aliases for the index.

      - mappings (Mapping[str, Any] | None) – Mapping for fields in the index. If specified, this mapping can include: - Field names - Field data types - Mapping parameters

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - settings (Mapping[str, Any] | None) – Configuration options for the index.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - wait_for_active_shards (int | str | Literal['all', 'index-setting'] | None) – The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  create_data_stream(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

    Create a data stream.

    You must have a matching index template with data stream enabled.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-data-stream

    Parameters:

      - name (str) – Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include `, `/, *, ?, “, <, >, |, ,, #, :, or a space character; Cannot start with -, _, +, or .ds-; Cannot be . or ..; Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  create_from(*, source, dest, create_from=None, body=None, error_trace=None, filter_path=None, human=None, pretty=None)

    Create an index from a source index.

    Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-from

    Parameters:

      - source (str) – The source index or data stream name

      - dest (str) – The destination index or data stream name

      - create_from (Mapping[str, Any] | None)

      - body (Mapping[str, Any] | None)

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  data_streams_stats(*, name=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, pretty=None)

    Get data stream stats.

    Get statistics for one or more data streams.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-data-streams-stats-1

    Parameters:

      - name (str | Sequence[str] | None) – Comma-separated list of data streams used to limit the request. Wildcard expressions (*) are supported. To target all data streams in a cluster, omit this parameter or use *.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  delete(*, index, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, master_timeout=None, pretty=None, timeout=None)

    Delete indices.

    Deleting an index deletes its documents, shards, and metadata. It does not delete related Kibana components, such as data views, visualizations, or dashboards.

    You cannot delete the current write index of a data stream. To delete the index, you must roll over the data stream so a new write index is created. You can then use the delete index API to delete the previous write index.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete

    Parameters:

      - index (str | Sequence[str]) – Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (*) or _all. To use wildcards or _all, set the action.destructive_requires_name cluster setting to false.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  delete_alias(*, index, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

    Delete an alias.

    Removes a data stream or index from an alias.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-alias

    Parameters:

      - index (str | Sequence[str]) – Comma-separated list of data streams or indices used to limit the request. Supports wildcards (*).

      - name (str | Sequence[str]) – Comma-separated list of aliases to remove. Supports wildcards (*). To remove all aliases, use * or _all.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  delete_data_lifecycle(*, name, error_trace=None, expand_wildcards=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

    Delete data stream lifecycles.

    Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle

    Parameters:

      - name (str | Sequence[str]) – A comma-separated list of data streams of which the data stream lifecycle will be deleted. Use * to get all data streams

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Whether wildcard expressions should get expanded to open or closed indices (default: open)

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a response.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  delete_data_stream(*, name, error_trace=None, expand_wildcards=None, filter_path=None, human=None, master_timeout=None, pretty=None)

    Delete data streams.

    Deletes one or more data streams and their backing indices.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream

    Parameters:

      - name (str | Sequence[str]) – Comma-separated list of data streams to delete. Wildcard (*) expressions are supported.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of data stream that wildcard patterns can match. Supports comma-separated values,such as open,hidden.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  delete_data_stream_options(*, name, error_trace=None, expand_wildcards=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

    Delete data stream options.

    Removes the data stream options from a data stream.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream-options

    Parameters:

      - name (str | Sequence[str]) – A comma-separated list of data streams of which the data stream options will be deleted. Use * to get all data streams

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Whether wildcard expressions should get expanded to open or closed indices

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a response.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  delete_index_template(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

    Delete an index template.

    The provided may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-index-template

    Parameters:

      - name (str | Sequence[str]) – Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  delete_sample_configuration(*, index, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

    Delete sampling configuration.

    Delete the sampling configuration for the specified index.

    https://www.elastic.co/docs/api/doc/elasticsearch#TODO

    Parameters:

      - index (str) – The name of the index.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  delete_template(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

    Delete a legacy index template.

    IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-template

    Parameters:

      - name (str) – The name of the legacy index template to delete. Wildcard (*) expressions are supported.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  disk_usage(*, index, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, flush=None, human=None, ignore_unavailable=None, pretty=None, run_expensive_tasks=None)

    Analyze the index disk usage.

    Analyze the disk usage of each field of an index or data stream. This API might not support indices created in previous Elasticsearch versions. The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.

    NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API. Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate. The stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.

    For usage examples see the External documentation or refer to Analyze the index disk usage example for an example.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage

    Parameters:

      - index (str | Sequence[str]) – Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - flush (bool | None) – If true, the API performs a flush before analysis. If false, the response may not include uncommitted data.

      - ignore_unavailable (bool | None) – If true, missing or closed indices are not included in the response.

      - run_expensive_tasks (bool | None) – Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to true.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  downsample(*, index, target_index, config=None, body=None, error_trace=None, filter_path=None, human=None, pretty=None)

    Downsample an index.

    Downsamples a time series (TSDS) index and reduces its size by keeping the last value or by pre-aggregating metrics:

    - When running in `aggregate` mode, it pre-calculates and stores statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval and their dimensions.
    - When running in `last_value` mode, it keeps the last value for each metric in the configured interval and their dimensions.

    For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. All documents within an hour interval are summarized and stored as a single document in the downsample index.

    NOTE: Only indices in a time series data stream are supported. Neither field nor document level security can be defined on the source index. The source index must be read-only (`index.blocks.write: true`).

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample

    Parameters:

      - index (str) – Name of the time series index to downsample.

      - target_index (str) – Name of the index to create.

      - config (Mapping[str, Any] | None)

      - body (Mapping[str, Any] | None)

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  exists(*, index, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, flat_settings=None, human=None, ignore_unavailable=None, include_defaults=None, local=None, pretty=None)

    Check indices.

    Check if one or more indices, index aliases, or data streams exist.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists

    Parameters:

      - index (str | Sequence[str]) – Comma-separated list of data streams, indices, and aliases. Supports wildcards (*).

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - flat_settings (bool | None) – If true, returns settings in flat format.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - include_defaults (bool | None) – If true, return all default settings in the response.

      - local (bool | None) – If true, the request retrieves information from the local node only.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      HeadApiResponse

  exists_alias(*, name, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, master_timeout=None, pretty=None)

    Check aliases.

    Check if one or more data stream or index aliases exist.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-alias

    Parameters:

      - name (str | Sequence[str]) – Comma-separated list of aliases to check. Supports wildcards (*).

      - index (str | Sequence[str] | None) – Comma-separated list of data streams or indices used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, requests that include a missing data stream or index in the target indices or data streams return an error.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      HeadApiResponse

  exists_index_template(*, name, error_trace=None, filter_path=None, flat_settings=None, human=None, local=None, master_timeout=None, pretty=None)

    Check index templates.

    Check whether index templates exist.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-index-template

    Parameters:

      - name (str) – Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.

      - flat_settings (bool | None) – If true, returns settings in flat format.

      - local (bool | None) – If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      HeadApiResponse

  exists_template(*, name, error_trace=None, filter_path=None, flat_settings=None, human=None, local=None, master_timeout=None, pretty=None)

    Check existence of index templates.

    Get information about whether index templates exist. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

    IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-template

    Parameters:

      - name (str | Sequence[str]) – A comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.

      - flat_settings (bool | None) – Indicates whether to use a flat format for the response.

      - local (bool | None) – Indicates whether to get information from the local node only.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      HeadApiResponse

  explain_data_lifecycle(*, index, error_trace=None, filter_path=None, human=None, include_defaults=None, master_timeout=None, pretty=None)

    Get the status for a data stream lifecycle.

    Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle

    Parameters:

      - index (str | Sequence[str]) – Comma-separated list of index names to explain

      - include_defaults (bool | None) – Indicates if the API should return the default values the system uses for the index’s lifecycle

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  field_usage_stats(*, index, allow_no_indices=None, error_trace=None, expand_wildcards=None, fields=None, filter_path=None, human=None, ignore_unavailable=None, pretty=None)

    Get field usage stats.

    Get field usage information for each shard and field of an index. Field usage statistics are automatically captured when queries are running on a cluster. A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.

    The response body reports the per-shard usage count of the data structures that back the fields in the index. A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-field-usage-stats

    Parameters:

      - index (str | Sequence[str]) – Comma-separated list or wildcard expression of index names used to limit the request.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - fields (str | Sequence[str] | None) – Comma-separated list or wildcard expressions of fields to include in the statistics.

      - ignore_unavailable (bool | None) – If true, missing or closed indices are not included in the response.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  flush(*, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, force=None, human=None, ignore_unavailable=None, pretty=None, wait_if_ongoing=None)

    Flush data streams or indices.

    Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush.

    After each operation has been flushed it is permanently stored in the Lucene index. This may mean that there is no need to maintain an additional copy of it in the transaction log. The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space.

    It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-flush

    Parameters:

      - index (str | Sequence[str] | None) – Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (*). To flush all data streams and indices, omit this parameter or use * or _all.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - force (bool | None) – If true, the request forces a flush even if there are no changes to commit to the index.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - wait_if_ongoing (bool | None) – If true, the flush operation blocks until execution when another flush operation is running. If false, Elasticsearch returns an error if you request a flush when another flush operation is running.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  forcemerge(*, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, flush=None, human=None, ignore_unavailable=None, max_num_segments=None, only_expunge_deletes=None, pretty=None, wait_for_completion=None)

    Force a merge.

    Perform the force merge operation on the shards of one or more indices. For data streams, the API forces a merge on the shards of the stream's backing indices.

    Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. Merging normally happens automatically, but sometimes it is useful to trigger a merge manually.

    WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". These soft-deleted documents are automatically cleaned up during regular segment merges. But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.

    Blocks during a force merge

    Calls to this API block until the merge is complete (unless request contains `wait_for_completion=false`). If the client connection is lost before completion then the force merge process will continue in the background. Any new requests to force merge the same indices will also block until the ongoing force merge is complete.

    Running force merge asynchronously

    If the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task. However, you can not cancel this task as the force merge task is not cancelable. Elasticsearch creates a record of this task as a document at `_tasks/<task_id>`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.

    Force merging multiple indices

    You can force merge multiple indices with a single request by targeting:

    - One or more data streams that contain multiple backing indices
    - Multiple indices
    - One or more aliases
    - All data streams and indices in a cluster

    Each targeted shard is force-merged separately using the force_merge threadpool. By default each node only has a single `force_merge` thread which means that the shards on that node are force-merged one at a time. If you expand the `force_merge` threadpool on a node then it will force merge its shards in parallel

    Force merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one.

    Data streams and time-based indices

    Force-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover. In these cases, each index only receives indexing traffic for a certain period of time. Once an index receive no more writes, its shards can be force-merged to a single segment. This can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches. For example:

        POST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-forcemerge

    Parameters:

      - index (str | Sequence[str] | None) – A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      - allow_no_indices (bool | None) – Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Whether to expand wildcard expression to concrete indices that are open, closed or both.

      - flush (bool | None) – Specify whether the index should be flushed after performing the operation

      - ignore_unavailable (bool | None) – Whether specified concrete indices should be ignored when unavailable (missing or closed)

      - max_num_segments (int | None) – The number of segments the index should be merged into (default: dynamic)

      - only_expunge_deletes (bool | None) – Specify whether the operation should only expunge deleted documents

      - wait_for_completion (bool | None) – Should the request wait until the force merge is completed

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get(*, index, allow_no_indices=None, error_trace=None, expand_wildcards=None, features=None, filter_path=None, flat_settings=None, human=None, ignore_unavailable=None, include_defaults=None, local=None, master_timeout=None, pretty=None)

    Get index information.

    Get information about one or more indices. For data streams, the API returns information about the stream’s backing indices.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get

    Parameters:

      - index (str | Sequence[str]) – Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - features (Sequence[str | Literal['aliases', 'mappings', 'settings']] | str | ~typing.Literal['aliases', 'mappings', 'settings'] | None) – Return only information on specified index features

      - flat_settings (bool | None) – If true, returns settings in flat format.

      - ignore_unavailable (bool | None) – If false, requests that target a missing index return an error.

      - include_defaults (bool | None) – If true, return all default settings in the response.

      - local (bool | None) – If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_alias(*, index=None, name=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, master_timeout=None, pretty=None)

    Get aliases.

    Retrieves information for one or more data stream or index aliases.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-alias

    Parameters:

      - index (str | Sequence[str] | None) – Comma-separated list of data streams or indices used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      - name (str | Sequence[str] | None) – Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_all_sample_configuration(*, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None)

    Get all sampling configurations.

    Get the sampling configurations for all indices.

    https://www.elastic.co/docs/api/doc/elasticsearch#TODO

    Parameters:

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_data_lifecycle(*, name, error_trace=None, expand_wildcards=None, filter_path=None, human=None, include_defaults=None, master_timeout=None, pretty=None)

    Get data stream lifecycles.

    Get the data stream lifecycle configuration of one or more data streams.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle

    Parameters:

      - name (str | Sequence[str]) – Comma-separated list of data streams to limit the request. Supports wildcards (*). To target all data streams, omit this parameter or use * or _all.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

      - include_defaults (bool | None) – If true, return all default settings in the response.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_data_lifecycle_stats(*, error_trace=None, filter_path=None, human=None, pretty=None)

    Get data stream lifecycle stats.

    Get statistics about the data streams that are managed by a data stream lifecycle.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle-stats

    Parameters:

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_data_stream(*, name=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, include_defaults=None, master_timeout=None, pretty=None, verbose=None)

    Get data streams.

    Get information about one or more data streams.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream

    Parameters:

      - name (str | Sequence[str] | None) – Comma-separated list of data stream names used to limit the request. Wildcard (*) expressions are supported. If omitted, all data streams are returned.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

      - include_defaults (bool | None) – If true, returns all relevant default configurations for the index template.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - verbose (bool | None) – Whether the maximum timestamp for each data stream should be calculated and returned.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_data_stream_mappings(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None)

    Get data stream mappings.

    Get mapping information for one or more data streams.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-mappings

    Parameters:

      - name (str | Sequence[str]) – A comma-separated list of data streams or data stream patterns. Supports wildcards (*).

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_data_stream_options(*, name, error_trace=None, expand_wildcards=None, filter_path=None, human=None, master_timeout=None, pretty=None)

    Get data stream options.

    Get the data stream options configuration of one or more data streams.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-options

    Parameters:

      - name (str | Sequence[str]) – Comma-separated list of data streams to limit the request. Supports wildcards (*). To target all data streams, omit this parameter or use * or _all.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_data_stream_settings(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None)

    Get data stream settings.

    Get setting information for one or more data streams.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-settings

    Parameters:

      - name (str | Sequence[str]) – A comma-separated list of data streams or data stream patterns. Supports wildcards (*).

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_field_mapping(*, fields, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, include_defaults=None, pretty=None)

    Get mapping definitions.

    Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices.

    This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping

    Parameters:

      - fields (str | Sequence[str]) – Comma-separated list or wildcard expression of fields used to limit returned information. Supports wildcards (*).

      - index (str | Sequence[str] | None) – Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - include_defaults (bool | None) – If true, return all default settings in the response.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_index_template(*, name=None, error_trace=None, filter_path=None, flat_settings=None, human=None, include_defaults=None, local=None, master_timeout=None, pretty=None)

    Get index templates.

    Get information about one or more index templates.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-index-template

    Parameters:

      - name (str | None) – Name of index template to retrieve. Wildcard (*) expressions are supported.

      - flat_settings (bool | None) – If true, returns settings in flat format.

      - include_defaults (bool | None) – If true, returns all relevant default configurations for the index template.

      - local (bool | None) – If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_mapping(*, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, local=None, master_timeout=None, pretty=None)

    Get mapping definitions.

    For data streams, the API retrieves mappings for the stream’s backing indices.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping

    Parameters:

      - index (str | Sequence[str] | None) – Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - local (bool | None) – If true, the request retrieves information from the local node only.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_migrate_reindex_status(*, index, error_trace=None, filter_path=None, human=None, pretty=None)

    Get the migration reindexing status.

    Get the status of a migration reindex attempt for a data stream or index.

    https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-migration

    Parameters:

      - index (str | Sequence[str]) – The index or data stream name.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_sample(*, index, error_trace=None, filter_path=None, human=None, pretty=None)

    Request for a random sample of raw documents ingested into the given index or data stream.

    https://www.elastic.co/docs/api/doc/elasticsearch#TODO

    Parameters:

      - index (str) – Single index or data stream name. Wildcards are not supported.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_sample_configuration(*, index, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None)

    Get sampling configuration.

    Get the sampling configuration for the specified index.

    https://www.elastic.co/docs/api/doc/elasticsearch#TODO

    Parameters:

      - index (str) – The name of the index.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_sample_stats(*, index, error_trace=None, filter_path=None, human=None, pretty=None)

    Request stats for a random sample of raw documents ingested into the given index or data stream.

    https://www.elastic.co/docs/api/doc/elasticsearch#TODO

    Parameters:

      - index (str) – Single index or data stream name. Wildcards are not supported.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_settings(*, index=None, name=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, flat_settings=None, human=None, ignore_unavailable=None, include_defaults=None, local=None, master_timeout=None, pretty=None)

    Get index settings.

    Get setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings

    Parameters:

      - index (str | Sequence[str] | None) – Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      - name (str | Sequence[str] | None) – Comma-separated list or wildcard expression of settings to retrieve.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - flat_settings (bool | None) – If true, returns settings in flat format.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - include_defaults (bool | None) – If true, return all default settings in the response.

      - local (bool | None) – If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_template(*, name=None, error_trace=None, filter_path=None, flat_settings=None, human=None, local=None, master_timeout=None, pretty=None)

    Get legacy index templates.

    Get information about one or more index templates.

    IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-template

    Parameters:

      - name (str | Sequence[str] | None) – Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. To return all index templates, omit this parameter or use a value of _all or *.

      - flat_settings (bool | None) – If true, returns settings in flat format.

      - local (bool | None) – If true, the request retrieves information from the local node only.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  migrate_reindex(*, reindex=None, body=None, error_trace=None, filter_path=None, human=None, pretty=None)

    Reindex legacy backing indices.

    Reindex all legacy backing indices for a data stream. This operation occurs in a persistent task. The persistent task ID is returned immediately and the reindexing work is completed in that task.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-reindex

    Parameters:

      - reindex (Mapping[str, Any] | None)

      - body (Mapping[str, Any] | None)

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  migrate_to_data_stream(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

    Convert an index alias to a data stream.

    Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-to-data-stream

    Parameters:

      - name (str) – Name of the index alias to convert to a data stream.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  modify_data_stream(*, actions=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)

    Update data streams.

    Performs one or more data stream modification actions in a single atomic operation.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-modify-data-stream

    Parameters:

      - actions (Sequence[Mapping[str, Any]] | None) – Actions to perform.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  open(*, index, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, master_timeout=None, pretty=None, timeout=None, wait_for_active_shards=None)

    Open a closed index.

    For data streams, the API opens any closed backing indices.

    A closed index is blocked for read/write operations and does not allow all operations that opened indices allow. It is not possible to index documents or to search for documents in a closed index. This allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster.

    When opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index. The shards will then go through the normal recovery process. The data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.

    You can open and close multiple indices. An error is thrown if the request explicitly refers to a missing index. This behavior can be turned off by using the `ignore_unavailable=true` parameter.

    By default, you must explicitly name the indices you are opening or closing. To open or close indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API.

    Closed indices consume a significant amount of disk-space which can cause problems in managed environments. Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.

    Because opening or closing an index allocates its shards, the `wait_for_active_shards` setting on index creation applies to the `_open` and `_close` index actions as well.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-open

    Parameters:

      - index (str | Sequence[str]) – Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). By default, you must explicitly name the indices you using to limit the request. To limit a request using _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the elasticsearch.yml file or using the cluster update settings API.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - wait_for_active_shards (int | str | Literal['all', 'index-setting'] | None) – The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  promote_data_stream(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None)

    Promote a data stream.

    Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.

    With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. These data streams can't be rolled over in the local cluster. These replicated data streams roll over only if the upstream data stream rolls over. In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.

    NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. If this is missing, the data stream will not be able to roll over until a matching index template is created. This will affect the lifecycle management of the data stream and interfere with the data stream size and retention.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-promote-data-stream

    Parameters:

      - name (str) – The name of the data stream to promote

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  put_alias(*, index, name, error_trace=None, filter=None, filter_path=None, human=None, index_routing=None, is_write_index=None, master_timeout=None, pretty=None, routing=None, search_routing=None, timeout=None, body=None)

    Create or update an alias.

    Adds a data stream or index to an alias.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-alias

    Parameters:

      - index (str | Sequence[str]) – Comma-separated list of data streams or indices to add. Supports wildcards (*). Wildcard patterns that match both data streams and indices return an error.

      - name (str) – Alias to update. If the alias doesn’t exist, the request creates it. Index alias names support date math.

      - filter (Mapping[str, Any] | None) – Query used to limit documents the alias can access.

      - index_routing (str | Sequence[str] | None) – Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations. Data stream aliases don’t support this parameter.

      - is_write_index (bool | None) – If true, sets the write index or data stream for the alias. If an alias points to multiple indices or data streams and is_write_index isn’t set, the alias rejects write requests. If an index alias points to one index and is_write_index isn’t set, the index automatically acts as the write index. Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - routing (str | Sequence[str] | None) – Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter.

      - search_routing (str | Sequence[str] | None) – Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations. Data stream aliases don’t support this parameter.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  put_data_lifecycle(*, name, data_retention=None, downsampling=None, downsampling_method=None, enabled=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None, body=None)

    Update data stream lifecycles.

    Update the data stream lifecycle of the specified data streams.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle

    Parameters:

      - name (str | Sequence[str]) – Comma-separated list of data streams used to limit the request. Supports wildcards (*). To target all data streams use * or _all.

      - data_retention (str | Literal[-1] | ~typing.Literal[0] | None) – If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely.

      - downsampling (Sequence[Mapping[str, Any]] | None) – The downsampling configuration to execute for the managed backing index after rollover.

      - downsampling_method (str | Literal['aggregate', 'last_value'] | None) – The method used to downsample the data. There are two options aggregate and last_value. It requires downsampling to be defined. Defaults to aggregate.

      - enabled (bool | None) – If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that’s disabled (enabled: false) will have no effect on the data stream.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  put_data_stream_mappings(*, name, mappings=None, body=None, dry_run=None, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

    Update data stream mappings.

    This API can be used to override mappings on specific data streams. These overrides will take precedence over what is specified in the template that the data stream matches. The mapping change is only applied to new write indices that are created during rollover after this API is called. No indices are changed by this API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-mappings

    Parameters:

      - name (str | Sequence[str]) – A comma-separated list of data streams or data stream patterns.

      - mappings (Mapping[str, Any] | None)

      - dry_run (bool | None) – If true, the request does not actually change the mappings on any data streams. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - body (Mapping[str, Any] | None)

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  put_data_stream_options(*, name, error_trace=None, expand_wildcards=None, failure_store=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None, body=None)

    Update data stream options.

    Update the data stream options of the specified data streams.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-options

    Parameters:

      - name (str | Sequence[str]) – Comma-separated list of data streams used to limit the request. Supports wildcards (*). To target all data streams use * or _all.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

      - failure_store (Mapping[str, Any] | None) – If defined, it will update the failure store configuration of every data stream resolved by the name expression.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  put_data_stream_settings(*, name, settings=None, body=None, dry_run=None, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

    Update data stream settings.

    This API can be used to override settings on specific data streams. These overrides will take precedence over what is specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state, only certain settings are allowed. If possible, the setting change is applied to all backing indices. Otherwise, it will be applied when the data stream is next rolled over.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-settings

    Parameters:

      - name (str | Sequence[str]) – A comma-separated list of data streams or data stream patterns.

      - settings (Mapping[str, Any] | None)

      - dry_run (bool | None) – If true, the request does not actually change the settings on any data streams or indices. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - body (Mapping[str, Any] | None)

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  put_index_template(*, name, allow_auto_create=None, cause=None, composed_of=None, create=None, data_stream=None, deprecated=None, error_trace=None, filter_path=None, human=None, ignore_missing_component_templates=None, index_patterns=None, master_timeout=None, meta=None, pretty=None, priority=None, template=None, version=None, body=None)

    Create or update an index template.

    Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

    Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name. Index templates are applied during data stream or index creation. For data streams, these settings and mappings are applied when the stream's backing indices are created. Settings and mappings specified in a create index API request override any settings or mappings specified in an index template. Changes to index templates do not affect existing indices, including the existing backing indices of a data stream.

    You can use C-style `/* *\/` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket.

    Multiple matching templates

    If multiple index templates match the name of a new index or data stream, the template with the highest priority is used.

    Multiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.

    Composing aliases, mappings, and settings

    When multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates. Any mappings, settings, or aliases from the parent index template are merged in next. Finally, any configuration on the index request itself is merged. Mapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration. If a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one. This recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`. If an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end. If an entry already exists with the same key, then it is overwritten by the new definition.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template

    Parameters:

      - name (str) – Index or template name

      - allow_auto_create (bool | None) – This setting overrides the value of the action.auto_create_index cluster setting. If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.

      - cause (str | None) – User defined reason for creating or updating the index template

      - composed_of (Sequence[str] | None) – An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.

      - create (bool | None) – If true, this request cannot replace or update existing index templates.

      - data_stream (Mapping[str, Any] | None) – If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a data_stream object.

      - deprecated (bool | None) – Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.

      - ignore_missing_component_templates (Sequence[str] | None) – The configuration option ignore_missing_component_templates can be used when an index template references a component template that might not exist

      - index_patterns (str | Sequence[str] | None) – Array of wildcard (*) expressions used to match the names of data streams and indices during creation.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - meta (Mapping[str, Any] | None) – Optional user metadata about the index template. It may have any contents. It is not automatically generated or used by Elasticsearch. This user-defined object is stored in the cluster state, so keeping it short is preferable To unset the metadata, replace the template without specifying it.

      - priority (int | None) – Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.

      - template (Mapping[str, Any] | None) – Template to be applied. It may optionally include an aliases, mappings, or settings configuration.

      - version (int | None) – Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. External systems can use these version numbers to simplify template management. To unset a version, replace the template without specifying one.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  put_mapping(*, index, allow_no_indices=None, date_detection=None, dynamic=None, dynamic_date_formats=None, dynamic_templates=None, error_trace=None, expand_wildcards=None, field_names=None, filter_path=None, human=None, ignore_unavailable=None, master_timeout=None, meta=None, numeric_detection=None, pretty=None, properties=None, routing=None, runtime=None, source=None, timeout=None, write_index_only=None, body=None)

    Update field mappings.

    Add new fields to an existing data stream or index. You can use the update mapping API to:

    - Add a new field to an existing index
    - Update mappings for multiple indices in a single request
    - Add new properties to an object field
    - Enable multi-fields for an existing field
    - Update supported mapping parameters
    - Change a field's mapping using reindexing
    - Rename a field using a field alias

    Learn how to use the update mapping API with practical examples in the Update mapping API examples guide.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping

    Parameters:

      - index (str | Sequence[str]) – A comma-separated list of index names the mapping should be added to (supports wildcards). Use _all or omit to add the mapping on all indices.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - date_detection (bool | None) – Controls whether dynamic date detection is enabled.

      - dynamic (str | Literal['false', 'runtime', 'strict', 'true'] | None) – Controls whether new fields are added dynamically.

      - dynamic_date_formats (Sequence[str] | None) – If date detection is enabled then new string fields are checked against ‘dynamic_date_formats’ and if the value matches then a new date field is added instead of string.

      - dynamic_templates (Sequence[Mapping[str, Mapping[str, Any]]] | None) – Specify dynamic templates for the mapping.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - field_names (Mapping[str, Any] | None) – Control whether field names are enabled for the index.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - meta (Mapping[str, Any] | None) – A mapping type can have custom meta data associated with it. These are not used at all by Elasticsearch, but can be used to store application-specific metadata.

      - numeric_detection (bool | None) – Automatically map strings into numeric data types for all fields.

      - properties (Mapping[str, Mapping[str, Any]] | None) – Mapping for a field. For new fields, this mapping can include: - Field name - Field data type - Mapping parameters

      - routing (Mapping[str, Any] | None) – Enable making a routing value required on indexed documents.

      - runtime (Mapping[str, Mapping[str, Any]] | None) – Mapping of runtime fields for the index.

      - source (Mapping[str, Any] | None) – Control whether the _source field is enabled on the index.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - write_index_only (bool | None) – If true, the mappings are applied only to the current write index for the target.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  put_sample_configuration(*, index, rate=None, error_trace=None, filter_path=None, human=None, if_=None, master_timeout=None, max_samples=None, max_size=None, pretty=None, time_to_live=None, timeout=None, body=None)

    Create or update sampling configuration.

    Create or update the sampling configuration for the specified index.

    https://www.elastic.co/docs/api/doc/elasticsearch#TODO

    Parameters:

      - index (str) – The name of the index or data stream.

      - rate (str | Any | None) – The fraction of documents to sample. Must be greater than 0 and less than or equal to 1. Can be specified as a number or a string.

      - if – An optional condition script that sampled documents must satisfy.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - max_samples (int | None) – The maximum number of documents to sample. Must be greater than 0 and less than or equal to 10,000.

      - max_size (int | str | None) – The maximum total size of sampled documents. Must be greater than 0 and less than or equal to 5GB.

      - time_to_live (str | Literal[-1] | ~typing.Literal[0] | None) – The duration for which the sampled documents should be retained. Must be greater than 0 and less than or equal to 30 days.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - if_ (str | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  put_settings(*, settings=None, body=None, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, flat_settings=None, human=None, ignore_unavailable=None, master_timeout=None, preserve_existing=None, pretty=None, reopen=None, timeout=None)

    Update index settings.

    Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.

    To revert a setting to the default value, use a null value. The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation. To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.

    For performance optimization during bulk indexing, you can disable the refresh interval. Refer to disable refresh interval for an example. There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:

        {
          "number_of_replicas": 1
        }

    Or you can use an `index` setting object:

        {
          "index": {
            "number_of_replicas": 1
          }
        }

    Or you can use dot annotation:

        {
          "index.number_of_replicas": 1
        }

    Or you can embed any of the aforementioned options in a `settings` object. For example:

        {
          "settings": {
            "index": {
              "number_of_replicas": 1
            }
          }
        }

    NOTE: You can only define new analyzers on closed indices. To add an analyzer, you must close the index, define the analyzer, and reopen the index. You cannot close the write index of a data stream. To update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream. Then roll over the data stream to apply the new analyzer to the stream's write index and future backing indices. This affects searches and any new data added to the stream after the rollover. However, it does not affect the data stream's backing indices or their existing data. To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it. Refer to updating analyzers on existing indices for step-by-step examples.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings

    Parameters:

      - settings (Mapping[str, Any] | None)

      - index (str | Sequence[str] | None) – Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - flat_settings (bool | None) – If true, returns settings in flat format.

      - ignore_unavailable (bool | None) – If true, returns settings in flat format.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - preserve_existing (bool | None) – If true, existing index settings remain unchanged.

      - reopen (bool | None) – Whether to close and reopen the index to apply non-dynamic settings. If set to true the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - body (Mapping[str, Any] | None)

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  put_template(*, name, aliases=None, cause=None, create=None, error_trace=None, filter_path=None, human=None, index_patterns=None, mappings=None, master_timeout=None, order=None, pretty=None, settings=None, version=None, body=None)

    Create or update a legacy index template.

    Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name.

    IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

    Composable templates always take precedence over legacy templates. If no composable template matches a new index, matching legacy templates are applied according to their order.

    Index templates are only applied during index creation. Changes to index templates do not affect existing indices. Settings and mappings specified in create index API requests override any settings or mappings specified in an index template.

    You can use C-style `/* *\/` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket.

    Indices matching multiple templates

    Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index. The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them. NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template

    Parameters:

      - name (str) – The name of the template

      - aliases (Mapping[str, Mapping[str, Any]] | None) – Aliases for the index.

      - cause (str | None) – User defined reason for creating or updating the index template

      - create (bool | None) – If true, this request cannot replace or update existing index templates.

      - index_patterns (str | Sequence[str] | None) – Array of wildcard expressions used to match the names of indices during creation.

      - mappings (Mapping[str, Any] | None) – Mapping for fields in the index.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - order (int | None) – Order in which Elasticsearch applies this template if index matches multiple templates. Templates with lower ‘order’ values are merged first. Templates with higher ‘order’ values are merged later, overriding templates with lower values.

      - settings (Mapping[str, Any] | None) – Configuration options for the index.

      - version (int | None) – Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. To unset a version, replace the template without specifying one.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  recovery(*, index=None, active_only=None, allow_no_indices=None, detailed=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, pretty=None)

    Get index recovery information.

    Get information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream's backing indices.

    All recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.

    Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.

    Recovery automatically occurs during the following processes:

    - When creating an index for the first time.
    - When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.
    - Creation of new replica shard copies from the primary.
    - Relocation of a shard copy to a different node in the same cluster.
    - A snapshot restore operation.
    - A clone, shrink, or split operation.

    You can determine the cause of a shard recovery using the recovery or cat recovery APIs.

    The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery

    Parameters:

      - index (str | Sequence[str] | None) – Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      - active_only (bool | None) – If true, the response only includes ongoing shard recoveries.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - detailed (bool | None) – If true, the response includes detailed information about shard recoveries.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  refresh(*, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, pretty=None)

    Refresh an index.

    A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.

    By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds. You can change this default interval with the `index.refresh_interval` setting.

    In Elastic Cloud Serverless, the default refresh interval is 5 seconds across all indices.

    Refresh requests are synchronous and do not return a response until the refresh operation completes.

    Refreshes are resource-intensive. To ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.

    If your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's `refresh=wait_for` query parameter option. This option ensures the indexing operation waits for a periodic refresh before running the search.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh

    Parameters:

      - index (str | Sequence[str] | None) – Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  reload_search_analyzers(*, index, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, pretty=None, resource=None)

    Reload search analyzers.

    Reload an index's search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream's backing indices.

    IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.

    You can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer. To be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers.

    NOTE: This API does not perform a reload for each shard of an index. Instead, it performs a reload for each node containing index shards. As a result, the total shard count returned by the API can differ from the number of index shards. Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers

    Parameters:

      - index (str | Sequence[str]) – A comma-separated list of index names to reload analyzers for

      - allow_no_indices (bool | None) – Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Whether to expand wildcard expression to concrete indices that are open, closed or both.

      - ignore_unavailable (bool | None) – Whether specified concrete indices should be ignored when unavailable (missing or closed)

      - resource (str | None) – Changed resource to reload analyzers from if applicable

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  remove_block(*, index, block, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, master_timeout=None, pretty=None, timeout=None)

    Remove an index block.

    Remove an index block from an index. Index blocks limit the operations allowed on an index by blocking specific operation types.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-remove-block

    Parameters:

      - index (str | Sequence[str]) – A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are removing blocks from. To allow the removal of blocks from indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the elasticsearch.yml file or by using the cluster update settings API.

      - block (str | Literal['metadata', 'read', 'read_only', 'write']) – The block type to remove from the index.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to -1 to indicate that the request should never timeout.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  resolve_cluster(*, name=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_throttled=None, ignore_unavailable=None, pretty=None, timeout=None)

    Resolve the cluster.

    Resolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included. If no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster.

    This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.

    You use the same index expression with this endpoint as you would for cross-cluster search. Index and cluster exclusions are also supported with this endpoint.

    For each cluster in the index expression, information is returned about:

    - Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the `remote/info` endpoint.
    - Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`.
    - Whether there are any indices, aliases, or data streams on that cluster that match the index expression.
    - Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).
    - Cluster version information, including the Elasticsearch server version.

    For example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`. Each cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`.

    ## Note on backwards compatibility

    The ability to query without an index expression was added in version 8.18, so when querying remote clusters older than that, the local cluster will send the index expression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference to that index expression even though you didn't request it. If it causes a problem, you can instead include an index expression like `*:*` to bypass the issue.

    ## Advantages of using this endpoint before a cross-cluster search

    You may want to exclude a cluster or index from a search when:

    - A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail.
    - A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.
    - The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.)
    - A remote cluster is an older version that does not support the feature you want to use in your search.

    ## Test availability of remote clusters

    The `remote/info` endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not. The remote cluster may be available, while the local cluster is not currently connected to it.

    You can use the `_resolve/cluster` API to attempt to reconnect to remote clusters. For example with `GET _resolve/cluster` or `GET _resolve/cluster/*:*`. The `connected` field in the response will indicate whether it was successful. If a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster

    Parameters:

      - name (str | Sequence[str] | None) – A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax. Index and cluster exclusions (e.g., -cluster1:*) are also supported. If no index expression is specified, information about all remote clusters configured on the local cluster is returned without doing any index matching

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.

      - ignore_throttled (bool | None) – If true, concrete, expanded, or aliased indices are ignored when frozen. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The maximum time to wait for remote clusters to respond. If a remote cluster does not respond within this timeout period, the API response will show the cluster as not connected and include an error message that the request timed out. The default timeout is unset and the query can take as long as the networking layer is configured to wait for remote clusters that are not responding (typically 30 seconds).

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  resolve_index(*, name, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, mode=None, pretty=None, project_routing=None, body=None)

    Resolve indices.

    Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index

    Parameters:

      - name (str | Sequence[str]) – Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - mode (Sequence[str | Literal['logsdb', 'lookup', 'standard', 'time_series']] | str | ~typing.Literal['logsdb', 'lookup', 'standard', 'time_series'] | None) – Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter.

      - project_routing (str | None) – Specifies a subset of projects to target using project metadata tags in a subset of Lucene query syntax. Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded). Examples: _alias:my-project _alias:_origin _alias:pr Supported in serverless only.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  rollover(*, alias, new_index=None, aliases=None, conditions=None, dry_run=None, error_trace=None, filter_path=None, human=None, lazy=None, mappings=None, master_timeout=None, pretty=None, settings=None, timeout=None, wait_for_active_shards=None, body=None)

    Roll over to a new index.

    TIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context.

    The rollover API creates a new index for a data stream or index alias. The API behavior depends on the rollover target.

    Roll over a data stream

    If you roll over a data stream, the API creates a new write index for the stream. The stream's previous write index becomes a regular backing index. A rollover also increments the data stream's generation.

    Roll over an index alias with a write index

    TIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data. Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers.

    If an index alias points to multiple indices, one of the indices must be a write index. The rollover API creates a new write index for the alias with `is_write_index` set to `true`. The API also `sets is_write_index` to `false` for the previous write index.

    Roll over an index alias with one index

    If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.

    NOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.

    Increment index names for an alias

    When you roll over an index alias, you can specify a name for the new index. If you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number. For example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`. This number is always six characters and zero-padded, regardless of the previous index's name.

    If you use an index alias for time series data, you can use date math in the index name to track the rollover date. For example, you can create an alias that points to an index named `<my-index-{now/d}-000001>`. If you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`. If you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover

    Parameters:

      - alias (str) – Name of the data stream or index alias to roll over.

      - new_index (str | None) – Name of the index to create. Supports date math. Data streams do not support this parameter.

      - aliases (Mapping[str, Mapping[str, Any]] | None) – Aliases for the target index. Data streams do not support this parameter.

      - conditions (Mapping[str, Any] | None) – Conditions for the rollover. If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. If this parameter is not specified, Elasticsearch performs the rollover unconditionally. If conditions are specified, at least one of them must be a max_* condition. The index will rollover if any max_* condition is satisfied and all min_* conditions are satisfied.

      - dry_run (bool | None) – If true, checks whether the current index satisfies the specified conditions but does not perform a rollover.

      - lazy (bool | None) – If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.

      - mappings (Mapping[str, Any] | None) – Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping paramaters.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - settings (Mapping[str, Any] | None) – Configuration options for the index. Data streams do not support this parameter.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - wait_for_active_shards (int | str | Literal['all', 'index-setting'] | None) – The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  segments(*, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, pretty=None)

    Get index segments.

    Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream's backing indices.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-segments

    Parameters:

      - index (str | Sequence[str] | None) – Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  shard_stores(*, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, pretty=None, status=None)

    Get index shard stores.

    Get store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream's backing indices.

    The index shard stores API returns the following information:

    - The node on which each replica shard exists.
    - The allocation ID for each replica shard.
    - A unique ID for each replica shard.
    - Any errors encountered while opening the shard index or from an earlier failure.

    By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shard-stores

    Parameters:

      - index (str | Sequence[str] | None) – List of data streams, indices, and aliases used to limit the request.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.

      - ignore_unavailable (bool | None) – If true, missing or closed indices are not included in the response.

      - status (Sequence[str | Literal['all', 'green', 'red', 'yellow']] | str | ~typing.Literal['all', 'green', 'red', 'yellow'] | None) – List of shard health statuses used to limit the request.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  shrink(*, index, target, aliases=None, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, settings=None, timeout=None, wait_for_active_shards=None, body=None)

    Shrink an index.

    Shrink an index into a new index with fewer primary shards.

    Before you can shrink an index:

    - The index must be read-only.
    - A copy of every shard in the index must reside on the same node.
    - The index must have a green health status.

    To make shard allocation easier, we recommend you also remove the index's replica shards. You can later re-add replica shards as part of the shrink operation.

    The requested number of primary shards in the target index must be a factor of the number of shards in the source index. For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. If the number of shards in the index is a prime number it can only be shrunk into a single primary shard Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.

    The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk.

    A shrink operation:

    - Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.
    - Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.
    - Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.

    IMPORTANT: Indices can only be shrunk if they satisfy the following requirements:

    - The target index must not exist.
    - The source index must have more primary shards than the target index.
    - The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index.
    - The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard.
    - The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shrink

    Parameters:

      - index (str) – Name of the source index to shrink.

      - target (str) – Name of the target index to create.

      - aliases (Mapping[str, Mapping[str, Any]] | None) – The key is the alias name. Index alias names support date math.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - settings (Mapping[str, Any] | None) – Configuration options for the target index.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - wait_for_active_shards (int | str | Literal['all', 'index-setting'] | None) – The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  simulate_index_template(*, name, cause=None, create=None, error_trace=None, filter_path=None, human=None, include_defaults=None, index_template=None, body=None, master_timeout=None, pretty=None)

    Simulate an index.

    Get the index configuration that would be applied to the specified index from an existing index template.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template

    Parameters:

      - name (str) – Name of the index to simulate

      - cause (str | None) – User defined reason for dry-run creating the new template for simulation purposes

      - create (bool | None) – Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one

      - include_defaults (bool | None) – If true, returns all relevant default configurations for the index template.

      - index_template (Mapping[str, Any] | None)

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - body (Mapping[str, Any] | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  simulate_template(*, name=None, allow_auto_create=None, cause=None, composed_of=None, create=None, data_stream=None, deprecated=None, error_trace=None, filter_path=None, human=None, ignore_missing_component_templates=None, include_defaults=None, index_patterns=None, master_timeout=None, meta=None, pretty=None, priority=None, template=None, version=None, body=None)

    Simulate an index template.

    Get the index configuration that would be applied by a particular index template.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-template

    Parameters:

      - name (str | None) – Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.

      - allow_auto_create (bool | None) – This setting overrides the value of the action.auto_create_index cluster setting. If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.

      - cause (str | None) – User defined reason for dry-run creating the new template for simulation purposes

      - composed_of (Sequence[str] | None) – An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.

      - create (bool | None) – If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.

      - data_stream (Mapping[str, Any] | None) – If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a data_stream object.

      - deprecated (bool | None) – Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.

      - ignore_missing_component_templates (Sequence[str] | None) – The configuration option ignore_missing_component_templates can be used when an index template references a component template that might not exist

      - include_defaults (bool | None) – If true, returns all relevant default configurations for the index template.

      - index_patterns (str | Sequence[str] | None) – Array of wildcard (*) expressions used to match the names of data streams and indices during creation.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - meta (Mapping[str, Any] | None) – Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.

      - priority (int | None) – Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.

      - template (Mapping[str, Any] | None) – Template to be applied. It may optionally include an aliases, mappings, or settings configuration.

      - version (int | None) – Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  split(*, index, target, aliases=None, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, settings=None, timeout=None, wait_for_active_shards=None, body=None)

    Split an index.

    Split an index into a new index with more primary shards.

    - Before you can split an index:

    - The index must be read-only.

    - The cluster health status must be green.

    You can do make an index read-only with the following request using the add index block API:

        PUT /my_source_index/_block/write

    The current write index on a data stream cannot be split. In order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split.

    The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting. The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. For instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.

    A split operation:

    - Creates a new target index with the same definition as the source index, but with a larger number of primary shards.
    - Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.
    - Hashes all documents again, after low level files are created, to delete documents that belong to a different shard.
    - Recovers the target index as though it were a closed index which had just been re-opened.

    IMPORTANT: Indices can only be split if they satisfy the following requirements:

    - The target index must not exist.
    - The source index must have fewer primary shards than the target index.
    - The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.
    - The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-split

    Parameters:

      - index (str) – Name of the source index to split.

      - target (str) – Name of the target index to create.

      - aliases (Mapping[str, Mapping[str, Any]] | None) – Aliases for the resulting index.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - settings (Mapping[str, Any] | None) – Configuration options for the target index.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - wait_for_active_shards (int | str | Literal['all', 'index-setting'] | None) – The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  stats(*, index=None, metric=None, completion_fields=None, error_trace=None, expand_wildcards=None, fielddata_fields=None, fields=None, filter_path=None, forbid_closed_indices=None, groups=None, human=None, include_segment_file_sizes=None, include_unloaded_segments=None, level=None, pretty=None)

    Get index statistics.

    For data streams, the API retrieves statistics for the stream's backing indices.

    By default, the returned statistics are index-level with `primaries` and `total` aggregations. `primaries` are the values for only the primary shards. `total` are the accumulated values for both primary and replica shards.

    To get shard-level statistics, set the `level` parameter to `shards`.

    NOTE: When moving to another node, the shard-level statistics for a shard are cleared. Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-stats

    Parameters:

      - index (str | Sequence[str] | None) – A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      - metric (Sequence[str | Literal['_all', 'bulk', 'completion', 'dense_vector', 'docs', 'fielddata', 'flush', 'get', 'indexing', 'mappings', 'merge', 'query_cache', 'recovery', 'refresh', 'request_cache', 'search', 'segments', 'shard_stats', 'sparse_vector', 'store', 'translog', 'warmer']] | str | ~typing.Literal['_all', 'bulk', 'completion', 'dense_vector', 'docs', 'fielddata', 'flush', 'get', 'indexing', 'mappings', 'merge', 'query_cache', 'recovery', 'refresh', 'request_cache', 'search', 'segments', 'shard_stats', 'sparse_vector', 'store', 'translog', 'warmer'] | None) – Limit the information returned the specific metrics

      - completion_fields (str | Sequence[str] | None) – Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - fielddata_fields (str | Sequence[str] | None) – Comma-separated list or wildcard expressions of fields to include in fielddata statistics.

      - fields (str | Sequence[str] | None) – Comma-separated list or wildcard expressions of fields to include in the statistics.

      - forbid_closed_indices (bool | None) – If true, statistics are not collected from closed indices.

      - groups (str | Sequence[str] | None) – Comma-separated list of search groups to include in the search statistics.

      - include_segment_file_sizes (bool | None) – If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).

      - include_unloaded_segments (bool | None) – If true, the response includes information from segments that are not loaded into memory.

      - level (str | Literal['cluster', 'indices', 'shards'] | None) – Indicates whether statistics are aggregated at the cluster, indices, or shards level.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  update_aliases(*, actions=None, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None, body=None)

    Create or update an alias.

    Adds a data stream or index to an alias.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases

    Parameters:

      - actions (Sequence[Mapping[str, Any]] | None) – Actions to perform.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  validate_query(*, index=None, all_shards=None, allow_no_indices=None, analyze_wildcard=None, analyzer=None, default_operator=None, df=None, error_trace=None, expand_wildcards=None, explain=None, filter_path=None, human=None, ignore_unavailable=None, lenient=None, pretty=None, q=None, query=None, rewrite=None, body=None)

    Validate a query.

    Validates a query without running it.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-validate-query

    Parameters:

      - index (str | Sequence[str] | None) – Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). To search all data streams or indices, omit this parameter or use * or _all.

      - all_shards (bool | None) – If true, the validation is executed on all shards instead of one random shard per index.

      - allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      - analyze_wildcard (bool | None) – If true, wildcard and prefix queries are analyzed.

      - analyzer (str | None) – Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified.

      - default_operator (str | Literal['and', 'or'] | None) – The default operator for query string query: and or or.

      - df (str | None) – Field to use as default where no field prefix is given in the query string. This parameter can only be used when the q query string parameter is specified.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      - explain (bool | None) – If true, the response returns detailed information if an error has occurred.

      - ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.

      - lenient (bool | None) – If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.

      - q (str | None) – Query in the Lucene query string syntax.

      - query (Mapping[str, Any] | None) – Query in the Lucene query string syntax.

      - rewrite (bool | None) – If true, returns a more detailed explanation showing the actual Lucene query that will be executed.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]