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

elasticsearch/_sync/client/cluster.py

@@ -44,9 +44,15 @@ class ClusterClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Provides explanations for shard allocations in the cluster.
+        Explain the shard allocations. Get explanations for shard allocations in the
+        cluster. For unassigned shards, it provides an explanation for why the shard
+        is unassigned. For assigned shards, it provides an explanation for why the shard
+        is remaining on its current node and has not moved or rebalanced to another node.
+        This API can be very useful when attempting to diagnose why a shard is unassigned
+        or why a shard continues to remain on its current node when you might expect
+        otherwise.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-allocation-explain.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-allocation-explain.html>`_
 
         :param current_node: Specifies the node ID or the name of the node to only explain
             a shard that is currently located on the specified node.
@@ -117,7 +123,7 @@ class ClusterClient(NamespacedClient):
         are building blocks for constructing index templates that specify index mappings,
         settings, and aliases.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html>`_
 
         :param name: Comma-separated list or wildcard expression of component template
             names used to limit the request.
@@ -165,9 +171,10 @@ class ClusterClient(NamespacedClient):
         wait_for_removal: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Clears cluster voting config exclusions.
+        Clear cluster voting config exclusions. Remove master-eligible nodes from the
+        voting configuration exclusion list.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html>`_
 
         :param wait_for_removal: Specifies whether to wait for all excluded nodes to
             be removed from the cluster before clearing the voting configuration exclusions
@@ -215,7 +222,7 @@ class ClusterClient(NamespacedClient):
         Check component templates. Returns information about whether a particular component
         template exists.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html>`_
 
         :param name: Comma-separated list of component template names used to limit the
             request. Wildcard (*) expressions are supported.
@@ -270,7 +277,7 @@ class ClusterClient(NamespacedClient):
         """
         Get component templates. Retrieves information about component templates.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html>`_
 
         :param name: Comma-separated list of component template names used to limit the
             request. Wildcard (`*`) expressions are supported.
@@ -331,10 +338,10 @@ class ClusterClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns cluster-wide settings. By default, it returns only settings that have
-        been explicitly defined.
+        Get cluster-wide settings. By default, it returns only settings that have been
+        explicitly defined.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-get-settings.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-get-settings.html>`_
 
         :param flat_settings: If `true`, returns settings in flat format.
         :param include_defaults: If `true`, returns default cluster settings from the
@@ -414,17 +421,18 @@ class ClusterClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        The cluster health API returns a simple status on the health of the cluster.
-        You can also use the API to get the health status of only specified data streams
-        and indices. For data streams, the API retrieves the health status of the stream’s
-        backing indices. The cluster health status is: green, yellow or red. On the shard
-        level, a red status indicates that the specific shard is not allocated in the
-        cluster, yellow means that the primary shard is allocated but replicas are not,
-        and green means that all shards are allocated. The index level status is controlled
-        by the worst shard status. The cluster status is controlled by the worst index
+        Get the cluster health status. You can also use the API to get the health status
+        of only specified data streams and indices. For data streams, the API retrieves
+        the health status of the stream’s backing indices. The cluster health status
+        is: green, yellow or red. On the shard level, a red status indicates that the
+        specific shard is not allocated in the cluster. Yellow means that the primary
+        shard is allocated but replicas are not. Green means that all shards are allocated.
+        The index level status is controlled by the worst shard status. One of the main
+        benefits of the API is the ability to wait until the cluster reaches a certain
+        high watermark health level. The cluster status is controlled by the worst index
         status.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-health.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-health.html>`_
 
         :param index: Comma-separated list of data streams, indices, and index aliases
             used to limit the request. Wildcard expressions (`*`) are supported. To target
@@ -528,7 +536,7 @@ class ClusterClient(NamespacedClient):
         """
         Get cluster info. Returns basic information about the cluster.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-info.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-info.html>`_
 
         :param target: Limits the information returned to the specific target. Supports
             a comma-separated list, such as http,ingest.
@@ -568,16 +576,16 @@ class ClusterClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns cluster-level changes (such as create index, update mapping, allocate
-        or fail shard) that have not yet been executed. NOTE: This API returns a list
-        of any pending updates to the cluster state. These are distinct from the tasks
-        reported by the Task Management API which include periodic tasks and tasks initiated
-        by the user, such as node stats, search queries, or create index requests. However,
-        if a user-initiated task such as a create index command causes a cluster state
-        update, the activity of this task might be reported by both task api and pending
-        cluster tasks API.
+        Get the pending cluster tasks. Get information about cluster-level changes (such
+        as create index, update mapping, allocate or fail shard) that have not yet taken
+        effect. NOTE: This API returns a list of any pending updates to the cluster state.
+        These are distinct from the tasks reported by the task management API which include
+        periodic tasks and tasks initiated by the user, such as node stats, search queries,
+        or create index requests. However, if a user-initiated task such as a create
+        index command causes a cluster state update, the activity of this task might
+        be reported by both task api and pending cluster tasks API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-pending.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-pending.html>`_
 
         :param local: If `true`, the request retrieves information from the local node
             only. If `false`, information is retrieved from the master node.
