elasticsearch 8.16.0__py3-none-any.whl → 8.17.1__py3-none-any.whl

elasticsearch/_async/client/indices.py

@@ -58,7 +58,7 @@ class IndicesClient(NamespacedClient):
         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.16/index-modules-blocks.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index-modules-blocks.html>`_
 
         :param index: A comma separated list of indices to add a block to
         :param block: The block to add (one of read, write, read_only or metadata)
@@ -143,10 +143,14 @@ class IndicesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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.
+        Get tokens from text analysis. The analyze API performs analysis on a text string
+        and returns the resulting tokens. Generating excessive amount of tokens may cause
+        a node to run out of memory. The `index.analyze.max_token_count` setting enables
+        you to limit the number of tokens that can be produced. If more than this limit
+        of tokens gets generated, an error occurs. The `_analyze` endpoint without a
+        specified index will always use `10000` as its limit.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-analyze.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-analyze.html>`_
 
         :param index: Index used to derive the analyzer. If specified, the `analyzer`
             or field parameter overrides this value. If no index is specified or the
@@ -245,10 +249,13 @@ class IndicesClient(NamespacedClient):
         request: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Clears the caches of one or more indices. For data streams, the API clears the
-        caches of the stream’s backing indices.
+        Clear the cache. Clear the cache of one or more indices. For data streams, the
+        API clears the caches of the stream's backing indices. By default, the clear
+        cache API clears all caches. To clear only specific caches, use the `fielddata`,
+        `query`, or `request` parameters. To clear the cache only of specific fields,
+        use the `fields` parameter.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-clearcache.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-clearcache.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
@@ -331,9 +338,46 @@ class IndicesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Clones an existing index.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-clone-index.html>`_
+        Clone an index. Clone an existing index into a new index. Each original primary
+        shard is cloned into a new primary shard in the new index. IMPORTANT: Elasticsearch
+        does not apply index templates to the resulting index. The API also does not
+        copy index metadata from the original index. Index metadata includes aliases,
+        index lifecycle management phase definitions, and cross-cluster replication (CCR)
+        follower information. For example, if you clone a CCR follower index, the resulting
+        clone will not be a follower index. The clone API copies most index settings
+        from the source index to the resulting index, with the exception of `index.number_of_replicas`
+        and `index.auto_expand_replicas`. To set the number of replicas in the resulting
+        index, configure these settings in the clone request. Cloning works as follows:
+        * First, it creates a new target index with the same definition as the source
+        index. * Then it hard-links segments from the source index into the target index.
+        If the file system does not support hard-linking, all segments are copied into
+        the new index, which is a much more time consuming process. * Finally, it recovers
+        the target index as though it were a closed index which had just been re-opened.
+        IMPORTANT: Indices can only be cloned if they meet the following requirements:
+        * The index must be marked as read-only and have a cluster health status of green.
+        * The target index must not exist. * The source index must have the same number
+        of primary shards as the target index. * The node handling the clone process
+        must have sufficient free disk space to accommodate a second copy of the existing
+        index. The current write index on a data stream cannot be cloned. In order to
+        clone the current write index, the data stream must first be rolled over so that
+        a new write index is created and then the previous write index can be cloned.
+        NOTE: Mappings cannot be specified in the `_clone` request. The mappings of the
+        source index will be used for the target index. **Monitor the cloning process**
+        The cloning process can be monitored with the cat recovery API or the cluster
+        health API can be used to wait until all primary shards have been allocated by
+        setting the `wait_for_status` parameter to `yellow`. The `_clone` API returns
+        as soon as the target index has been added to the cluster state, before any shards
+        have been allocated. At this point, all shards are in the state unassigned. If,
+        for any reason, the target index can't be allocated, its primary shard will remain
+        unassigned until it can be allocated on that node. Once the primary shard is
+        allocated, it moves to state initializing, and the clone process begins. When
+        the clone operation completes, the shard will become active. At that point, Elasticsearch
+        will try to allocate any replicas and may decide to relocate the primary shard
+        to another node. **Wait for active shards** Because the clone operation creates
+        a new index to clone the shards to, the wait for active shards setting on index
+        creation applies to the clone index action as well.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-clone-index.html>`_
 
         :param index: Name of the source index to clone.
         :param target: Name of the target index to create.
@@ -419,9 +463,26 @@ class IndicesClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Closes an index.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-close.html>`_
+        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>`_
 
         :param index: Comma-separated list or wildcard expression of index names used
             to limit the request.
