Indices
- class elasticsearch.client.IndicesClient(client)
- Parameters:
client (BaseClient)
- 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. Limits the operations allowed on an index by blocking specific operation types.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index-modules-blocks.html
- Parameters:
index (str) – A comma separated list of indices to add a block to
block (str | Literal['metadata', 'read', 'read_only', 'write']) – The block to add (one of read, write, read_only or metadata)
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)
master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Specify timeout for connection to master
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Explicit operation timeout
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- 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](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-analyze.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-clearcache.html
- 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. Valid values are: all, open, closed, hidden, none.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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 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.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-clone-index.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/indices-close.html
- 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. Valid values are: all, open, closed, hidden, none.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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. Creates a new index.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-create-index.html
- Parameters:
index (str) – Name of the index you wish to create.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- create_data_stream(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)
Create a data stream. Creates a data stream. You must have a matching index template with data stream enabled.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- data_streams_stats(*, name=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, pretty=None)
Get data stream stats. Retrieves statistics for one or more data streams.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html
- Parameters:
name (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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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. Deletes one or more indices.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-index.html
- 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. Valid values are: all, open, closed, hidden, none.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/indices-aliases.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/data-streams-delete-lifecycle.html
- 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) – Specify timeout for connection to master
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Explicit timestamp for the document
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/data-streams.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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 <index-template> 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/guide/en/elasticsearch/reference/8.17/indices-delete-template.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- delete_template(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)
Deletes a legacy index template.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-template-v1.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-disk-usage.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- downsample(*, index, target_index, config=None, body=None, error_trace=None, filter_path=None, human=None, pretty=None)
Downsample an index. Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. 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/guide/en/elasticsearch/reference/8.17/indices-downsample-data-stream.html
- Parameters:
- Return type:
- 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. Checks if one or more indices, index aliases, or data streams exist.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-exists.html
- 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. Valid values are: all, open, closed, hidden, none.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- exists_alias(*, name, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, local=None, pretty=None)
Check aliases. Checks if one or more data stream or index aliases exist.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-aliases.html
- 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. Valid values are: all, open, closed, hidden, none.
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.
local (bool | None) – If true, the request retrieves information from the local node only.
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- exists_index_template(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None)
Check index templates. Check whether index templates exist.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index-templates.html
- Parameters:
name (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.
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- 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. Returns information about whether a particular index template exists.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-template-exists-v1.html
- Parameters:
name (str | Sequence[str]) – The comma separated names of the index templates
flat_settings (bool | None) – Return settings in flat format (default: false)
local (bool | None) – Return local information, do not retrieve the state from master node (default: false)
master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Explicit operation timeout for connection to master node
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/data-streams-explain-lifecycle.html
- Parameters:
index (str | Sequence[str]) – The name of the index 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) – Specify timeout for connection to master
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- field_usage_stats(*, index, allow_no_indices=None, error_trace=None, expand_wildcards=None, fields=None, filter_path=None, human=None, ignore_unavailable=None, master_timeout=None, pretty=None, timeout=None, wait_for_active_shards=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.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/field-usage-stats.html
- 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.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/indices-flush.html
- 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. Valid values are: all, open, closed, hidden, none.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-forcemerge.html
- 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 (default: true)
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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. Returns information about one or more indices. For data streams, the API returns information about the stream’s backing indices.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-index.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- get_alias(*, index=None, name=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, local=None, pretty=None)
Get aliases. Retrieves information for one or more data stream or index aliases.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-aliases.html
- 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. Valid values are: all, open, closed, hidden, none.
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.
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- 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. Retrieves the data stream lifecycle configuration of one or more data streams.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams-get-lifecycle.html
- 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. Valid values are: all, open, closed, hidden, none.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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. Retrieves information about one or more data streams.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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, local=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.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-field-mapping.html
- Parameters:
fields (str | Sequence[str]) – Comma-separated list or wildcard expression of fields used to limit returned information.
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. Valid values are: all, open, closed, hidden, none.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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. Returns information about one or more index templates.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-template.html
- Parameters:
name (str | None) – 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.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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. Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-mapping.html
- 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. Valid values are: all, open, closed, hidden, none.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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. Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-settings.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- get_template(*, name=None, error_trace=None, filter_path=None, flat_settings=None, human=None, local=None, master_timeout=None, pretty=None)
Get index templates. Retrieves information about one or more index templates.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-template-v1.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/data-streams.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/data-streams.html
- 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)
Opens a closed index. For data streams, the API opens any closed backing indices.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-open-close.html
- 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. Valid values are: all, open, closed, hidden, none.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/data-streams.html
- Parameters:
name (str) – The name of the 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.
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/indices-aliases.html
- 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 | 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 | None) – Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter.
search_routing (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)
human (bool | None)
pretty (bool | None)
- Return type:
- put_data_lifecycle(*, name, data_retention=None, downsampling=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/guide/en/elasticsearch/reference/8.17/data-streams-put-lifecycle.html
- 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 (Mapping[str, Any] | None) – If defined, every backing index will execute the configured downsampling configuration after the backing index is not the data stream write index anymore.
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. Valid values are: all, hidden, open, closed, 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.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-put-template.html
- 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/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) – Name of the index template to create.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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. Adds new fields to an existing data stream or index. You can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-put-mapping.html
- 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 (Mapping[str, Mapping[str, Any]] | 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. Valid values are: all, open, closed, hidden, none.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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, 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.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-update-settings.html
- 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. 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.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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 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 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.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-templates-v1.html
- Parameters:
name (str) – The name of the template
aliases (Mapping[str, Mapping[str, Any]] | None) – Aliases for the index.
cause (str | None)
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.
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- recovery(*, index=None, active_only=None, detailed=None, error_trace=None, filter_path=None, human=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. 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/guide/en/elasticsearch/reference/8.17/indices-recovery.html
- 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.
detailed (bool | None) – If true, the response includes detailed information about shard recoveries.
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- 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.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-refresh.html
- 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. Valid values are: all, open, closed, hidden, none.
ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- reload_search_analyzers(*, index, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, pretty=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/guide/en/elasticsearch/reference/8.17/indices-reload-analyzers.html
- 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)
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- resolve_cluster(*, name, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_throttled=None, ignore_unavailable=None, pretty=None)
Resolve the cluster. Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. Multiple patterns and remote clusters are supported. 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 in the index expression scope. * 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.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-resolve-cluster-api.html
- 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. Valid values are: all, open, closed, hidden, none.
ignore_throttled (bool | None) – If true, concrete, expanded or aliased indices are ignored when frozen. Defaults to false.
ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index. Defaults to false.
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- resolve_index(*, name, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, pretty=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/guide/en/elasticsearch/reference/8.17/indices-resolve-index-api.html
- 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. Valid values are: all, open, closed, hidden, none.
ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- rollover(*, alias, new_index=None, aliases=None, conditions=None, dry_run=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)
Roll over to a new index. Creates a new index for a data stream or index alias.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-rollover-index.html
- 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.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- segments(*, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_unavailable=None, pretty=None, verbose=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/guide/en/elasticsearch/reference/8.17/indices-segments.html
- 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. Valid values are: all, open, closed, hidden, none.
ignore_unavailable (bool | None) – If false, the request returns an error if it targets a missing or closed index.
verbose (bool | None) – If true, the request returns a verbose response.
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/indices-shards-stores.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/indices-shrink-index.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- simulate_index_template(*, name, error_trace=None, filter_path=None, human=None, include_defaults=None, master_timeout=None, pretty=None)
Simulate an index. Returns the index configuration that would be applied to the specified index from an existing index template.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-simulate-index.html
- Parameters:
name (str) – Name of the index to simulate
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.
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- simulate_template(*, name=None, allow_auto_create=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. Returns the index configuration that would be applied by a particular index template.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-simulate-template.html
- 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.
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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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. 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/guide/en/elasticsearch/reference/8.17/indices-split-index.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/indices-stats.html
- 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 (str | Sequence[str] | 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, index, or shard level.
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- unfreeze(*, 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)
Unfreeze an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/unfreeze-index-api.html
- Parameters:
index (str) – Identifier for 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.
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. Valid values are: all, open, closed, hidden, none.
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 (str | 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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/indices-aliases.html
- 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)
human (bool | None)
pretty (bool | None)
- Return type:
- 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/guide/en/elasticsearch/reference/8.17/search-validate.html
- 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. Valid values are: all, open, closed, hidden, none.
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)
human (bool | None)
pretty (bool | None)
- Return type: