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

elasticsearch/_async/client/connector.py

@@ -20,12 +20,19 @@ import typing as t
 from elastic_transport import ObjectApiResponse
 
 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 ConnectorClient(NamespacedClient):
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def check_in(
         self,
         *,
@@ -36,9 +43,10 @@ class ConnectorClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the last_seen field in the connector, and sets it to current timestamp
+        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.15/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
         """
@@ -66,6 +74,7 @@ class ConnectorClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.BETA)
     async def delete(
         self,
         *,
@@ -77,9 +86,12 @@ class ConnectorClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes a connector.
+        Delete a connector. Removes a connector and associated sync jobs. This is a destructive
+        action that is not recoverable. NOTE: This action doesn’t delete any API keys,
+        ingest pipelines, or data indices associated with the connector. These need to
+        be removed manually.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
@@ -111,6 +123,7 @@ class ConnectorClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.BETA)
     async def get(
         self,
         *,
@@ -121,9 +134,9 @@ class ConnectorClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves a connector.
+        Get a connector. Get the details about a connector.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
         """
@@ -166,6 +179,7 @@ class ConnectorClient(NamespacedClient):
             "sync_cursor",
         ),
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def last_sync(
         self,
         *,
@@ -215,9 +229,10 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates last sync stats in the connector document
+        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.15/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:
@@ -294,6 +309,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         parameter_aliases={"from": "from_"},
     )
+    @_stability_warning(Stability.BETA)
     async def list(
         self,
         *,
@@ -309,9 +325,9 @@ class ConnectorClient(NamespacedClient):
         size: t.Optional[int] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns existing connectors.
+        Get all connectors. Get information about all connectors.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
@@ -367,6 +383,7 @@ class ConnectorClient(NamespacedClient):
             "service_type",
         ),
     )
+    @_stability_warning(Stability.BETA)
     async def post(
         self,
         *,
@@ -383,9 +400,13 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates a connector.
+        Create a connector. Connectors are Elasticsearch integrations that bring content
+        from third-party data sources, which can be deployed on Elastic Cloud or hosted
+        on your own infrastructure. Elastic managed connectors (Native connectors) are
+        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.15/create-connector-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html>`_
 
         :param description:
         :param index_name:
@@ -444,6 +465,7 @@ class ConnectorClient(NamespacedClient):
             "service_type",
         ),
     )
+    @_stability_warning(Stability.BETA)
     async def put(
         self,
         *,
@@ -461,9 +483,9 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates or updates a connector.
+        Create or update a connector.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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.
@@ -520,6 +542,7 @@ class ConnectorClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.BETA)
     async def sync_job_cancel(
         self,
         *,
@@ -530,9 +553,12 @@ class ConnectorClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Cancels a connector sync job.
+        Cancel a connector sync job. Cancel a connector sync job, which sets the status
+        to cancelling and updates `cancellation_requested_at` to the current time. The
+        connector service is then responsible for setting the status of connector sync
+        jobs to cancelled.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
         """
@@ -564,6 +590,7 @@ class ConnectorClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.BETA)
     async def sync_job_delete(
         self,
         *,
@@ -574,9 +601,10 @@ class ConnectorClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes a connector sync job.
+        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.15/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
@@ -607,6 +635,7 @@ class ConnectorClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.BETA)
     async def sync_job_get(
         self,
         *,
@@ -617,9 +646,9 @@ class ConnectorClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves a connector sync job.
+        Get a connector sync job.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
         """
@@ -651,6 +680,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         parameter_aliases={"from": "from_"},
     )
+    @_stability_warning(Stability.BETA)
     async def sync_job_list(
         self,
         *,
@@ -685,9 +715,10 @@ class ConnectorClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Lists connector sync jobs.
+        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.15/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)
@@ -729,6 +760,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("id", "job_type", "trigger_method"),
     )
+    @_stability_warning(Stability.BETA)
     async def sync_job_post(
         self,
         *,
@@ -746,9 +778,10 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates a connector sync job.
+        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.15/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:
@@ -787,6 +820,7 @@ class ConnectorClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def update_active_filtering(
         self,
         *,
@@ -797,9 +831,10 @@ class ConnectorClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Activates the valid draft filtering for a connector.
+        Activate the connector draft filter. Activates the valid draft filtering for
+        a connector.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
         """
@@ -829,6 +864,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("api_key_id", "api_key_secret_id"),
     )
+    @_stability_warning(Stability.BETA)
     async def update_api_key_id(
         self,
         *,
@@ -842,9 +878,13 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the API key id in the connector document
+        Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id`
+        fields of a connector. You can specify the ID of the API key used for authorization
+        and the ID of the connector secret where the API key is stored. The connector
+        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.15/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:
@@ -883,6 +923,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("configuration", "values"),
     )