@@ -500,9 +561,28 @@ class IndicesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create an index. Creates a new index.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-create-index.html>`_
+        Create an index. You can use the create index API to add a new index to an Elasticsearch
+        cluster. When creating an index, you can specify the following: * Settings for
+        the index. * Mappings for fields in the index. * Index aliases **Wait for active
+        shards** By default, index creation will only return a response to the client
+        when the primary copies of each shard have been started, or the request times
+        out. The index creation response will indicate what happened. For example, `acknowledged`
+        indicates whether the index was successfully created in the cluster, `while shards_acknowledged`
+        indicates whether the requisite number of shard copies were started for each
+        shard in the index before timing out. Note that it is still possible for either
+        `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation
+        to be successful. These values simply indicate whether the operation completed
+        before the timeout. If `acknowledged` is false, the request timed out before
+        the cluster state was updated with the newly created index, but it probably will
+        be created sometime soon. If `shards_acknowledged` is false, then the request
+        timed out before the requisite number of shards were started (by default just
+        the primaries), even if the cluster state was successfully updated to reflect
+        the newly created index (that is to say, `acknowledged` is `true`). You can change
+        the default of only waiting for the primary shards to start through the index
+        setting `index.write.wait_for_active_shards`. Note that changing this setting
+        will also affect the `wait_for_active_shards` value on all subsequent write operations.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-create-index.html>`_
 
         :param index: Name of the index you wish to create.
         :param aliases: Aliases for the index.
@@ -576,7 +656,7 @@ class IndicesClient(NamespacedClient):
         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.16/data-streams.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
 
         :param name: Name of the data stream, which must meet the following criteria:
             Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`,
@@ -637,7 +717,7 @@ class IndicesClient(NamespacedClient):
         """
         Get data stream stats. Retrieves statistics for one or more data streams.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
 
         :param name: Comma-separated list of data streams used to limit the request.
             Wildcard expressions (`*`) are supported. To target all data streams in a
@@ -696,9 +776,13 @@ class IndicesClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete indices. Deletes one or more indices.
+        Delete indices. Deleting an index deletes its documents, shards, and metadata.
+        It does not delete related Kibana components, such as data views, visualizations,
+        or dashboards. You cannot delete the current write index of a data stream. To
+        delete the index, you must roll over the data stream so a new write index is
+        created. You can then use the delete index API to delete the previous write index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-delete-index.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-index.html>`_
 
         :param index: Comma-separated list of indices to delete. You cannot specify index
             aliases. By default, this parameter does not support wildcards (`*`) or `_all`.
@@ -768,7 +852,7 @@ class IndicesClient(NamespacedClient):
         """
         Delete an alias. Removes a data stream or index from an alias.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-aliases.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-alias.html>`_
 
         :param index: Comma-separated list of data streams or indices used to limit the
             request. Supports wildcards (`*`).
@@ -833,7 +917,7 @@ class IndicesClient(NamespacedClient):
         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.16/data-streams-delete-lifecycle.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams-delete-lifecycle.html>`_
 
         :param name: A comma-separated list of data streams of which the data stream
             lifecycle will be deleted; use `*` to get all data streams
@@ -893,7 +977,7 @@ class IndicesClient(NamespacedClient):
         """
         Delete data streams. Deletes one or more data streams and their backing indices.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
 
         :param name: Comma-separated list of data streams to delete. Wildcard (`*`) expressions
             are supported.
@@ -948,7 +1032,7 @@ class IndicesClient(NamespacedClient):
         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.16/indices-delete-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-template.html>`_
 
         :param name: Comma-separated list of index template names used to limit the request.
             Wildcard (*) expressions are supported.
@@ -998,9 +1082,9 @@ class IndicesClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes a legacy index template.
+        Delete a legacy index template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-delete-template-v1.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-template-v1.html>`_
 
         :param name: The name of the legacy index template to delete. Wildcard (`*`)
             expressions are supported.
@@ -1061,9 +1145,18 @@ class IndicesClient(NamespacedClient):
         run_expensive_tasks: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Analyzes the disk usage of each field of an index or data stream.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-disk-usage.html>`_
+        Analyze the index disk usage. Analyze the disk usage of each field of an index
+        or data stream. This API might not support indices created in previous Elasticsearch
+        versions. The result of a small index can be inaccurate as some parts of an index
+        might not be analyzed by the API. NOTE: The total size of fields of the analyzed
+        shards of the index in the response is usually smaller than the index `store_size`
+        value because some small metadata files are ignored and some parts of data files
+        might not be scanned by the API. Since stored fields are stored together in a
+        compressed format, the sizes of stored fields are also estimates and can be inaccurate.
+        The stored size of the `_id` field is likely underestimated while the `_source`
+        field is overestimated.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-disk-usage.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases used
             to limit the request. It’s recommended to execute this API with a single
@@ -1135,11 +1228,16 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Aggregates a time series (TSDS) index and stores pre-computed statistical summaries
-        (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped
-        by a configured time interval.
+        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.16/indices-downsample-data-stream.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-downsample-data-stream.html>`_
 
         :param index: Name of the time series index to downsample.
         :param target_index: Name of the index to create.
@@ -1205,10 +1303,9 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> HeadApiResponse:
         """
-        Check indices. Checks if one or more indices, index aliases, or data streams
-        exist.
+        Check indices. Check if one or more indices, index aliases, or data streams exist.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-exists.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-exists.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases. Supports
             wildcards (`*`).
@@ -1286,7 +1383,7 @@ class IndicesClient(NamespacedClient):
         """
         Check aliases. Checks if one or more data stream or index aliases exist.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-aliases.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-aliases.html>`_
 
         :param name: Comma-separated list of aliases to check. Supports wildcards (`*`).
         :param index: Comma-separated list of data streams or indices used to limit the
@@ -1354,9 +1451,9 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> HeadApiResponse:
         """
