elasticsearch 8.15.1__py3-none-any.whl → 8.17.0__py3-none-any.whl

elasticsearch/_async/client/cat.py

@@ -20,7 +20,13 @@ import typing as t
 from elastic_transport import ObjectApiResponse, TextApiResponse
 
 from ._base import NamespacedClient
-from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
+from .utils import (
+    SKIP_IN_PATH,
+    Stability,
+    _quote,
+    _rewrite_parameters,
+    _stability_warning,
+)
 
 
 class CatClient(NamespacedClient):
@@ -51,13 +57,13 @@ class CatClient(NamespacedClient):
         v: t.Optional[bool] = None,
     ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
         """
-        Retrieves the cluster’s index aliases, including filter and routing information.
-        The API does not return data stream aliases. IMPORTANT: cat APIs are only intended
+        Get aliases. Retrieves the cluster’s index aliases, including filter and routing
+        information. The API does not return data stream aliases. CAT APIs are only intended
         for human consumption using the command line or the Kibana console. They are
         not intended for use by applications. For application consumption, use the aliases
         API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-alias.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-alias.html>`_
 
         :param name: A comma-separated list of aliases to retrieve. Supports wildcards
             (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
@@ -145,7 +151,7 @@ class CatClient(NamespacedClient):
         disk space. IMPORTANT: cat APIs are only intended for human consumption using
         the command line or Kibana console. They are not intended for use by applications.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-allocation.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-allocation.html>`_
 
         :param node_id: Comma-separated list of node identifiers or names used to limit
             the returned information.
@@ -225,13 +231,14 @@ class CatClient(NamespacedClient):
         v: t.Optional[bool] = None,
     ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
         """
-        Returns information about component templates in a cluster. Component templates
-        are building blocks for constructing index templates that specify index mappings,
-        settings, and aliases. IMPORTANT: cat APIs are only intended for human consumption
-        using the command line or Kibana console. They are not intended for use by applications.
-        For application consumption, use the get component template API.
+        Get component templates. Returns information about component templates in a cluster.
+        Component templates are building blocks for constructing index templates that
+        specify index mappings, settings, and aliases. CAT APIs are only intended for
+        human consumption using the command line or Kibana console. They are not intended
+        for use by applications. For application consumption, use the get component template
+        API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-component-templates.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-component-templates.html>`_
 
         :param name: The name of the component template. Accepts wildcard expressions.
             If omitted, all component templates are returned.
@@ -308,14 +315,14 @@ class CatClient(NamespacedClient):
         v: t.Optional[bool] = None,
     ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
         """
-        Provides quick access to a document count for a data stream, an index, or an
-        entire cluster. NOTE: The document count only includes live documents, not deleted
-        documents which have not yet been removed by the merge process. IMPORTANT: cat
+        Get a document count. Provides quick access to a document count for a data stream,
+        an index, or an entire cluster. The document count only includes live documents,
+        not deleted documents which have not yet been removed by the merge process. CAT
         APIs are only intended for human consumption using the command line or Kibana
         console. They are not intended for use by applications. For application consumption,
         use the count API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-count.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-count.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
@@ -401,7 +408,7 @@ class CatClient(NamespacedClient):
         using the command line or Kibana console. They are not intended for use by applications.
         For application consumption, use the nodes stats API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-fielddata.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-fielddata.html>`_
 
         :param fields: Comma-separated list of fields used to limit returned information.
             To retrieve all fields, omit this parameter.