+    @_stability_warning(Stability.BETA)
     async def update_configuration(
         self,
         *,
@@ -896,9 +937,10 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the configuration field in the connector document
+        Update the connector configuration. Update the configuration field in the connector
+        document.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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:
@@ -937,6 +979,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("error",),
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def update_error(
         self,
         *,
@@ -949,9 +992,12 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the filtering field in the connector document
+        Update the connector error field. Set the error field for the connector. If the
+        error provided in the request body is non-null, the connector’s status is updated
+        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.15/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:
@@ -989,6 +1035,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("advanced_snippet", "filtering", "rules"),
     )
+    @_stability_warning(Stability.BETA)
     async def update_filtering(
         self,
         *,
@@ -1003,9 +1050,12 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the filtering field in the connector document
+        Update the connector filtering. Update the draft filtering configuration of a
+        connector and marks the draft validation state as edited. The filtering draft
+        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.15/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:
@@ -1047,6 +1097,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("validation",),
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def update_filtering_validation(
         self,
         *,
@@ -1059,9 +1110,10 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the draft filtering validation info for a connector.
+        Update the connector draft filtering validation. Update the draft filtering validation
+        info for a connector.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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:
@@ -1099,6 +1151,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("index_name",),
     )
+    @_stability_warning(Stability.BETA)
     async def update_index_name(
         self,
         *,
@@ -1111,9 +1164,10 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the index_name in the connector document
+        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.15/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:
@@ -1151,6 +1205,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("description", "name"),
     )
+    @_stability_warning(Stability.BETA)
     async def update_name(
         self,
         *,
@@ -1164,9 +1219,9 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the name and description fields in the connector document
+        Update the connector name and description.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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:
@@ -1205,6 +1260,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("is_native",),
     )
+    @_stability_warning(Stability.BETA)
     async def update_native(
         self,
         *,
@@ -1217,9 +1273,9 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the is_native flag in the connector document
+        Update the connector is_native flag.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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:
@@ -1257,6 +1313,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("pipeline",),
     )
+    @_stability_warning(Stability.BETA)
     async def update_pipeline(
         self,
         *,
@@ -1269,9 +1326,10 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the pipeline field in the connector document
+        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.15/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:
@@ -1309,6 +1367,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("scheduling",),
     )
+    @_stability_warning(Stability.BETA)
     async def update_scheduling(
         self,
         *,
@@ -1321,9 +1380,9 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the scheduling field in the connector document
+        Update the connector scheduling.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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:
@@ -1361,6 +1420,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("service_type",),
     )
+    @_stability_warning(Stability.BETA)
     async def update_service_type(
         self,
         *,
@@ -1373,9 +1433,9 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the service type of the connector
+        Update the connector service type.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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:
@@ -1413,6 +1473,7 @@ class ConnectorClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("status",),
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def update_status(
         self,
         *,
@@ -1432,9 +1493,9 @@ class ConnectorClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the status of the connector
+        Update the connector status.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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/_async/client/dangling_indices.py

@@ -39,13 +39,17 @@ class DanglingIndicesClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes the specified dangling index
+        Delete a dangling index. If Elasticsearch encounters index data that is absent
+        from the current cluster state, those indices are considered to be dangling.
+        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.15/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 dangling index
-        :param accept_data_loss: Must be set to true in order to delete the dangling
-            index
+        :param index_uuid: The UUID of the index to delete. Use the get dangling indices
+            API to find the UUID.
+        :param accept_data_loss: This parameter must be set to true to acknowledge that
+            it will no longer be possible to recove data from the dangling index.
         :param master_timeout: Specify timeout for connection to master
         :param timeout: Explicit operation timeout
         """
@@ -94,13 +98,20 @@ class DanglingIndicesClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Imports the specified dangling index
+        Import a dangling index. If Elasticsearch encounters index data that is absent
+        from the current cluster state, those indices are considered to be dangling.
+        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.15/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 dangling index
-        :param accept_data_loss: Must be set to true in order to import the dangling
-            index
+        :param index_uuid: The UUID of the index to import. Use the get dangling indices
+            API to locate the UUID.
+        :param accept_data_loss: This parameter must be set to true to import a dangling
+            index. Because Elasticsearch cannot know where the dangling index data came
+            from or determine which shard copies are fresh and which are stale, it cannot
+            guarantee that the imported data represents the latest state of the index
+            when it was last in the cluster.
         :param master_timeout: Specify timeout for connection to master
         :param timeout: Explicit operation timeout
         """
@@ -145,9 +156,13 @@ class DanglingIndicesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns all dangling indices.
+        Get the dangling indices. If Elasticsearch encounters index data that is absent
+        from the current cluster state, those indices are considered to be dangling.
+        For example, this can happen if you delete more than `cluster.indices.tombstones.size`
+        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.15/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/_async/client/enrich.py

@@ -36,9 +36,9 @@ class EnrichClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes an existing enrich policy and its enrich index.
+        Delete an enrich policy. Deletes an existing enrich policy and its enrich index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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.15/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
@@ -121,9 +121,9 @@ class EnrichClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns information about an enrich policy.
+        Get an enrich policy. Returns information about an enrich policy.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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.
@@ -171,9 +171,9 @@ class EnrichClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates an enrich policy.
+        Create an enrich policy. Creates an enrich policy.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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`
@@ -224,10 +224,10 @@ class EnrichClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns enrich coordinator statistics and information about enrich policies that
-        are currently executing.
+        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.15/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"