@@ -623,9 +631,35 @@ class ClusterClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the cluster voting config exclusions by node ids or node names.
+        Update voting configuration exclusions. Update the cluster voting config exclusions
+        by node IDs or node names. By default, if there are more than three master-eligible
+        nodes in the cluster and you remove fewer than half of the master-eligible nodes
+        in the cluster at once, the voting configuration automatically shrinks. If you
+        want to shrink the voting configuration to contain fewer than three nodes or
+        to remove half or more of the master-eligible nodes in the cluster at once, use
+        this API to remove departing nodes from the voting configuration manually. The
+        API adds an entry for each specified node to the cluster’s voting configuration
+        exclusions list. It then waits until the cluster has reconfigured its voting
+        configuration to exclude the specified nodes. Clusters should have no voting
+        configuration exclusions in normal operation. Once the excluded nodes have stopped,
+        clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`.
+        This API waits for the nodes to be fully removed from the cluster before it returns.
+        If your cluster has voting configuration exclusions for nodes that you no longer
+        intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false`
+        to clear the voting configuration exclusions without waiting for the nodes to
+        leave the cluster. A response to `POST /_cluster/voting_config_exclusions` with
+        an HTTP status code of 200 OK guarantees that the node has been removed from
+        the voting configuration and will not be reinstated until the voting configuration
+        exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`.
+        If the call to `POST /_cluster/voting_config_exclusions` fails or returns a response
+        with an HTTP status code other than 200 OK then the node may not have been removed
+        from the voting configuration. In that case, you may safely retry the call. NOTE:
+        Voting exclusions are required only when you remove at least half of the master-eligible
+        nodes from a cluster in a short time period. They are not required when removing
+        master-ineligible nodes or when removing fewer than half of the master-eligible
+        nodes.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/voting-config-exclusions.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/voting-config-exclusions.html>`_
 
         :param node_ids: A comma-separated list of the persistent ids of the nodes to
             exclude from the voting configuration. If specified, you may not also specify
@@ -700,7 +734,7 @@ class ClusterClient(NamespacedClient):
         You can include comments anywhere in the request body except before the opening
         curly bracket.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-component-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html>`_
 
         :param name: Name of the component template to create. Elasticsearch includes
             the following built-in component templates: `logs-mappings`; `logs-settings`;
@@ -787,9 +821,28 @@ class ClusterClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the cluster settings.
+        Update the cluster settings. Configure and update dynamic settings on a running
+        cluster. You can also configure dynamic settings locally on an unstarted or shut
+        down node in `elasticsearch.yml`. Updates made with this API can be persistent,
+        which apply across cluster restarts, or transient, which reset after a cluster
+        restart. You can also reset transient or persistent settings by assigning them
+        a null value. If you configure the same setting using multiple methods, Elasticsearch
+        applies the settings in following order of precedence: 1) Transient setting;
+        2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value.
+        For example, you can apply a transient setting to override a persistent setting
+        or `elasticsearch.yml` setting. However, a change to an `elasticsearch.yml` setting
+        will not override a defined transient or persistent setting. TIP: In Elastic
+        Cloud, use the user settings feature to configure all cluster settings. This
+        method automatically rejects unsafe settings that could break your cluster. If
+        you run Elasticsearch on your own hardware, use this API to configure dynamic
+        cluster settings. Only use `elasticsearch.yml` for static cluster settings and
+        node settings. The API doesn’t require a restart and ensures a setting’s value
+        is the same on all nodes. WARNING: Transient cluster settings are no longer recommended.
+        Use persistent cluster settings instead. If a cluster becomes unstable, transient
+        settings can clear unexpectedly, resulting in a potentially undesired cluster
+        configuration.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-update-settings.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-update-settings.html>`_
 
         :param flat_settings: Return settings in flat format (default: false)
         :param master_timeout: Explicit operation timeout for connection to master node