@@ -496,7 +503,7 @@ class CatClient(NamespacedClient):
         across multiple nodes. You also can use the API to track the recovery of a large
         cluster over a longer period of time.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-health.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-health.html>`_
 
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -571,9 +578,9 @@ class CatClient(NamespacedClient):
         v: t.Optional[bool] = None,
     ) -> TextApiResponse:
         """
-        Returns help for the Cat APIs.
+        Get CAT help. Returns help for the CAT APIs.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat.html>`_
 
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -660,18 +667,18 @@ class CatClient(NamespacedClient):
         v: t.Optional[bool] = None,
     ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
         """
-        Returns high-level information about indices in a cluster, including backing
-        indices for data streams. IMPORTANT: cat APIs are only intended for human consumption
+        Get index information. Returns high-level information about indices in a cluster,
+        including backing indices for data streams. Use this request to get the following
+        information for each index in a cluster: - shard count - document count - deleted
+        document count - primary store size - total store size of all shards, including
+        shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch
+        uses internally to power indexing and search. As a result, all document counts
+        include hidden nested documents. To get an accurate count of Elasticsearch documents,
+        use the cat count or count APIs. CAT APIs are only intended for human consumption
         using the command line or Kibana console. They are not intended for use by applications.
-        For application consumption, use the get index API. Use the cat indices API to
-        get the following information for each index in a cluster: shard count; document
-        count; deleted document count; primary store size; total store size of all shards,
-        including shard replicas. These metrics are retrieved directly from Lucene, which
-        Elasticsearch uses internally to power indexing and search. As a result, all
-        document counts include hidden nested documents. To get an accurate count of
-        Elasticsearch documents, use the cat count or count APIs.
+        For application consumption, use an index endpoint.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-indices.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-indices.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
@@ -773,7 +780,7 @@ class CatClient(NamespacedClient):
         command line or Kibana console. They are not intended for use by applications.
         For application consumption, use the nodes info API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-master.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-master.html>`_
 
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -942,12 +949,13 @@ class CatClient(NamespacedClient):
         v: t.Optional[bool] = None,
     ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
         """
-        Returns configuration and usage information about data frame analytics jobs.
-        IMPORTANT: cat APIs are only intended for human consumption using the Kibana
-        console or command line. They are not intended for use by applications. For application
-        consumption, use the get data frame analytics jobs statistics API.
+        Get data frame analytics jobs. Returns configuration and usage information about
+        data frame analytics jobs. CAT APIs are only intended for human consumption using
+        the Kibana console or command line. They are not intended for use by applications.
+        For application consumption, use the get data frame analytics jobs statistics
+        API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-dfanalytics.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-dfanalytics.html>`_
 
         :param id: The ID of the data frame analytics to fetch
         :param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -1114,14 +1122,14 @@ class CatClient(NamespacedClient):
         v: t.Optional[bool] = None,
     ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
         """
-        Returns configuration and usage information about datafeeds. This API returns
-        a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled,
-        you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges
-        to use this API. IMPORTANT: cat APIs are only intended for human consumption
+        Get datafeeds. Returns configuration and usage information about datafeeds. This
+        API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features
+        are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
+        cluster privileges to use this API. CAT APIs are only intended for human consumption
         using the Kibana console or command line. They are not intended for use by applications.
         For application consumption, use the get datafeed statistics API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-datafeeds.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-datafeeds.html>`_
 
         :param datafeed_id: A numerical character string that uniquely identifies the
             datafeed.
@@ -1486,15 +1494,15 @@ class CatClient(NamespacedClient):
         v: t.Optional[bool] = None,
     ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
         """
-        Returns configuration and usage information for anomaly detection jobs. This
-        API returns a maximum of 10,000 jobs. If the Elasticsearch security features
-        are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
-        cluster privileges to use this API. IMPORTANT: cat APIs are only intended for
+        Get anomaly detection jobs. Returns configuration and usage information for anomaly
+        detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch
+        security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`,
+        or `manage` cluster privileges to use this API. CAT APIs are only intended for
         human consumption using the Kibana console or command line. They are not intended
         for use by applications. For application consumption, use the get anomaly detection
         job statistics API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-anomaly-detectors.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-anomaly-detectors.html>`_
 
         :param job_id: Identifier for the anomaly detection job.
         :param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1678,12 +1686,12 @@ class CatClient(NamespacedClient):
         v: t.Optional[bool] = None,
     ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
         """