-        Returns information about whether a particular index template exists.
+        Check index templates. Check whether index templates exist.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index-templates.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index-templates.html>`_
 
         :param name: Comma-separated list of index template names used to limit the request.
             Wildcard (*) expressions are supported.
@@ -1403,16 +1500,21 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> HeadApiResponse:
         """
-        Check existence of index templates. Returns information about whether a particular
-        index template exists.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-template-exists-v1.html>`_
-
-        :param name: The comma separated names of the index templates
-        :param flat_settings: Return settings in flat format (default: false)
-        :param local: Return local information, do not retrieve the state from master
-            node (default: false)
-        :param master_timeout: Explicit operation timeout for connection to master node
+        Check existence of index templates. Get information about whether index templates
+        exist. Index templates define settings, mappings, and aliases that can be applied
+        automatically to new indices. IMPORTANT: This documentation is about legacy index
+        templates, which are deprecated and will be replaced by the composable templates
+        introduced in Elasticsearch 7.8.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-template-exists-v1.html>`_
+
+        :param name: A comma-separated list of index template names used to limit the
+            request. Wildcard (`*`) expressions are supported.
+        :param flat_settings: Indicates whether to use a flat format for the response.
+        :param local: Indicates whether to get information from the local node only.
+        :param master_timeout: The period to wait for the master node. If the master
+            node is not available before the timeout expires, the request fails and returns
+            an error. To indicate that the request should never timeout, set it to `-1`.
         """
         if name in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'name'")
@@ -1456,12 +1558,12 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get the status for a data stream lifecycle. Retrieves information about an index
-        or data stream’s current data stream lifecycle status, such as time since index
+        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.16/data-streams-explain-lifecycle.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams-explain-lifecycle.html>`_
 
         :param index: The name of the index to explain
         :param include_defaults: indicates if the API should return the default values
@@ -1523,9 +1625,15 @@ class IndicesClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns field usage information for each shard and field of an index.
+        Get field usage stats. Get field usage information for each shard and field of
+        an index. Field usage statistics are automatically captured when queries are
+        running on a cluster. A shard-level search request that accesses a given field,
+        even if multiple times during that request, is counted as a single use. The response
+        body reports the per-shard usage count of the data structures that back the fields
+        in the index. A given request will increment each count by a maximum value of
+        1, even if the request accesses the same field multiple times.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/field-usage-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/field-usage-stats.html>`_
 
         :param index: Comma-separated list or wildcard expression of index names used
             to limit the request.
@@ -1611,9 +1719,24 @@ class IndicesClient(NamespacedClient):
         wait_if_ongoing: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Flushes one or more data streams or indices.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-flush.html>`_
+        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>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases to flush.
             Supports wildcards (`*`). To flush all data streams and indices, omit this
@@ -1694,9 +1817,51 @@ class IndicesClient(NamespacedClient):
         wait_for_completion: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Performs the force merge operation on one or more indices.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-forcemerge.html>`_
+        Force a merge. Perform the force merge operation on the shards of one or more
+        indices. For data streams, the API forces a merge on the shards of the stream's
+        backing indices. Merging reduces the number of segments in each shard by merging
+        some of them together and also frees up the space used by deleted documents.
+        Merging normally happens automatically, but sometimes it is useful to trigger
+        a merge manually. WARNING: We recommend force merging only a read-only index
+        (meaning the index is no longer receiving writes). When documents are updated
+        or deleted, the old version is not immediately removed but instead soft-deleted
+        and marked with a "tombstone". These soft-deleted documents are automatically
+        cleaned up during regular segment merges. But force merge can cause very large
+        (greater than 5 GB) segments to be produced, which are not eligible for regular
+        merges. So the number of soft-deleted documents can then grow rapidly, resulting
+        in higher disk usage and worse search performance. If you regularly force merge
+        an index receiving writes, this can also make snapshots more expensive, since
+        the new documents can't be backed up incrementally. **Blocks during a force merge**
+        Calls to this API block until the merge is complete (unless request contains
+        `wait_for_completion=false`). If the client connection is lost before completion
+        then the force merge process will continue in the background. Any new requests
+        to force merge the same indices will also block until the ongoing force merge
+        is complete. **Running force merge asynchronously** If the request contains `wait_for_completion=false`,
+        Elasticsearch performs some preflight checks, launches the request, and returns
+        a task you can use to get the status of the task. However, you can not cancel
+        this task as the force merge task is not cancelable. Elasticsearch creates a
+        record of this task as a document at `_tasks/<task_id>`. When you are done with
+        a task, you should delete the task document so Elasticsearch can reclaim the
+        space. **Force merging multiple indices** You can force merge multiple indices
+        with a single request by targeting: * One or more data streams that contain multiple
+        backing indices * Multiple indices * One or more aliases * All data streams and
+        indices in a cluster Each targeted shard is force-merged separately using the
+        force_merge threadpool. By default each node only has a single `force_merge`
+        thread which means that the shards on that node are force-merged one at a time.
+        If you expand the `force_merge` threadpool on a node then it will force merge
+        its shards in parallel Force merge makes the storage for the shard being merged
+        temporarily increase, as it may require free space up to triple its size in case
+        `max_num_segments parameter` is set to `1`, to rewrite all segments into a new
+        one. **Data streams and time-based indices** Force-merging is useful for managing
+        a data stream's older backing indices and other time-based indices, particularly
+        after a rollover. In these cases, each index only receives indexing traffic for
+        a certain period of time. Once an index receive no more writes, its shards can
+        be force-merged to a single segment. This can be a good idea because single-segment
+        shards can sometimes use simpler and more efficient data structures to perform
+        searches. For example: ``` POST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1
+        ```
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-forcemerge.html>`_
 
         :param index: A comma-separated list of index names; use `_all` or empty string
             to perform the operation on all indices