@@ -841,11 +894,11 @@ class ClusterClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        The cluster remote info API allows you to retrieve all of the configured remote
-        cluster information. It returns connection and endpoint information keyed by
-        the configured remote cluster alias.
+        Get remote cluster information. Get all of the configured remote cluster information.
+        This API returns connection and endpoint information keyed by the configured
+        remote cluster alias.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-remote-info.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-remote-info.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_remote/info"
@@ -888,15 +941,35 @@ class ClusterClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Allows to manually change the allocation of individual shards in the cluster.
+        Reroute the cluster. Manually change the allocation of individual shards in the
+        cluster. For example, a shard can be moved from one node to another explicitly,
+        an allocation can be canceled, and an unassigned shard can be explicitly allocated
+        to a specific node. It is important to note that after processing any reroute
+        commands Elasticsearch will perform rebalancing as normal (respecting the values
+        of settings such as `cluster.routing.rebalance.enable`) in order to remain in
+        a balanced state. For example, if the requested allocation includes moving a
+        shard from node1 to node2 then this may cause a shard to be moved from node2
+        back to node1 to even things out. The cluster can be set to disable allocations
+        using the `cluster.routing.allocation.enable` setting. If allocations are disabled
+        then the only allocations that will be performed are explicit ones given using
+        the reroute command, and consequent allocations due to rebalancing. The cluster
+        will attempt to allocate a shard a maximum of `index.allocation.max_retries`
+        times in a row (defaults to `5`), before giving up and leaving the shard unallocated.
+        This scenario can be caused by structural problems such as having an analyzer
+        which refers to a stopwords file which doesn’t exist on all nodes. Once the problem
+        has been corrected, allocation can be manually retried by calling the reroute
+        API with the `?retry_failed` URI query parameter, which will attempt a single
+        retry round for these shards.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-reroute.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-reroute.html>`_
 
         :param commands: Defines the commands to perform.
-        :param dry_run: If true, then the request simulates the operation only and returns
-            the resulting state.
+        :param dry_run: If true, then the request simulates the operation. It will calculate
+            the result of applying the commands to the current cluster state and return
+            the resulting cluster state after the commands (and rebalancing) have been
+            applied; it will not actually perform the requested changes.
         :param explain: If true, then the response contains an explanation of why the
-            commands can or cannot be executed.
+            commands can or cannot run.
         :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.
@@ -975,9 +1048,28 @@ class ClusterClient(NamespacedClient):
         wait_for_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns a comprehensive information about the state of the cluster.
+        Get the cluster state. Get comprehensive information about the state of the cluster.
+        The cluster state is an internal data structure which keeps track of a variety
+        of information needed by every node, including the identity and attributes of
+        the other nodes in the cluster; cluster-wide settings; index metadata, including
+        the mapping and settings for each index; the location and status of every shard
+        copy in the cluster. The elected master node ensures that every node in the cluster
+        has a copy of the same cluster state. This API lets you retrieve a representation
+        of this internal state for debugging or diagnostic purposes. You may need to
+        consult the Elasticsearch source code to determine the precise meaning of the
+        response. By default the API will route requests to the elected master node since
+        this node is the authoritative source of cluster states. You can also retrieve
+        the cluster state held on the node handling the API request by adding the `?local=true`
+        query parameter. Elasticsearch may need to expend significant effort to compute
+        a response to this API in larger clusters, and the response may comprise a very
+        large quantity of data. If you use this API repeatedly, your cluster may become
+        unstable. WARNING: The response is a representation of an internal data structure.
+        Its format is not subject to the same compatibility guarantees as other more
+        stable APIs and may change from version to version. Do not query this API using
+        external monitoring tools. Instead, obtain the information you require using
+        other more stable cluster APIs.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-state.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-state.html>`_
 
         :param metric: Limit the information returned to the specified metrics
         :param index: A comma-separated list of index names; use `_all` or empty string