-        Returns configuration and usage information about inference trained models. IMPORTANT:
-        cat APIs are only intended for human consumption using the Kibana console or
-        command line. They are not intended for use by applications. For application
+        Get trained models. Returns configuration and usage information about inference
+        trained models. CAT APIs are only intended for human consumption using the Kibana
+        console or command line. They are not intended for use by applications. For application
         consumption, use the get trained models statistics API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-trained-model.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-trained-model.html>`_
 
         :param model_id: A unique identifier for the trained model.
         :param allow_no_match: Specifies what to do when the request: contains wildcard
@@ -1780,7 +1788,7 @@ class CatClient(NamespacedClient):
         are not intended for use by applications. For application consumption, use the
         nodes info API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-nodeattrs.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-nodeattrs.html>`_
 
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1859,7 +1867,7 @@ class CatClient(NamespacedClient):
         are not intended for use by applications. For application consumption, use the
         nodes info API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-nodes.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-nodes.html>`_
 
         :param bytes: The unit used to display byte values.
         :param format: Specifies the format to return the columnar data in, can be set
@@ -1944,7 +1952,7 @@ class CatClient(NamespacedClient):
         console. They are not intended for use by applications. For application consumption,
         use the pending cluster tasks API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-pending-tasks.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-pending-tasks.html>`_
 
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2018,7 +2026,7 @@ class CatClient(NamespacedClient):
         They are not intended for use by applications. For application consumption, use
         the nodes info API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-plugins.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-plugins.html>`_
 
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2102,7 +2110,7 @@ class CatClient(NamespacedClient):
         line or Kibana console. They are not intended for use by applications. For application
         consumption, use the index recovery API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-recovery.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-recovery.html>`_
 
         :param index: A comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2194,7 +2202,7 @@ class CatClient(NamespacedClient):
         are not intended for use by applications. For application consumption, use the
         get snapshot repository API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-repositories.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-repositories.html>`_
 
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2273,7 +2281,7 @@ class CatClient(NamespacedClient):
         console. They are not intended for use by applications. For application consumption,
         use the index segments API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-segments.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-segments.html>`_
 
         :param index: A comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2362,7 +2370,7 @@ class CatClient(NamespacedClient):
         for human consumption using the command line or Kibana console. They are not
         intended for use by applications.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-shards.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-shards.html>`_
 
         :param index: A comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2450,7 +2458,7 @@ class CatClient(NamespacedClient):
         console. They are not intended for use by applications. For application consumption,
         use the get snapshot API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-snapshots.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-snapshots.html>`_
 
         :param repository: A comma-separated list of snapshot repositories used to limit
             the request. Accepts wildcard expressions. `_all` returns all repositories.