@@ -1787,10 +1952,10 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get index information. Returns information about one or more indices. For data
-        streams, the API returns information about the stream’s backing indices.
+        Get index information. Get information about one or more indices. For data streams,
+        the API returns information about the stream’s backing indices.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-get-index.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-index.html>`_
 
         :param index: Comma-separated list of data streams, indices, and index aliases
             used to limit the request. Wildcard expressions (*) are supported.
@@ -1879,7 +2044,7 @@ class IndicesClient(NamespacedClient):
         """
         Get aliases. Retrieves information for one or more data stream or index aliases.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-aliases.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-alias.html>`_
 
         :param index: Comma-separated list of data streams or indices used to limit the
             request. Supports wildcards (`*`). To target all data streams and indices,
@@ -1962,7 +2127,7 @@ class IndicesClient(NamespacedClient):
         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.16/data-streams-get-lifecycle.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams-get-lifecycle.html>`_
 
         :param name: Comma-separated list of data streams to limit the request. Supports
             wildcards (`*`). To target all data streams, omit this parameter or use `*`
@@ -2004,6 +2169,42 @@ class IndicesClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters()
+    async def get_data_lifecycle_stats(
+        self,
+        *,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        pretty: t.Optional[bool] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        Get data stream lifecycle stats. Get statistics about the data streams that are
+        managed by a data stream lifecycle.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams-get-lifecycle-stats.html>`_
+        """
+        __path_parts: t.Dict[str, str] = {}
+        __path = "/_lifecycle/stats"
+        __query: t.Dict[str, t.Any] = {}
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        if filter_path is not None:
+            __query["filter_path"] = filter_path
+        if human is not None:
+            __query["human"] = human
+        if pretty is not None:
+            __query["pretty"] = pretty
+        __headers = {"accept": "application/json"}
+        return await self.perform_request(  # type: ignore[return-value]
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="indices.get_data_lifecycle_stats",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters()
     async def get_data_stream(
         self,
@@ -2028,7 +2229,7 @@ class IndicesClient(NamespacedClient):
         """
         Get data streams. Retrieves information about one or more data streams.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
 
         :param name: Comma-separated list of data stream names used to limit the request.
             Wildcard (`*`) expressions are supported. If omitted, all data streams are
@@ -2103,11 +2304,13 @@ class IndicesClient(NamespacedClient):
         """
         Get mapping definitions. Retrieves mapping definitions for one or more fields.
         For data streams, the API retrieves field mappings for the stream’s backing indices.
+        This API is useful if you don't need a complete mapping or if an index mapping
+        contains a large number of fields.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-get-field-mapping.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-field-mapping.html>`_
 
         :param fields: Comma-separated list or wildcard expression of fields used to
-            limit returned information.
+            limit returned information. Supports wildcards (`*`).
         :param index: 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`.
@@ -2179,9 +2382,9 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get index templates. Returns information about one or more index templates.
+        Get index templates. Get information about one or more index templates.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-get-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-template.html>`_
 
         :param name: Comma-separated list of index template names used to limit the request.
             Wildcard (*) expressions are supported.
@@ -2252,10 +2455,10 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get mapping definitions. Retrieves mapping definitions for one or more indices.
-        For data streams, the API retrieves mappings for the stream’s backing indices.
+        Get mapping definitions. For data streams, the API retrieves mappings for the
+        stream’s backing indices.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-get-mapping.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-mapping.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2337,10 +2540,10 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get index settings. Returns setting information for one or more indices. For
-        data streams, returns setting information for the stream’s backing indices.
+        Get index settings. Get setting information for one or more indices. For data
+        streams, it returns setting information for the stream's backing indices.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-get-settings.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-settings.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2425,9 +2628,11 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get index templates. Retrieves information about one or more index templates.
+        Get index templates. Get information about one or more index templates. IMPORTANT:
+        This documentation is about legacy index templates, which are deprecated and
+        will be replaced by the composable templates introduced in Elasticsearch 7.8.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-get-template-v1.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-template-v1.html>`_
 
         :param name: Comma-separated list of index template names used to limit the request.
             Wildcard (`*`) expressions are supported. To return all index templates,
@@ -2493,7 +2698,7 @@ class IndicesClient(NamespacedClient):
         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.16/data-streams.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
 
         :param name: Name of the index alias to convert to a data stream.
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -2546,7 +2751,7 @@ class IndicesClient(NamespacedClient):
         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.16/data-streams.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
 
         :param actions: Actions to perform.
         """