@@ -1059,11 +1151,11 @@ class ClusterClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns cluster statistics. It returns basic index metrics (shard numbers, store
-        size, memory usage) and information about the current nodes that form the cluster
-        (number, roles, os, jvm versions, memory usage, cpu and installed plugins).
+        Get cluster statistics. Get basic index metrics (shard numbers, store size, memory
+        usage) and information about the current nodes that form the cluster (number,
+        roles, os, jvm versions, memory usage, cpu and installed plugins).
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-stats.html>`_
 
         :param node_id: Comma-separated list of node filters used to limit returned information.
             Defaults to all nodes in the cluster.

elasticsearch/_sync/client/connector.py

@@ -46,7 +46,7 @@ class ConnectorClient(NamespacedClient):
         Check in a connector. Update the `last_seen` field in the connector and set it
         to the current timestamp.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/check-in-connector-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/check-in-connector-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be checked in
         """
@@ -91,7 +91,7 @@ class ConnectorClient(NamespacedClient):
         ingest pipelines, or data indices associated with the connector. These need to
         be removed manually.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be deleted
         :param delete_sync_jobs: A flag indicating if associated sync jobs should be
@@ -136,7 +136,7 @@ class ConnectorClient(NamespacedClient):
         """
         Get a connector. Get the details about a connector.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-api.html>`_
 
         :param connector_id: The unique identifier of the connector
         """
@@ -232,7 +232,7 @@ class ConnectorClient(NamespacedClient):
         Update the connector last sync stats. Update the fields related to the last sync
         of a connector. This action is used for analytics and monitoring.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-last-sync-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-last-sync-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param last_access_control_sync_error:
@@ -327,7 +327,7 @@ class ConnectorClient(NamespacedClient):
         """
         Get all connectors. Get information about all connectors.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-api.html>`_
 
         :param connector_name: A comma-separated list of connector names to fetch connector
             documents for
@@ -406,7 +406,7 @@ class ConnectorClient(NamespacedClient):
         a managed service on Elastic Cloud. Self-managed connectors (Connector clients)
         are self-managed on your infrastructure.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html>`_
 
         :param description:
         :param index_name:
@@ -485,7 +485,7 @@ class ConnectorClient(NamespacedClient):
         """
         Create or update a connector.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be created or
             updated. ID is auto-generated if not provided.
@@ -558,7 +558,7 @@ class ConnectorClient(NamespacedClient):
         connector service is then responsible for setting the status of connector sync
         jobs to cancelled.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cancel-connector-sync-job-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cancel-connector-sync-job-api.html>`_
 
         :param connector_sync_job_id: The unique identifier of the connector sync job
         """
@@ -604,7 +604,7 @@ class ConnectorClient(NamespacedClient):
         Delete a connector sync job. Remove a connector sync job and its associated data.
         This is a destructive action that is not recoverable.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-sync-job-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-sync-job-api.html>`_
 
         :param connector_sync_job_id: The unique identifier of the connector sync job
             to be deleted
@@ -648,7 +648,7 @@ class ConnectorClient(NamespacedClient):
         """
         Get a connector sync job.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-sync-job-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-sync-job-api.html>`_
 
         :param connector_sync_job_id: The unique identifier of the connector sync job
         """
@@ -718,7 +718,7 @@ class ConnectorClient(NamespacedClient):
         Get all connector sync jobs. Get information about all stored connector sync
         jobs listed by their creation date in ascending order.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-sync-jobs-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-sync-jobs-api.html>`_
 
         :param connector_id: A connector id to fetch connector sync jobs for
         :param from_: Starting offset (default: 0)
@@ -781,7 +781,7 @@ class ConnectorClient(NamespacedClient):
         Create a connector sync job. Create a connector sync job document in the internal
         index and initialize its counters and timestamps with default values.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-sync-job-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-sync-job-api.html>`_
 
         :param id: The id of the associated connector
         :param job_type:
@@ -834,7 +834,7 @@ class ConnectorClient(NamespacedClient):
         Activate the connector draft filter. Activates the valid draft filtering for
         a connector.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         """
@@ -884,7 +884,7 @@ class ConnectorClient(NamespacedClient):
         secret ID is required only for Elastic managed (native) connectors. Self-managed
         connectors (connector clients) do not use this field.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-api-key-id-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-api-key-id-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param api_key_id:
@@ -940,7 +940,7 @@ class ConnectorClient(NamespacedClient):
         Update the connector configuration. Update the configuration field in the connector
         document.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-configuration-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-configuration-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param configuration:
@@ -997,7 +997,7 @@ class ConnectorClient(NamespacedClient):
         to error. Otherwise, if the error is reset to null, the connector status is updated
         to connected.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-error-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-error-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param error:
@@ -1055,7 +1055,7 @@ class ConnectorClient(NamespacedClient):
         is activated once validated by the running Elastic connector service. The filtering
         property is used to configure sync rules (both basic and advanced) for a connector.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param advanced_snippet:
@@ -1113,7 +1113,7 @@ class ConnectorClient(NamespacedClient):
         Update the connector draft filtering validation. Update the draft filtering validation
         info for a connector.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-validation-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-validation-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param validation:
@@ -1167,7 +1167,7 @@ class ConnectorClient(NamespacedClient):
         Update the connector index name. Update the `index_name` field of a connector,
         specifying the index where the data ingested by the connector is stored.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-index-name-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-index-name-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param index_name:
@@ -1221,7 +1221,7 @@ class ConnectorClient(NamespacedClient):
         """
         Update the connector name and description.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-name-description-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-name-description-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param description:
@@ -1275,7 +1275,7 @@ class ConnectorClient(NamespacedClient):
         """
         Update the connector is_native flag.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-native-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-native-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param is_native:
@@ -1329,7 +1329,7 @@ class ConnectorClient(NamespacedClient):
         Update the connector pipeline. When you create a new connector, the configuration
         of an ingest pipeline is populated with default settings.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-pipeline-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-pipeline-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param pipeline:
@@ -1382,7 +1382,7 @@ class ConnectorClient(NamespacedClient):
         """
         Update the connector scheduling.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-scheduling-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-scheduling-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param scheduling:
@@ -1435,7 +1435,7 @@ class ConnectorClient(NamespacedClient):
         """
         Update the connector service type.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-service-type-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-service-type-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param service_type:
@@ -1495,7 +1495,7 @@ class ConnectorClient(NamespacedClient):
         """
         Update the connector status.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-status-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-status-api.html>`_
 
         :param connector_id: The unique identifier of the connector to be updated
         :param status:

elasticsearch/_sync/client/dangling_indices.py

@@ -44,7 +44,7 @@ class DanglingIndicesClient(NamespacedClient):
         For example, this can happen if you delete more than `cluster.indices.tombstones.size`
         indices while an Elasticsearch node is offline.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-gateway-dangling-indices.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-gateway-dangling-indices.html>`_
 
         :param index_uuid: The UUID of the index to delete. Use the get dangling indices
             API to find the UUID.
@@ -103,7 +103,7 @@ class DanglingIndicesClient(NamespacedClient):
         For example, this can happen if you delete more than `cluster.indices.tombstones.size`
         indices while an Elasticsearch node is offline.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-gateway-dangling-indices.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-gateway-dangling-indices.html>`_
 
         :param index_uuid: The UUID of the index to import. Use the get dangling indices
             API to locate the UUID.
@@ -162,7 +162,7 @@ class DanglingIndicesClient(NamespacedClient):
         indices while an Elasticsearch node is offline. Use this API to list dangling
         indices, which you can then import or delete.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-gateway-dangling-indices.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-gateway-dangling-indices.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_dangling"

elasticsearch/_sync/client/enrich.py

@@ -38,7 +38,7 @@ class EnrichClient(NamespacedClient):
         """
         Delete an enrich policy. Deletes an existing enrich policy and its enrich index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-enrich-policy-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-enrich-policy-api.html>`_
 
         :param name: Enrich policy to delete.
         """
@@ -77,9 +77,9 @@ class EnrichClient(NamespacedClient):
         wait_for_completion: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates the enrich index for an existing enrich policy.
+        Run an enrich policy. Create the enrich index for an existing enrich policy.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/execute-enrich-policy-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/execute-enrich-policy-api.html>`_
 
         :param name: Enrich policy to execute.
         :param wait_for_completion: If `true`, the request blocks other enrich policy
@@ -123,7 +123,7 @@ class EnrichClient(NamespacedClient):
         """
         Get an enrich policy. Returns information about an enrich policy.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-enrich-policy-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-enrich-policy-api.html>`_
 
         :param name: Comma-separated list of enrich policy names used to limit the request.
             To return information for all enrich policies, omit this parameter.
@@ -173,7 +173,7 @@ class EnrichClient(NamespacedClient):
         """
         Create an enrich policy. Creates an enrich policy.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-enrich-policy-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-enrich-policy-api.html>`_
 
         :param name: Name of the enrich policy to create or update.
         :param geo_match: Matches enrich data to incoming documents based on a `geo_shape`
@@ -227,7 +227,7 @@ class EnrichClient(NamespacedClient):
         Get enrich stats. Returns enrich coordinator statistics and information about
         enrich policies that are currently executing.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/enrich-stats-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/enrich-stats-api.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_enrich/_stats"