@@ -2515,6 +2523,7 @@ class CatClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def tasks(
         self,
         *,
@@ -2540,7 +2549,7 @@ class CatClient(NamespacedClient):
         console. They are not intended for use by applications. For application consumption,
         use the task management API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/tasks.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html>`_
 
         :param actions: The task action names, which are used to limit the response.
         :param detailed: If `true`, the response includes detailed information about
@@ -2630,7 +2639,7 @@ class CatClient(NamespacedClient):
         console. They are not intended for use by applications. For application consumption,
         use the get index template API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-templates.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-templates.html>`_
 
         :param name: The name of the template to return. Accepts wildcard expressions.
             If omitted, all templates are returned.
@@ -2716,7 +2725,7 @@ class CatClient(NamespacedClient):
         They are not intended for use by applications. For application consumption, use
         the nodes info API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-thread-pool.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-thread-pool.html>`_
 
         :param thread_pool_patterns: A comma-separated list of thread pool names used
             to limit the request. Accepts wildcard expressions.
@@ -2966,12 +2975,12 @@ class CatClient(NamespacedClient):
         v: t.Optional[bool] = None,
     ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
         """
-        Returns configuration and usage information about transforms. IMPORTANT: cat
-        APIs are only intended for human consumption using the Kibana console or command
-        line. They are not intended for use by applications. For application consumption,
-        use the get transform statistics API.
+        Get transforms. Returns configuration and usage information about transforms.
+        CAT APIs are only intended for human consumption using the Kibana console or
+        command line. They are not intended for use by applications. For application
+        consumption, use the get transform statistics API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-transforms.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-transforms.html>`_
 
         :param transform_id: A transform identifier or a wildcard expression. If you
             do not specify one of these options, the API returns information for all

elasticsearch/_async/client/ccr.py

@@ -36,9 +36,10 @@ class CcrClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes auto-follow patterns.
+        Delete auto-follow patterns. Delete a collection of cross-cluster replication
+        auto-follow patterns.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-delete-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-delete-auto-follow-pattern.html>`_
 
         :param name: The name of the auto follow pattern.
         """
@@ -107,9 +108,12 @@ class CcrClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates a new follower index configured to follow the referenced leader index.
+        Create a follower. Create a cross-cluster replication follower index that follows
+        a specific leader index. When the API returns, the follower index exists and
+        cross-cluster replication starts replicating operations from the leader index
+        to the follower index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-put-follow.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-follow.html>`_
 
         :param index: The name of the follower index
         :param leader_index:
@@ -198,10 +202,12 @@ class CcrClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves information about all follower indices, including parameters and status
-        for each follower index
+        Get follower information. Get information about all cross-cluster replication
+        follower indices. For example, the results include follower index names, leader
+        index names, replication options, and whether the follower indices are active
+        or paused.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-get-follow-info.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-info.html>`_
 
         :param index: A comma-separated list of index patterns; use `_all` to perform
             the operation on all indices
@@ -240,10 +246,11 @@ class CcrClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves follower stats. return shard-level stats about the following tasks
-        associated with each shard for the specified indices.
+        Get follower stats. Get cross-cluster replication follower stats. The API returns
+        shard-level stats about the "following tasks" associated with each shard for
+        the specified indices.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-get-follow-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-follow-stats.html>`_
 
         :param index: A comma-separated list of index patterns; use `_all` to perform
             the operation on all indices
@@ -294,9 +301,25 @@ class CcrClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Removes the follower retention leases from the leader.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-post-forget-follower.html>`_
+        Forget a follower. Remove the cross-cluster replication follower retention leases
+        from the leader. A following index takes out retention leases on its leader index.
+        These leases are used to increase the likelihood that the shards of the leader
+        index retain the history of operations that the shards of the following index
+        need to run replication. When a follower index is converted to a regular index
+        by the unfollow API (either by directly calling the API or by index lifecycle
+        management tasks), these leases are removed. However, removal of the leases can
+        fail, for example when the remote cluster containing the leader index is unavailable.
+        While the leases will eventually expire on their own, their extended existence
+        can cause the leader index to hold more history than necessary and prevent index
+        lifecycle management from performing some operations on the leader index. This
+        API exists to enable manually removing the leases when the unfollow API is unable
+        to do so. NOTE: This API does not stop replication by a following index. If you
+        use this API with a follower index that is still actively following, the following
+        index will add back retention leases on the leader. The only purpose of this
+        API is to handle the case of failure to remove the following retention leases
+        after the unfollow API is invoked.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-forget-follower.html>`_
 
         :param index: the name of the leader index for which specified follower retention
             leases should be removed
@@ -350,10 +373,9 @@ class CcrClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Gets configured auto-follow patterns. Returns the specified auto-follow pattern
-        collection.
+        Get auto-follow patterns. Get cross-cluster replication auto-follow patterns.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-get-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-auto-follow-pattern.html>`_
 
         :param name: Specifies the auto-follow pattern collection that you want to retrieve.
             If you do not specify a name, the API returns information for all collections.
@@ -395,9 +417,16 @@ class CcrClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Pauses an auto-follow pattern
+        Pause an auto-follow pattern. Pause a cross-cluster replication auto-follow pattern.
+        When the API returns, the auto-follow pattern is inactive. New indices that are
+        created on the remote cluster and match the auto-follow patterns are ignored.
+        You can resume auto-following with the resume auto-follow pattern API. When it
+        resumes, the auto-follow pattern is active again and automatically configures
+        follower indices for newly created indices on the remote cluster that match its
+        patterns. Remote indices that were created while the pattern was paused will
+        also be followed, unless they have been deleted or closed in the interim.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-pause-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-pause-auto-follow-pattern.html>`_
 
         :param name: The name of the auto follow pattern that should pause discovering
             new indices to follow.
@@ -436,10 +465,12 @@ class CcrClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Pauses a follower index. The follower index will not fetch any additional operations
-        from the leader index.
+        Pause a follower. Pause a cross-cluster replication follower index. The follower
+        index will not fetch any additional operations from the leader index. You can
+        resume following with the resume follower API. You can pause and resume a follower
+        index to change the configuration of the following task.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-post-pause-follow.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-pause-follow.html>`_
 
         :param index: The name of the follower index that should pause following its
             leader index.
@@ -512,11 +543,16 @@ class CcrClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates a new named collection of auto-follow patterns against a specified remote
-        cluster. Newly created indices on the remote cluster matching any of the specified
-        patterns will be automatically configured as follower indices.
+        Create or update auto-follow patterns. Create a collection of cross-cluster replication
+        auto-follow patterns for a remote cluster. Newly created indices on the remote
+        cluster that match any of the patterns are automatically configured as follower
+        indices. Indices on the remote cluster that were created before the auto-follow
+        pattern was created will not be auto-followed even if they match the pattern.
+        This API can also be used to update auto-follow patterns. NOTE: Follower indices
+        that were configured automatically before updating an auto-follow pattern will
+        remain unchanged even if they do not match against the new patterns.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-put-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-put-auto-follow-pattern.html>`_
 
         :param name: The name of the collection of auto-follow patterns.
         :param remote_cluster: The remote cluster containing the leader indices to match
@@ -638,9 +674,13 @@ class CcrClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Resumes an auto-follow pattern that has been paused
+        Resume an auto-follow pattern. Resume a cross-cluster replication auto-follow
+        pattern that was paused. The auto-follow pattern will resume configuring following
+        indices for newly created indices that match its patterns on the remote cluster.
+        Remote indices created while the pattern was paused will also be followed unless
+        they have been deleted or closed in the interim.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-resume-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-resume-auto-follow-pattern.html>`_
 
         :param name: The name of the auto follow pattern to resume discovering new indices
             to follow.
@@ -703,9 +743,13 @@ class CcrClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Resumes a follower index that has been paused
+        Resume a follower. Resume a cross-cluster replication follower index that was
+        paused. The follower index could have been paused with the pause follower API.
+        Alternatively it could be paused due to replication that cannot be retried due
+        to failures during following tasks. When this API returns, the follower index
+        will resume fetching operations from the leader index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-post-resume-follow.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-resume-follow.html>`_
 
         :param index: The name of the follow index to resume following.
         :param max_outstanding_read_requests:
@@ -785,9 +829,10 @@ class CcrClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Gets all stats related to cross-cluster replication.
+        Get cross-cluster replication stats. This API returns stats about auto-following
+        and the same shard-level stats as the get follower stats API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-get-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-get-stats.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ccr/stats"
@@ -821,10 +866,15 @@ class CcrClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Stops the following task associated with a follower index and removes index metadata
-        and settings associated with cross-cluster replication.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-post-unfollow.html>`_
+        Unfollow an index. Convert a cross-cluster replication follower index to a regular
+        index. The API stops the following task associated with a follower index and
+        removes index metadata and settings associated with cross-cluster replication.
+        The follower index must be paused and closed before you call the unfollow API.
+        NOTE: Currently cross-cluster replication does not support converting an existing
+        regular index to a follower index. Converting a follower index to a regular index
+        is an irreversible operation.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ccr-post-unfollow.html>`_
 
         :param index: The name of the follower index that should be turned into a regular
             index.