@@ -2604,9 +2809,29 @@ class IndicesClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Opens a closed index. For data streams, the API opens any closed backing indices.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-open-close.html>`_
+        Open a closed index. For data streams, the API opens any closed backing indices.
+        A closed index is blocked for read/write operations and does not allow all operations
+        that opened indices allow. It is not possible to index documents or to search
+        for documents in a closed index. This allows closed indices to not have to maintain
+        internal data structures for indexing or searching documents, resulting in a
+        smaller overhead on the cluster. When opening or closing an index, the master
+        is responsible for restarting the index shards to reflect the new state of the
+        index. The shards will then go through the normal recovery process. The data
+        of opened or closed indices is automatically replicated by the cluster to ensure
+        that enough shard copies are safely kept around at all times. You can open and
+        close multiple indices. An error is thrown if the request explicitly refers to
+        a missing index. This behavior can be turned off by using the `ignore_unavailable=true`
+        parameter. By default, you must explicitly name the indices you are opening or
+        closing. To open or close indices with `_all`, `*`, or other wildcard expressions,
+        change the `action.destructive_requires_name` setting to `false`. This setting
+        can also be changed with the cluster update settings API. Closed indices consume
+        a significant amount of disk-space which can cause problems in managed environments.
+        Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable`
+        to `false`. Because opening or closing an index allocates its shards, the `wait_for_active_shards`
+        setting on index creation applies to the `_open` and `_close` index actions as
+        well.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-open-close.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). By default, you must explicitly
@@ -2679,10 +2904,20 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Promotes a data stream from a replicated data stream managed by CCR to a regular
-        data stream
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html>`_
+        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>`_
 
         :param name: The name of the data stream
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -2744,7 +2979,7 @@ class IndicesClient(NamespacedClient):
         """
         Create or update an alias. Adds a data stream or index to an alias.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-aliases.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-aliases.html>`_
 
         :param index: Comma-separated list of data streams or indices to add. Supports
             wildcards (`*`). Wildcard patterns that match both data streams and indices
@@ -2847,7 +3082,7 @@ class IndicesClient(NamespacedClient):
         Update data stream lifecycles. Update the data stream lifecycle of the specified
         data streams.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams-put-lifecycle.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams-put-lifecycle.html>`_
 
         :param name: Comma-separated list of data streams used to limit the request.
             Supports wildcards (`*`). To target all data streams use `*` or `_all`.
@@ -2947,9 +3182,35 @@ class IndicesClient(NamespacedClient):
     ) -> ObjectApiResponse[t.Any]:
         """
         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.16/indices-put-template.html>`_
+        and aliases that can be applied automatically to new indices. Elasticsearch applies
+        templates to new indices based on an wildcard pattern that matches the index
+        name. Index templates are applied during data stream or index creation. For data
+        streams, these settings and mappings are applied when the stream's backing indices
+        are created. Settings and mappings specified in a create index API request override
+        any settings or mappings specified in an index template. Changes to index templates
+        do not affect existing indices, including the existing backing indices of a data
+        stream. You can use C-style `/* *\\/` block comments in index templates. You
+        can include comments anywhere in the request body, except before the opening
+        curly bracket. **Multiple matching templates** If multiple index templates match
+        the name of a new index or data stream, the template with the highest priority
+        is used. Multiple templates with overlapping index patterns at the same priority
+        are not allowed and an error will be thrown when attempting to create a template
+        matching an existing index template at identical priorities. **Composing aliases,
+        mappings, and settings** When multiple component templates are specified in the
+        `composed_of` field for an index template, they are merged in the order specified,
+        meaning that later component templates override earlier component templates.
+        Any mappings, settings, or aliases from the parent index template are merged
+        in next. Finally, any configuration on the index request itself is merged. Mapping
+        definitions are merged recursively, which means that later mapping components
+        can introduce new field mappings and update the mapping configuration. If a field
+        mapping is already contained in an earlier component, its definition will be
+        completely overwritten by the later one. This recursive merging strategy applies
+        not only to field mappings, but also root options like `dynamic_templates` and
+        `meta`. If an earlier component contains a `dynamic_templates` block, then by
+        default new `dynamic_templates` entries are appended onto the end. If an entry
+        already exists with the same key, then it is overwritten by the new definition.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-put-template.html>`_
 
         :param name: Index or template name
         :param allow_auto_create: This setting overrides the value of the `action.auto_create_index`
@@ -2977,8 +3238,11 @@ class IndicesClient(NamespacedClient):
         :param master_timeout: 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.
-        :param meta: Optional user metadata about the index template. May have any contents.
-            This map is not automatically generated by Elasticsearch.
+        :param meta: Optional user metadata about the index template. It may have any
+            contents. It is not automatically generated or used by Elasticsearch. This
+            user-defined object is stored in the cluster state, so keeping it short is
+            preferable To unset the metadata, replace the template without specifying
+            it.
         :param priority: 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
@@ -2987,7 +3251,9 @@ class IndicesClient(NamespacedClient):
         :param template: Template to be applied. It may optionally include an `aliases`,
             `mappings`, or `settings` configuration.
         :param version: Version number used to manage index templates externally. This
-            number is not automatically generated by Elasticsearch.
+            number is not automatically generated by Elasticsearch. External systems
+            can use these version numbers to simplify template management. To unset a
+            version, replace the template without specifying one.
         """
         if name in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'name'")
@@ -3106,11 +3372,29 @@ class IndicesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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.16/indices-put-mapping.html>`_
+        Update field mappings. Add new fields to an existing data stream or index. You
+        can also use this API to change the search settings of existing fields and add
+        new properties to existing object fields. For data streams, these changes are
+        applied to all backing indices by default. **Add multi-fields to an existing
+        field** Multi-fields let you index the same field in different ways. You can
+        use this API to update the fields mapping parameter and enable multi-fields for
+        an existing field. WARNING: If an index (or data stream) contains documents when
+        you add a multi-field, those documents will not have values for the new multi-field.
+        You can populate the new multi-field with the update by query API. **Change supported
+        mapping parameters for an existing field** The documentation for each mapping
+        parameter indicates whether you can update it for an existing field using this
+        API. For example, you can use the update mapping API to update the `ignore_above`
+        parameter. **Change the mapping of an existing field** Except for supported mapping
+        parameters, you can't change the mapping or field type of an existing field.
+        Changing an existing field could invalidate data that's already indexed. If you
+        need to change the mapping of a field in a data stream's backing indices, refer
+        to documentation about modifying data streams. If you need to change the mapping
+        of a field in other indices, create a new index with the correct mapping and
+        reindex your data into that index. **Rename a field** Renaming a field would
+        invalidate data already indexed under the old field name. Instead, add an alias
+        field to create an alternate field name.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-put-mapping.html>`_
 
         :param index: 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.
@@ -3239,8 +3523,21 @@ class IndicesClient(NamespacedClient):
         """
         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.16/indices-update-settings.html>`_
+        To revert a setting to the default value, use a null value. The list of per-index
+        settings that can be updated dynamically on live indices can be found in index
+        module documentation. To preserve existing settings from being updated, set the
+        `preserve_existing` parameter to `true`. NOTE: You can only define new analyzers
+        on closed indices. To add an analyzer, you must close the index, define the analyzer,
+        and reopen the index. You cannot close the write index of a data stream. To update
+        the analyzer for a data stream's write index and future backing indices, update
+        the analyzer in the index template used by the stream. Then roll over the data
+        stream to apply the new analyzer to the stream's write index and future backing
+        indices. This affects searches and any new data added to the stream after the
+        rollover. However, it does not affect the data stream's backing indices or their
+        existing data. To change the analyzer for existing backing indices, you must
+        create a new data stream and reindex your data into it.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-update-settings.html>`_
 
         :param settings:
         :param index: Comma-separated list of data streams, indices, and aliases used
@@ -3343,9 +3640,25 @@ class IndicesClient(NamespacedClient):
     ) -> ObjectApiResponse[t.Any]:
         """
         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.16/indices-templates-v1.html>`_
+        and aliases that can be applied automatically to new indices. Elasticsearch applies
+        templates to new indices based on an index pattern that matches the index name.
+        IMPORTANT: This documentation is about legacy index templates, which are deprecated
+        and will be replaced by the composable templates introduced in Elasticsearch
+        7.8. Composable templates always take precedence over legacy templates. If no
+        composable template matches a new index, matching legacy templates are applied
+        according to their order. Index templates are only applied during index creation.
+        Changes to index templates do not affect existing indices. Settings and mappings
+        specified in create index API requests override any settings or mappings specified
+        in an index template. You can use C-style `/* *\\/` block comments in index templates.
+        You can include comments anywhere in the request body, except before the opening
+        curly bracket. **Indices matching multiple templates** Multiple index templates
+        can potentially match an index, in this case, both the settings and mappings
+        are merged into the final configuration of the index. The order of the merging
+        can be controlled using the order parameter, with lower order being applied first,
+        and higher orders overriding them. NOTE: Multiple matching templates with the
+        same order value will result in a non-deterministic merging order.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-templates-v1.html>`_
 
         :param name: The name of the template
         :param aliases: Aliases for the index.
@@ -3364,7 +3677,8 @@ class IndicesClient(NamespacedClient):
             with lower values.
         :param settings: Configuration options for the index.
         :param version: Version number used to manage index templates externally. This
-            number is not automatically generated by Elasticsearch.
+            number is not automatically generated by Elasticsearch. To unset a version,
+            replace the template without specifying one.
         """
         if name in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'name'")
@@ -3423,11 +3737,29 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns 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.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-recovery.html>`_
+        Get index recovery information. Get information about ongoing and completed shard
+        recoveries for one or more indices. For data streams, the API returns information
+        for the stream's backing indices. All recoveries, whether ongoing or complete,
+        are kept in the cluster state and may be reported on at any time. Shard recovery
+        is the process of initializing a shard copy, such as restoring a primary shard
+        from a snapshot or creating a replica shard from a primary shard. When a shard
+        recovery completes, the recovered shard is available for search and indexing.
+        Recovery automatically occurs during the following processes: * When creating
+        an index for the first time. * When a node rejoins the cluster and starts up
+        any missing primary shard copies using the data that it holds in its data path.
+        * Creation of new replica shard copies from the primary. * Relocation of a shard
+        copy to a different node in the same cluster. * A snapshot restore operation.
+        * A clone, shrink, or split operation. You can determine the cause of a shard
+        recovery using the recovery or cat recovery APIs. The index recovery API reports
+        information about completed recoveries only for shard copies that currently exist
+        in the cluster. It only reports the last recovery for each shard copy and does
+        not report historical information about earlier recoveries, nor does it report
+        information about the recoveries of shard copies that no longer exist. This means
+        that if a shard copy completes a recovery and then Elasticsearch relocates it
+        onto a different node then the information about the original recovery will not
+        be shown in the recovery API.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-recovery.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
@@ -3489,9 +3821,19 @@ class IndicesClient(NamespacedClient):
         """
         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.16/indices-refresh.html>`_
+        on the stream’s backing indices. By default, Elasticsearch periodically refreshes
+        indices every second, but only on indices that have received one search request
+        or more in the last 30 seconds. You can change this default interval with the
+        `index.refresh_interval` setting. Refresh requests are synchronous and do not
+        return a response until the refresh operation completes. Refreshes are resource-intensive.
+        To ensure good cluster performance, it's recommended to wait for Elasticsearch's
+        periodic refresh rather than performing an explicit refresh when possible. If
+        your application workflow indexes documents and then runs a search to retrieve
+        the indexed document, it's recommended to use the index API's `refresh=wait_for`
+        query parameter option. This option ensures the indexing operation waits for
+        a periodic refresh before running the search.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-refresh.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
@@ -3559,9 +3901,23 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Reloads an index's search analyzers and their resources.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-reload-analyzers.html>`_
+        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>`_
 
         :param index: A comma-separated list of index names to reload analyzers for
         :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
@@ -3623,11 +3979,40 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Resolves the specified index expressions to return information about each cluster,
-        including the local cluster, if included. Multiple patterns and remote clusters
-        are supported.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-resolve-cluster-api.html>`_
+        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.
+        For example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information
+        about the local cluster and all remotely configured clusters that start with
+        the alias `cluster*`. Each cluster returns information about whether it has any
+        indices, aliases or data streams that match `my-index-*`. **Advantages of using
+        this endpoint before a cross-cluster search** You may want to exclude a cluster
+        or index from a search when: * A remote cluster is not currently connected and
+        is configured with `skip_unavailable=false`. Running a cross-cluster search under
+        those conditions will cause the entire search to fail. * A cluster has no matching
+        indices, aliases or data streams for the index expression (or your user does
+        not have permissions to search them). For example, suppose your index expression
+        is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data
+        streams that match `logs*`. In that case, that cluster will return no results
+        from that cluster if you include it in a cross-cluster search. * The index expression
+        (combined with any query parameters you specify) will likely cause an exception
+        to be thrown when you do the search. In these cases, the "error" field in the
+        `_resolve/cluster` response will be present. (This is also where security/permission
+        errors will be shown.) * A remote cluster is an older version that does not support
+        the feature you want to use in your search.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-resolve-cluster-api.html>`_
 
         :param name: Comma-separated name(s) or index pattern(s) of the indices, aliases,
             and data streams to resolve. Resources on remote clusters can be specified
@@ -3698,10 +4083,10 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Resolves the specified name(s) and/or index patterns for indices, aliases, and
-        data streams. Multiple patterns and remote clusters are supported.
+        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.16/indices-resolve-index-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-resolve-index-api.html>`_
 
         :param name: Comma-separated name(s) or index pattern(s) of the indices, aliases,
             and data streams to resolve. Resources on remote clusters can be specified
@@ -3772,9 +4157,35 @@ class IndicesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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.16/indices-rollover-index.html>`_
+        Roll over to a new index. TIP: It is recommended to use the index lifecycle rollover
+        action to automate rollovers. The rollover API creates a new index for a data
+        stream or index alias. The API behavior depends on the rollover target. **Roll
+        over a data stream** If you roll over a data stream, the API creates a new write
+        index for the stream. The stream's previous write index becomes a regular backing
+        index. A rollover also increments the data stream's generation. **Roll over an
+        index alias with a write index** TIP: Prior to Elasticsearch 7.9, you'd typically
+        use an index alias with a write index to manage time series data. Data streams
+        replace this functionality, require less maintenance, and automatically integrate
+        with data tiers. If an index alias points to multiple indices, one of the indices
+        must be a write index. The rollover API creates a new write index for the alias
+        with `is_write_index` set to `true`. The API also `sets is_write_index` to `false`
+        for the previous write index. **Roll over an index alias with one index** If
+        you roll over an index alias that points to only one index, the API creates a
+        new index for the alias and removes the original index from the alias. NOTE:
+        A rollover creates a new index and is subject to the `wait_for_active_shards`
+        setting. **Increment index names for an alias** When you roll over an index alias,
+        you can specify a name for the new index. If you don't specify a name and the
+        current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`,
+        the new index name increments that number. For example, if you roll over an alias
+        with a current index of `my-index-000001`, the rollover creates a new index named
+        `my-index-000002`. This number is always six characters and zero-padded, regardless
+        of the previous index's name. If you use an index alias for time series data,
+        you can use date math in the index name to track the rollover date. For example,
+        you can create an alias that points to an index named `<my-index-{now/d}-000001>`.
+        If you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.
+        If you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-rollover-index.html>`_
 
         :param alias: Name of the data stream or index alias to roll over.
         :param new_index: Name of the index to create. Supports date math. Data streams
@@ -3877,10 +4288,11 @@ class IndicesClient(NamespacedClient):
         verbose: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns low-level information about the Lucene segments in index shards. For
-        data streams, the API returns information about the stream’s backing indices.
+        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.16/indices-segments.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-segments.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
@@ -3957,10 +4369,16 @@ class IndicesClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves store information about replica shards in one or more indices. For
-        data streams, the API retrieves store information for the stream’s backing indices.
+        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.16/indices-shards-stores.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-shards-stores.html>`_
 
         :param index: List of data streams, indices, and aliases used to limit the request.
         :param allow_no_indices: If false, the request returns an error if any wildcard
@@ -4029,9 +4447,41 @@ class IndicesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Shrinks an existing index into a new index with fewer primary shards.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-shrink-index.html>`_
+        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>`_
 
         :param index: Name of the source index to shrink.
         :param target: Name of the target index to create.
@@ -4104,10 +4554,10 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Simulate an index. Returns the index configuration that would be applied to the
-        specified index from an existing index template.
+        Simulate an index. Get 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.16/indices-simulate-index.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-simulate-index.html>`_
 
         :param name: Name of the index to simulate
         :param include_defaults: If true, returns all relevant default configurations
@@ -4182,10 +4632,10 @@ class IndicesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Simulate an index template. Returns the index configuration that would be applied
+        Simulate an index template. Get the index configuration that would be applied
         by a particular index template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-simulate-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-simulate-template.html>`_
 
         :param name: 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
@@ -4314,9 +4764,33 @@ class IndicesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Splits an existing index into a new index with more primary shards.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-split-index.html>`_
+        Split an index. Split an index into a new index with more primary shards. * Before
+        you can split an index: * The index must be read-only. * The cluster health status
+        must be green. You can do make an index read-only with the following request
+        using the add index block API: ``` PUT /my_source_index/_block/write ``` The
+        current write index on a data stream cannot be split. In order to split the current
+        write index, the data stream must first be rolled over so that a new write index
+        is created and then the previous write index can be split. The number of times
+        the index can be split (and the number of shards that each original shard can
+        be split into) is determined by the `index.number_of_routing_shards` setting.
+        The number of routing shards specifies the hashing space that is used internally
+        to distribute documents across shards with consistent hashing. For instance,
+        a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be
+        split by a factor of 2 or 3. A split operation: * Creates a new target index
+        with the same definition as the source index, but with a larger number of primary
+        shards. * Hard-links segments from the source index into the target index. If
+        the file system doesn't support hard-linking, all segments are copied into the
+        new index, which is a much more time consuming process. * Hashes all documents
+        again, after low level files are created, to delete documents that belong to
+        a different shard. * Recovers the target index as though it were a closed index
+        which had just been re-opened. IMPORTANT: Indices can only be split if they satisfy
+        the following requirements: * The target index must not exist. * The source index
+        must have fewer primary shards than the target index. * The number of primary
+        shards in the target index must be a multiple of the number of primary shards
+        in the source index. * The node handling the split process must have sufficient
+        free disk space to accommodate a second copy of the existing index.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-split-index.html>`_
 
         :param index: Name of the source index to split.
         :param target: Name of the target index to create.
@@ -4406,10 +4880,16 @@ class IndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns statistics for one or more indices. For data streams, the API retrieves
-        statistics for the stream’s backing indices.
+        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.16/indices-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-stats.html>`_
 
         :param index: A comma-separated list of index names; use `_all` or empty string
             to perform the operation on all indices
@@ -4510,9 +4990,10 @@ class IndicesClient(NamespacedClient):
         wait_for_active_shards: t.Optional[str] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Unfreezes an index.
+        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.16/unfreeze-index-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/unfreeze-index-api.html>`_
 
         :param index: Identifier for the index.
         :param allow_no_indices: If `false`, the request returns an error if any wildcard
@@ -4586,7 +5067,7 @@ class IndicesClient(NamespacedClient):
         """
         Create or update an alias. Adds a data stream or index to an alias.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-aliases.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-aliases.html>`_
 
         :param actions: Actions to perform.
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -4661,7 +5142,7 @@ class IndicesClient(NamespacedClient):
         """
         Validate a query. Validates a query without running it.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-validate.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-validate.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases to search.
             Supports wildcards (`*`). To search all data streams or indices, omit this