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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. elasticsearch/__init__.py +2 -2
  2. elasticsearch/_async/client/__init__.py +2034 -740
  3. elasticsearch/_async/client/async_search.py +33 -22
  4. elasticsearch/_async/client/autoscaling.py +27 -21
  5. elasticsearch/_async/client/cat.py +280 -336
  6. elasticsearch/_async/client/ccr.py +96 -70
  7. elasticsearch/_async/client/cluster.py +152 -144
  8. elasticsearch/_async/client/connector.py +488 -55
  9. elasticsearch/_async/client/dangling_indices.py +22 -16
  10. elasticsearch/_async/client/enrich.py +25 -6
  11. elasticsearch/_async/client/eql.py +22 -9
  12. elasticsearch/_async/client/esql.py +295 -3
  13. elasticsearch/_async/client/features.py +25 -25
  14. elasticsearch/_async/client/fleet.py +15 -9
  15. elasticsearch/_async/client/graph.py +9 -8
  16. elasticsearch/_async/client/ilm.py +91 -61
  17. elasticsearch/_async/client/indices.py +746 -324
  18. elasticsearch/_async/client/inference.py +101 -4
  19. elasticsearch/_async/client/ingest.py +231 -19
  20. elasticsearch/_async/client/license.py +48 -31
  21. elasticsearch/_async/client/logstash.py +20 -6
  22. elasticsearch/_async/client/migration.py +25 -7
  23. elasticsearch/_async/client/ml.py +532 -278
  24. elasticsearch/_async/client/monitoring.py +5 -1
  25. elasticsearch/_async/client/nodes.py +46 -30
  26. elasticsearch/_async/client/query_rules.py +65 -18
  27. elasticsearch/_async/client/rollup.py +126 -13
  28. elasticsearch/_async/client/search_application.py +170 -13
  29. elasticsearch/_async/client/searchable_snapshots.py +45 -23
  30. elasticsearch/_async/client/security.py +1299 -340
  31. elasticsearch/_async/client/shutdown.py +43 -15
  32. elasticsearch/_async/client/simulate.py +145 -0
  33. elasticsearch/_async/client/slm.py +163 -19
  34. elasticsearch/_async/client/snapshot.py +288 -23
  35. elasticsearch/_async/client/sql.py +94 -53
  36. elasticsearch/_async/client/ssl.py +16 -17
  37. elasticsearch/_async/client/synonyms.py +67 -26
  38. elasticsearch/_async/client/tasks.py +103 -28
  39. elasticsearch/_async/client/text_structure.py +475 -46
  40. elasticsearch/_async/client/transform.py +108 -72
  41. elasticsearch/_async/client/watcher.py +245 -43
  42. elasticsearch/_async/client/xpack.py +20 -6
  43. elasticsearch/_async/helpers.py +1 -1
  44. elasticsearch/_sync/client/__init__.py +2034 -740
  45. elasticsearch/_sync/client/async_search.py +33 -22
  46. elasticsearch/_sync/client/autoscaling.py +27 -21
  47. elasticsearch/_sync/client/cat.py +280 -336
  48. elasticsearch/_sync/client/ccr.py +96 -70
  49. elasticsearch/_sync/client/cluster.py +152 -144
  50. elasticsearch/_sync/client/connector.py +488 -55
  51. elasticsearch/_sync/client/dangling_indices.py +22 -16
  52. elasticsearch/_sync/client/enrich.py +25 -6
  53. elasticsearch/_sync/client/eql.py +22 -9
  54. elasticsearch/_sync/client/esql.py +295 -3
  55. elasticsearch/_sync/client/features.py +25 -25
  56. elasticsearch/_sync/client/fleet.py +15 -9
  57. elasticsearch/_sync/client/graph.py +9 -8
  58. elasticsearch/_sync/client/ilm.py +91 -61
  59. elasticsearch/_sync/client/indices.py +746 -324
  60. elasticsearch/_sync/client/inference.py +101 -4
  61. elasticsearch/_sync/client/ingest.py +231 -19
  62. elasticsearch/_sync/client/license.py +48 -31
  63. elasticsearch/_sync/client/logstash.py +20 -6
  64. elasticsearch/_sync/client/migration.py +25 -7
  65. elasticsearch/_sync/client/ml.py +532 -278
  66. elasticsearch/_sync/client/monitoring.py +5 -1
  67. elasticsearch/_sync/client/nodes.py +46 -30
  68. elasticsearch/_sync/client/query_rules.py +65 -18
  69. elasticsearch/_sync/client/rollup.py +126 -13
  70. elasticsearch/_sync/client/search_application.py +170 -13
  71. elasticsearch/_sync/client/searchable_snapshots.py +45 -23
  72. elasticsearch/_sync/client/security.py +1299 -340
  73. elasticsearch/_sync/client/shutdown.py +43 -15
  74. elasticsearch/_sync/client/simulate.py +145 -0
  75. elasticsearch/_sync/client/slm.py +163 -19
  76. elasticsearch/_sync/client/snapshot.py +288 -23
  77. elasticsearch/_sync/client/sql.py +94 -53
  78. elasticsearch/_sync/client/ssl.py +16 -17
  79. elasticsearch/_sync/client/synonyms.py +67 -26
  80. elasticsearch/_sync/client/tasks.py +103 -28
  81. elasticsearch/_sync/client/text_structure.py +475 -46
  82. elasticsearch/_sync/client/transform.py +108 -72
  83. elasticsearch/_sync/client/utils.py +1 -1
  84. elasticsearch/_sync/client/watcher.py +245 -43
  85. elasticsearch/_sync/client/xpack.py +20 -6
  86. elasticsearch/_version.py +1 -1
  87. elasticsearch/client.py +4 -0
  88. elasticsearch/helpers/actions.py +1 -1
  89. elasticsearch/helpers/vectorstore/_sync/vectorstore.py +4 -1
  90. {elasticsearch-8.17.0.dist-info → elasticsearch-8.17.2.dist-info}/METADATA +1 -1
  91. elasticsearch-8.17.2.dist-info/RECORD +119 -0
  92. elasticsearch-8.17.0.dist-info/RECORD +0 -117
  93. {elasticsearch-8.17.0.dist-info → elasticsearch-8.17.2.dist-info}/WHEEL +0 -0
  94. {elasticsearch-8.17.0.dist-info → elasticsearch-8.17.2.dist-info}/licenses/LICENSE +0 -0
  95. {elasticsearch-8.17.0.dist-info → elasticsearch-8.17.2.dist-info}/licenses/NOTICE +0 -0
@@ -55,8 +55,11 @@ class IndicesClient(NamespacedClient):
55
55
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
56
56
  ) -> ObjectApiResponse[t.Any]:
57
57
  """
58
- Add an index block. Limits the operations allowed on an index by blocking specific
59
- operation types.
58
+ .. raw:: html
59
+
60
+ <p>Add an index block.
61
+ Limits the operations allowed on an index by blocking specific operation types.</p>
62
+
60
63
 
61
64
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index-modules-blocks.html>`_
62
65
 
@@ -143,8 +146,15 @@ class IndicesClient(NamespacedClient):
143
146
  body: t.Optional[t.Dict[str, t.Any]] = None,
144
147
  ) -> ObjectApiResponse[t.Any]:
145
148
  """
146
- Get tokens from text analysis. The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html)
147
- on a text string and returns the resulting tokens.
149
+ .. raw:: html
150
+
151
+ <p>Get tokens from text analysis.
152
+ The analyze API performs analysis on a text string and returns the resulting tokens.</p>
153
+ <p>Generating excessive amount of tokens may cause a node to run out of memory.
154
+ The <code>index.analyze.max_token_count</code> setting enables you to limit the number of tokens that can be produced.
155
+ If more than this limit of tokens gets generated, an error occurs.
156
+ The <code>_analyze</code> endpoint without a specified index will always use <code>10000</code> as its limit.</p>
157
+
148
158
 
149
159
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-analyze.html>`_
150
160
 
@@ -245,8 +255,15 @@ class IndicesClient(NamespacedClient):
245
255
  request: t.Optional[bool] = None,
246
256
  ) -> ObjectApiResponse[t.Any]:
247
257
  """
248
- Clear the cache. Clear the cache of one or more indices. For data streams, the
249
- API clears the caches of the stream's backing indices.
258
+ .. raw:: html
259
+
260
+ <p>Clear the cache.
261
+ Clear the cache of one or more indices.
262
+ For data streams, the API clears the caches of the stream's backing indices.</p>
263
+ <p>By default, the clear cache API clears all caches.
264
+ To clear only specific caches, use the <code>fielddata</code>, <code>query</code>, or <code>request</code> parameters.
265
+ To clear the cache only of specific fields, use the <code>fields</code> parameter.</p>
266
+
250
267
 
251
268
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-clearcache.html>`_
252
269
 
@@ -331,26 +348,44 @@ class IndicesClient(NamespacedClient):
331
348
  body: t.Optional[t.Dict[str, t.Any]] = None,
332
349
  ) -> ObjectApiResponse[t.Any]:
333
350
  """
334
- Clone an index. Clone an existing index into a new index. Each original primary
335
- shard is cloned into a new primary shard in the new index. IMPORTANT: Elasticsearch
336
- does not apply index templates to the resulting index. The API also does not
337
- copy index metadata from the original index. Index metadata includes aliases,
338
- index lifecycle management phase definitions, and cross-cluster replication (CCR)
339
- follower information. For example, if you clone a CCR follower index, the resulting
340
- clone will not be a follower index. The clone API copies most index settings
341
- from the source index to the resulting index, with the exception of `index.number_of_replicas`
342
- and `index.auto_expand_replicas`. To set the number of replicas in the resulting
343
- index, configure these settings in the clone request. Cloning works as follows:
344
- * First, it creates a new target index with the same definition as the source
345
- index. * Then it hard-links segments from the source index into the target index.
346
- If the file system does not support hard-linking, all segments are copied into
347
- the new index, which is a much more time consuming process. * Finally, it recovers
348
- the target index as though it were a closed index which had just been re-opened.
349
- IMPORTANT: Indices can only be cloned if they meet the following requirements:
350
- * The target index must not exist. * The source index must have the same number
351
- of primary shards as the target index. * The node handling the clone process
352
- must have sufficient free disk space to accommodate a second copy of the existing
353
- index.
351
+ .. raw:: html
352
+
353
+ <p>Clone an index.
354
+ Clone an existing index into a new index.
355
+ Each original primary shard is cloned into a new primary shard in the new index.</p>
356
+ <p>IMPORTANT: Elasticsearch does not apply index templates to the resulting index.
357
+ The API also does not copy index metadata from the original index.
358
+ Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information.
359
+ For example, if you clone a CCR follower index, the resulting clone will not be a follower index.</p>
360
+ <p>The clone API copies most index settings from the source index to the resulting index, with the exception of <code>index.number_of_replicas</code> and <code>index.auto_expand_replicas</code>.
361
+ To set the number of replicas in the resulting index, configure these settings in the clone request.</p>
362
+ <p>Cloning works as follows:</p>
363
+ <ul>
364
+ <li>First, it creates a new target index with the same definition as the source index.</li>
365
+ <li>Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.</li>
366
+ <li>Finally, it recovers the target index as though it were a closed index which had just been re-opened.</li>
367
+ </ul>
368
+ <p>IMPORTANT: Indices can only be cloned if they meet the following requirements:</p>
369
+ <ul>
370
+ <li>The index must be marked as read-only and have a cluster health status of green.</li>
371
+ <li>The target index must not exist.</li>
372
+ <li>The source index must have the same number of primary shards as the target index.</li>
373
+ <li>The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.</li>
374
+ </ul>
375
+ <p>The current write index on a data stream cannot be cloned.
376
+ In order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned.</p>
377
+ <p>NOTE: Mappings cannot be specified in the <code>_clone</code> request. The mappings of the source index will be used for the target index.</p>
378
+ <p><strong>Monitor the cloning process</strong></p>
379
+ <p>The cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the <code>wait_for_status</code> parameter to <code>yellow</code>.</p>
380
+ <p>The <code>_clone</code> API returns as soon as the target index has been added to the cluster state, before any shards have been allocated.
381
+ At this point, all shards are in the state unassigned.
382
+ If, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node.</p>
383
+ <p>Once the primary shard is allocated, it moves to state initializing, and the clone process begins.
384
+ When the clone operation completes, the shard will become active.
385
+ At that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node.</p>
386
+ <p><strong>Wait for active shards</strong></p>
387
+ <p>Because the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well.</p>
388
+
354
389
 
355
390
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-clone-index.html>`_
356
391
 
@@ -438,24 +473,23 @@ class IndicesClient(NamespacedClient):
438
473
  ] = None,
439
474
  ) -> ObjectApiResponse[t.Any]:
440
475
  """
441
- Close an index. A closed index is blocked for read or write operations and does
442
- not allow all operations that opened indices allow. It is not possible to index
443
- documents or to search for documents in a closed index. Closed indices do not
444
- have to maintain internal data structures for indexing or searching documents,
445
- which results in a smaller overhead on the cluster. When opening or closing an
446
- index, the master node is responsible for restarting the index shards to reflect
447
- the new state of the index. The shards will then go through the normal recovery
448
- process. The data of opened and closed indices is automatically replicated by
449
- the cluster to ensure that enough shard copies are safely kept around at all
450
- times. You can open and close multiple indices. An error is thrown if the request
451
- explicitly refers to a missing index. This behaviour can be turned off using
452
- the `ignore_unavailable=true` parameter. By default, you must explicitly name
453
- the indices you are opening or closing. To open or close indices with `_all`,
454
- `*`, or other wildcard expressions, change the` action.destructive_requires_name`
455
- setting to `false`. This setting can also be changed with the cluster update
456
- settings API. Closed indices consume a significant amount of disk-space which
457
- can cause problems in managed environments. Closing indices can be turned off
458
- with the cluster settings API by setting `cluster.indices.close.enable` to `false`.
476
+ .. raw:: html
477
+
478
+ <p>Close an index.
479
+ A closed index is blocked for read or write operations and does not allow all operations that opened indices allow.
480
+ It is not possible to index documents or to search for documents in a closed index.
481
+ Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster.</p>
482
+ <p>When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index.
483
+ The shards will then go through the normal recovery process.
484
+ The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.</p>
485
+ <p>You can open and close multiple indices.
486
+ An error is thrown if the request explicitly refers to a missing index.
487
+ This behaviour can be turned off using the <code>ignore_unavailable=true</code> parameter.</p>
488
+ <p>By default, you must explicitly name the indices you are opening or closing.
489
+ To open or close indices with <code>_all</code>, <code>*</code>, or other wildcard expressions, change the<code> action.destructive_requires_name</code> setting to <code>false</code>. This setting can also be changed with the cluster update settings API.</p>
490
+ <p>Closed indices consume a significant amount of disk-space which can cause problems in managed environments.
491
+ Closing indices can be turned off with the cluster settings API by setting <code>cluster.indices.close.enable</code> to <code>false</code>.</p>
492
+
459
493
 
460
494
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-close.html>`_
461
495
 
@@ -536,7 +570,27 @@ class IndicesClient(NamespacedClient):
536
570
  body: t.Optional[t.Dict[str, t.Any]] = None,
537
571
  ) -> ObjectApiResponse[t.Any]:
538
572
  """
539
- Create an index. Creates a new index.
573
+ .. raw:: html
574
+
575
+ <p>Create an index.
576
+ You can use the create index API to add a new index to an Elasticsearch cluster.
577
+ When creating an index, you can specify the following:</p>
578
+ <ul>
579
+ <li>Settings for the index.</li>
580
+ <li>Mappings for fields in the index.</li>
581
+ <li>Index aliases</li>
582
+ </ul>
583
+ <p><strong>Wait for active shards</strong></p>
584
+ <p>By default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out.
585
+ The index creation response will indicate what happened.
586
+ For example, <code>acknowledged</code> indicates whether the index was successfully created in the cluster, <code>while shards_acknowledged</code> indicates whether the requisite number of shard copies were started for each shard in the index before timing out.
587
+ Note that it is still possible for either <code>acknowledged</code> or <code>shards_acknowledged</code> to be <code>false</code>, but for the index creation to be successful.
588
+ These values simply indicate whether the operation completed before the timeout.
589
+ If <code>acknowledged</code> is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon.
590
+ If <code>shards_acknowledged</code> is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, <code>acknowledged</code> is <code>true</code>).</p>
591
+ <p>You can change the default of only waiting for the primary shards to start through the index setting <code>index.write.wait_for_active_shards</code>.
592
+ Note that changing this setting will also affect the <code>wait_for_active_shards</code> value on all subsequent write operations.</p>
593
+
540
594
 
541
595
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-create-index.html>`_
542
596
 
@@ -609,8 +663,12 @@ class IndicesClient(NamespacedClient):
609
663
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
610
664
  ) -> ObjectApiResponse[t.Any]:
611
665
  """
612
- Create a data stream. Creates a data stream. You must have a matching index template
613
- with data stream enabled.
666
+ .. raw:: html
667
+
668
+ <p>Create a data stream.
669
+ Creates a data stream.
670
+ You must have a matching index template with data stream enabled.</p>
671
+
614
672
 
615
673
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
616
674
 
@@ -671,7 +729,11 @@ class IndicesClient(NamespacedClient):
671
729
  pretty: t.Optional[bool] = None,
672
730
  ) -> ObjectApiResponse[t.Any]:
673
731
  """
674
- Get data stream stats. Retrieves statistics for one or more data streams.
732
+ .. raw:: html
733
+
734
+ <p>Get data stream stats.
735
+ Retrieves statistics for one or more data streams.</p>
736
+
675
737
 
676
738
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
677
739
 
@@ -732,7 +794,15 @@ class IndicesClient(NamespacedClient):
732
794
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
733
795
  ) -> ObjectApiResponse[t.Any]:
734
796
  """
735
- Delete indices. Deletes one or more indices.
797
+ .. raw:: html
798
+
799
+ <p>Delete indices.
800
+ Deleting an index deletes its documents, shards, and metadata.
801
+ It does not delete related Kibana components, such as data views, visualizations, or dashboards.</p>
802
+ <p>You cannot delete the current write index of a data stream.
803
+ To delete the index, you must roll over the data stream so a new write index is created.
804
+ You can then use the delete index API to delete the previous write index.</p>
805
+
736
806
 
737
807
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-index.html>`_
738
808
 
@@ -802,9 +872,13 @@ class IndicesClient(NamespacedClient):
802
872
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
803
873
  ) -> ObjectApiResponse[t.Any]:
804
874
  """
805
- Delete an alias. Removes a data stream or index from an alias.
875
+ .. raw:: html
806
876
 
807
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-aliases.html>`_
877
+ <p>Delete an alias.
878
+ Removes a data stream or index from an alias.</p>
879
+
880
+
881
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-alias.html>`_
808
882
 
809
883
  :param index: Comma-separated list of data streams or indices used to limit the
810
884
  request. Supports wildcards (`*`).
@@ -866,8 +940,11 @@ class IndicesClient(NamespacedClient):
866
940
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
867
941
  ) -> ObjectApiResponse[t.Any]:
868
942
  """
869
- Delete data stream lifecycles. Removes the data stream lifecycle from a data
870
- stream, rendering it not managed by the data stream lifecycle.
943
+ .. raw:: html
944
+
945
+ <p>Delete data stream lifecycles.
946
+ Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.</p>
947
+
871
948
 
872
949
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams-delete-lifecycle.html>`_
873
950
 
@@ -927,7 +1004,11 @@ class IndicesClient(NamespacedClient):
927
1004
  pretty: t.Optional[bool] = None,
928
1005
  ) -> ObjectApiResponse[t.Any]:
929
1006
  """
930
- Delete data streams. Deletes one or more data streams and their backing indices.
1007
+ .. raw:: html
1008
+
1009
+ <p>Delete data streams.
1010
+ Deletes one or more data streams and their backing indices.</p>
1011
+
931
1012
 
932
1013
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
933
1014
 
@@ -979,10 +1060,13 @@ class IndicesClient(NamespacedClient):
979
1060
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
980
1061
  ) -> ObjectApiResponse[t.Any]:
981
1062
  """
982
- Delete an index template. The provided <index-template> may contain multiple
983
- template names separated by a comma. If multiple template names are specified
984
- then there is no wildcard support and the provided names should match completely
985
- with existing templates.
1063
+ .. raw:: html
1064
+
1065
+ <p>Delete an index template.
1066
+ The provided <!-- raw HTML omitted --> may contain multiple template names separated by a comma. If multiple template
1067
+ names are specified then there is no wildcard support and the provided names should match completely with
1068
+ existing templates.</p>
1069
+
986
1070
 
987
1071
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-template.html>`_
988
1072
 
@@ -1034,7 +1118,10 @@ class IndicesClient(NamespacedClient):
1034
1118
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1035
1119
  ) -> ObjectApiResponse[t.Any]:
1036
1120
  """
1037
- Deletes a legacy index template.
1121
+ .. raw:: html
1122
+
1123
+ <p>Delete a legacy index template.</p>
1124
+
1038
1125
 
1039
1126
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-template-v1.html>`_
1040
1127
 
@@ -1097,10 +1184,16 @@ class IndicesClient(NamespacedClient):
1097
1184
  run_expensive_tasks: t.Optional[bool] = None,
1098
1185
  ) -> ObjectApiResponse[t.Any]:
1099
1186
  """
1100
- Analyze the index disk usage. Analyze the disk usage of each field of an index
1101
- or data stream. This API might not support indices created in previous Elasticsearch
1102
- versions. The result of a small index can be inaccurate as some parts of an index
1103
- might not be analyzed by the API.
1187
+ .. raw:: html
1188
+
1189
+ <p>Analyze the index disk usage.
1190
+ Analyze the disk usage of each field of an index or data stream.
1191
+ This API might not support indices created in previous Elasticsearch versions.
1192
+ The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.</p>
1193
+ <p>NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index <code>store_size</code> value because some small metadata files are ignored and some parts of data files might not be scanned by the API.
1194
+ Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.
1195
+ The stored size of the <code>_id</code> field is likely underestimated while the <code>_source</code> field is overestimated.</p>
1196
+
1104
1197
 
1105
1198
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-disk-usage.html>`_
1106
1199
 
@@ -1174,14 +1267,16 @@ class IndicesClient(NamespacedClient):
1174
1267
  pretty: t.Optional[bool] = None,
1175
1268
  ) -> ObjectApiResponse[t.Any]:
1176
1269
  """
1177
- Downsample an index. Aggregate a time series (TSDS) index and store pre-computed
1178
- statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each
1179
- metric field grouped by a configured time interval. For example, a TSDS index
1180
- that contains metrics sampled every 10 seconds can be downsampled to an hourly
1181
- index. All documents within an hour interval are summarized and stored as a single
1182
- document in the downsample index. NOTE: Only indices in a time series data stream
1183
- are supported. Neither field nor document level security can be defined on the
1184
- source index. The source index must be read only (`index.blocks.write: true`).
1270
+ .. raw:: html
1271
+
1272
+ <p>Downsample an index.
1273
+ Aggregate a time series (TSDS) index and store pre-computed statistical summaries (<code>min</code>, <code>max</code>, <code>sum</code>, <code>value_count</code> and <code>avg</code>) for each metric field grouped by a configured time interval.
1274
+ For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.
1275
+ All documents within an hour interval are summarized and stored as a single document in the downsample index.</p>
1276
+ <p>NOTE: Only indices in a time series data stream are supported.
1277
+ Neither field nor document level security can be defined on the source index.
1278
+ The source index must be read only (<code>index.blocks.write: true</code>).</p>
1279
+
1185
1280
 
1186
1281
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-downsample-data-stream.html>`_
1187
1282
 
@@ -1249,8 +1344,11 @@ class IndicesClient(NamespacedClient):
1249
1344
  pretty: t.Optional[bool] = None,
1250
1345
  ) -> HeadApiResponse:
1251
1346
  """
1252
- Check indices. Checks if one or more indices, index aliases, or data streams
1253
- exist.
1347
+ .. raw:: html
1348
+
1349
+ <p>Check indices.
1350
+ Check if one or more indices, index aliases, or data streams exist.</p>
1351
+
1254
1352
 
1255
1353
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-exists.html>`_
1256
1354
 
@@ -1328,7 +1426,11 @@ class IndicesClient(NamespacedClient):
1328
1426
  pretty: t.Optional[bool] = None,
1329
1427
  ) -> HeadApiResponse:
1330
1428
  """
1331
- Check aliases. Checks if one or more data stream or index aliases exist.
1429
+ .. raw:: html
1430
+
1431
+ <p>Check aliases.
1432
+ Checks if one or more data stream or index aliases exist.</p>
1433
+
1332
1434
 
1333
1435
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-aliases.html>`_
1334
1436
 
@@ -1398,7 +1500,11 @@ class IndicesClient(NamespacedClient):
1398
1500
  pretty: t.Optional[bool] = None,
1399
1501
  ) -> HeadApiResponse:
1400
1502
  """
1401
- Check index templates. Check whether index templates exist.
1503
+ .. raw:: html
1504
+
1505
+ <p>Check index templates.
1506
+ Check whether index templates exist.</p>
1507
+
1402
1508
 
1403
1509
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index-templates.html>`_
1404
1510
 
@@ -1447,16 +1553,23 @@ class IndicesClient(NamespacedClient):
1447
1553
  pretty: t.Optional[bool] = None,
1448
1554
  ) -> HeadApiResponse:
1449
1555
  """
1450
- Check existence of index templates. Returns information about whether a particular
1451
- index template exists.
1556
+ .. raw:: html
1557
+
1558
+ <p>Check existence of index templates.
1559
+ Get information about whether index templates exist.
1560
+ Index templates define settings, mappings, and aliases that can be applied automatically to new indices.</p>
1561
+ <p>IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.</p>
1562
+
1452
1563
 
1453
1564
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-template-exists-v1.html>`_
1454
1565
 
1455
- :param name: The comma separated names of the index templates
1456
- :param flat_settings: Return settings in flat format (default: false)
1457
- :param local: Return local information, do not retrieve the state from master
1458
- node (default: false)
1459
- :param master_timeout: Explicit operation timeout for connection to master node
1566
+ :param name: A comma-separated list of index template names used to limit the
1567
+ request. Wildcard (`*`) expressions are supported.
1568
+ :param flat_settings: Indicates whether to use a flat format for the response.
1569
+ :param local: Indicates whether to get information from the local node only.
1570
+ :param master_timeout: The period to wait for the master node. If the master
1571
+ node is not available before the timeout expires, the request fails and returns
1572
+ an error. To indicate that the request should never timeout, set it to `-1`.
1460
1573
  """
1461
1574
  if name in SKIP_IN_PATH:
1462
1575
  raise ValueError("Empty value passed for parameter 'name'")
@@ -1500,10 +1613,11 @@ class IndicesClient(NamespacedClient):
1500
1613
  pretty: t.Optional[bool] = None,
1501
1614
  ) -> ObjectApiResponse[t.Any]:
1502
1615
  """
1503
- Get the status for a data stream lifecycle. Get information about an index or
1504
- data stream's current data stream lifecycle status, such as time since index
1505
- creation, time since rollover, the lifecycle configuration managing the index,
1506
- or any errors encountered during lifecycle execution.
1616
+ .. raw:: html
1617
+
1618
+ <p>Get the status for a data stream lifecycle.
1619
+ Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.</p>
1620
+
1507
1621
 
1508
1622
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams-explain-lifecycle.html>`_
1509
1623
 
@@ -1567,10 +1681,15 @@ class IndicesClient(NamespacedClient):
1567
1681
  ] = None,
1568
1682
  ) -> ObjectApiResponse[t.Any]:
1569
1683
  """
1570
- Get field usage stats. Get field usage information for each shard and field of
1571
- an index. Field usage statistics are automatically captured when queries are
1572
- running on a cluster. A shard-level search request that accesses a given field,
1573
- even if multiple times during that request, is counted as a single use.
1684
+ .. raw:: html
1685
+
1686
+ <p>Get field usage stats.
1687
+ Get field usage information for each shard and field of an index.
1688
+ Field usage statistics are automatically captured when queries are running on a cluster.
1689
+ A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.</p>
1690
+ <p>The response body reports the per-shard usage count of the data structures that back the fields in the index.
1691
+ A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.</p>
1692
+
1574
1693
 
1575
1694
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/field-usage-stats.html>`_
1576
1695
 
@@ -1658,22 +1777,18 @@ class IndicesClient(NamespacedClient):
1658
1777
  wait_if_ongoing: t.Optional[bool] = None,
1659
1778
  ) -> ObjectApiResponse[t.Any]:
1660
1779
  """
1661
- Flush data streams or indices. Flushing a data stream or index is the process
1662
- of making sure that any data that is currently only stored in the transaction
1663
- log is also permanently stored in the Lucene index. When restarting, Elasticsearch
1664
- replays any unflushed operations from the transaction log into the Lucene index
1665
- to bring it back into the state that it was in before the restart. Elasticsearch
1666
- automatically triggers flushes as needed, using heuristics that trade off the
1667
- size of the unflushed transaction log against the cost of performing each flush.
1668
- After each operation has been flushed it is permanently stored in the Lucene
1669
- index. This may mean that there is no need to maintain an additional copy of
1670
- it in the transaction log. The transaction log is made up of multiple files,
1671
- called generations, and Elasticsearch will delete any generation files when they
1672
- are no longer needed, freeing up disk space. It is also possible to trigger a
1673
- flush on one or more indices using the flush API, although it is rare for users
1674
- to need to call this API directly. If you call the flush API after indexing some
1675
- documents then a successful response indicates that Elasticsearch has flushed
1676
- all the documents that were indexed before the flush API was called.
1780
+ .. raw:: html
1781
+
1782
+ <p>Flush data streams or indices.
1783
+ Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.
1784
+ When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart.
1785
+ Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush.</p>
1786
+ <p>After each operation has been flushed it is permanently stored in the Lucene index.
1787
+ This may mean that there is no need to maintain an additional copy of it in the transaction log.
1788
+ The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space.</p>
1789
+ <p>It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly.
1790
+ If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.</p>
1791
+
1677
1792
 
1678
1793
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-flush.html>`_
1679
1794
 
@@ -1756,21 +1871,49 @@ class IndicesClient(NamespacedClient):
1756
1871
  wait_for_completion: t.Optional[bool] = None,
1757
1872
  ) -> ObjectApiResponse[t.Any]:
1758
1873
  """
1759
- Force a merge. Perform the force merge operation on the shards of one or more
1760
- indices. For data streams, the API forces a merge on the shards of the stream's
1761
- backing indices. Merging reduces the number of segments in each shard by merging
1762
- some of them together and also frees up the space used by deleted documents.
1763
- Merging normally happens automatically, but sometimes it is useful to trigger
1764
- a merge manually. WARNING: We recommend force merging only a read-only index
1765
- (meaning the index is no longer receiving writes). When documents are updated
1766
- or deleted, the old version is not immediately removed but instead soft-deleted
1767
- and marked with a "tombstone". These soft-deleted documents are automatically
1768
- cleaned up during regular segment merges. But force merge can cause very large
1769
- (greater than 5 GB) segments to be produced, which are not eligible for regular
1770
- merges. So the number of soft-deleted documents can then grow rapidly, resulting
1771
- in higher disk usage and worse search performance. If you regularly force merge
1772
- an index receiving writes, this can also make snapshots more expensive, since
1773
- the new documents can't be backed up incrementally.
1874
+ .. raw:: html
1875
+
1876
+ <p>Force a merge.
1877
+ Perform the force merge operation on the shards of one or more indices.
1878
+ For data streams, the API forces a merge on the shards of the stream's backing indices.</p>
1879
+ <p>Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.
1880
+ Merging normally happens automatically, but sometimes it is useful to trigger a merge manually.</p>
1881
+ <p>WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).
1882
+ When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a &quot;tombstone&quot;.
1883
+ These soft-deleted documents are automatically cleaned up during regular segment merges.
1884
+ But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.
1885
+ So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.
1886
+ If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.</p>
1887
+ <p><strong>Blocks during a force merge</strong></p>
1888
+ <p>Calls to this API block until the merge is complete (unless request contains <code>wait_for_completion=false</code>).
1889
+ If the client connection is lost before completion then the force merge process will continue in the background.
1890
+ Any new requests to force merge the same indices will also block until the ongoing force merge is complete.</p>
1891
+ <p><strong>Running force merge asynchronously</strong></p>
1892
+ <p>If the request contains <code>wait_for_completion=false</code>, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task.
1893
+ However, you can not cancel this task as the force merge task is not cancelable.
1894
+ Elasticsearch creates a record of this task as a document at <code>_tasks/&lt;task_id&gt;</code>.
1895
+ When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.</p>
1896
+ <p><strong>Force merging multiple indices</strong></p>
1897
+ <p>You can force merge multiple indices with a single request by targeting:</p>
1898
+ <ul>
1899
+ <li>One or more data streams that contain multiple backing indices</li>
1900
+ <li>Multiple indices</li>
1901
+ <li>One or more aliases</li>
1902
+ <li>All data streams and indices in a cluster</li>
1903
+ </ul>
1904
+ <p>Each targeted shard is force-merged separately using the force_merge threadpool.
1905
+ By default each node only has a single <code>force_merge</code> thread which means that the shards on that node are force-merged one at a time.
1906
+ If you expand the <code>force_merge</code> threadpool on a node then it will force merge its shards in parallel</p>
1907
+ <p>Force merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case <code>max_num_segments parameter</code> is set to <code>1</code>, to rewrite all segments into a new one.</p>
1908
+ <p><strong>Data streams and time-based indices</strong></p>
1909
+ <p>Force-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover.
1910
+ In these cases, each index only receives indexing traffic for a certain period of time.
1911
+ Once an index receive no more writes, its shards can be force-merged to a single segment.
1912
+ This can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches.
1913
+ For example:</p>
1914
+ <pre><code>POST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1
1915
+ </code></pre>
1916
+
1774
1917
 
1775
1918
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-forcemerge.html>`_
1776
1919
 
@@ -1863,8 +2006,12 @@ class IndicesClient(NamespacedClient):
1863
2006
  pretty: t.Optional[bool] = None,
1864
2007
  ) -> ObjectApiResponse[t.Any]:
1865
2008
  """
1866
- Get index information. Returns information about one or more indices. For data
1867
- streams, the API returns information about the stream’s backing indices.
2009
+ .. raw:: html
2010
+
2011
+ <p>Get index information.
2012
+ Get information about one or more indices. For data streams, the API returns information about the
2013
+ stream’s backing indices.</p>
2014
+
1868
2015
 
1869
2016
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-index.html>`_
1870
2017
 
@@ -1953,9 +2100,13 @@ class IndicesClient(NamespacedClient):
1953
2100
  pretty: t.Optional[bool] = None,
1954
2101
  ) -> ObjectApiResponse[t.Any]:
1955
2102
  """
1956
- Get aliases. Retrieves information for one or more data stream or index aliases.
2103
+ .. raw:: html
1957
2104
 
1958
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-aliases.html>`_
2105
+ <p>Get aliases.
2106
+ Retrieves information for one or more data stream or index aliases.</p>
2107
+
2108
+
2109
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-alias.html>`_
1959
2110
 
1960
2111
  :param index: Comma-separated list of data streams or indices used to limit the
1961
2112
  request. Supports wildcards (`*`). To target all data streams and indices,
@@ -2035,8 +2186,11 @@ class IndicesClient(NamespacedClient):
2035
2186
  pretty: t.Optional[bool] = None,
2036
2187
  ) -> ObjectApiResponse[t.Any]:
2037
2188
  """
2038
- Get data stream lifecycles. Retrieves the data stream lifecycle configuration
2039
- of one or more data streams.
2189
+ .. raw:: html
2190
+
2191
+ <p>Get data stream lifecycles.
2192
+ Retrieves the data stream lifecycle configuration of one or more data streams.</p>
2193
+
2040
2194
 
2041
2195
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams-get-lifecycle.html>`_
2042
2196
 
@@ -2080,6 +2234,45 @@ class IndicesClient(NamespacedClient):
2080
2234
  path_parts=__path_parts,
2081
2235
  )
2082
2236
 
2237
+ @_rewrite_parameters()
2238
+ def get_data_lifecycle_stats(
2239
+ self,
2240
+ *,
2241
+ error_trace: t.Optional[bool] = None,
2242
+ filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2243
+ human: t.Optional[bool] = None,
2244
+ pretty: t.Optional[bool] = None,
2245
+ ) -> ObjectApiResponse[t.Any]:
2246
+ """
2247
+ .. raw:: html
2248
+
2249
+ <p>Get data stream lifecycle stats.
2250
+ Get statistics about the data streams that are managed by a data stream lifecycle.</p>
2251
+
2252
+
2253
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams-get-lifecycle-stats.html>`_
2254
+ """
2255
+ __path_parts: t.Dict[str, str] = {}
2256
+ __path = "/_lifecycle/stats"
2257
+ __query: t.Dict[str, t.Any] = {}
2258
+ if error_trace is not None:
2259
+ __query["error_trace"] = error_trace
2260
+ if filter_path is not None:
2261
+ __query["filter_path"] = filter_path
2262
+ if human is not None:
2263
+ __query["human"] = human
2264
+ if pretty is not None:
2265
+ __query["pretty"] = pretty
2266
+ __headers = {"accept": "application/json"}
2267
+ return self.perform_request( # type: ignore[return-value]
2268
+ "GET",
2269
+ __path,
2270
+ params=__query,
2271
+ headers=__headers,
2272
+ endpoint_id="indices.get_data_lifecycle_stats",
2273
+ path_parts=__path_parts,
2274
+ )
2275
+
2083
2276
  @_rewrite_parameters()
2084
2277
  def get_data_stream(
2085
2278
  self,
@@ -2102,7 +2295,11 @@ class IndicesClient(NamespacedClient):
2102
2295
  verbose: t.Optional[bool] = None,
2103
2296
  ) -> ObjectApiResponse[t.Any]:
2104
2297
  """
2105
- Get data streams. Retrieves information about one or more data streams.
2298
+ .. raw:: html
2299
+
2300
+ <p>Get data streams.
2301
+ Retrieves information about one or more data streams.</p>
2302
+
2106
2303
 
2107
2304
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
2108
2305
 
@@ -2177,13 +2374,18 @@ class IndicesClient(NamespacedClient):
2177
2374
  pretty: t.Optional[bool] = None,
2178
2375
  ) -> ObjectApiResponse[t.Any]:
2179
2376
  """
2180
- Get mapping definitions. Retrieves mapping definitions for one or more fields.
2181
- For data streams, the API retrieves field mappings for the stream’s backing indices.
2377
+ .. raw:: html
2378
+
2379
+ <p>Get mapping definitions.
2380
+ Retrieves mapping definitions for one or more fields.
2381
+ For data streams, the API retrieves field mappings for the stream’s backing indices.</p>
2382
+ <p>This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.</p>
2383
+
2182
2384
 
2183
2385
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-field-mapping.html>`_
2184
2386
 
2185
2387
  :param fields: Comma-separated list or wildcard expression of fields used to
2186
- limit returned information.
2388
+ limit returned information. Supports wildcards (`*`).
2187
2389
  :param index: Comma-separated list of data streams, indices, and aliases used
2188
2390
  to limit the request. Supports wildcards (`*`). To target all data streams
2189
2391
  and indices, omit this parameter or use `*` or `_all`.
@@ -2255,7 +2457,11 @@ class IndicesClient(NamespacedClient):
2255
2457
  pretty: t.Optional[bool] = None,
2256
2458
  ) -> ObjectApiResponse[t.Any]:
2257
2459
  """
2258
- Get index templates. Returns information about one or more index templates.
2460
+ .. raw:: html
2461
+
2462
+ <p>Get index templates.
2463
+ Get information about one or more index templates.</p>
2464
+
2259
2465
 
2260
2466
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-template.html>`_
2261
2467
 
@@ -2328,8 +2534,11 @@ class IndicesClient(NamespacedClient):
2328
2534
  pretty: t.Optional[bool] = None,
2329
2535
  ) -> ObjectApiResponse[t.Any]:
2330
2536
  """
2331
- Get mapping definitions. Retrieves mapping definitions for one or more indices.
2332
- For data streams, the API retrieves mappings for the stream’s backing indices.
2537
+ .. raw:: html
2538
+
2539
+ <p>Get mapping definitions.
2540
+ For data streams, the API retrieves mappings for the stream’s backing indices.</p>
2541
+
2333
2542
 
2334
2543
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-mapping.html>`_
2335
2544
 
@@ -2413,8 +2622,12 @@ class IndicesClient(NamespacedClient):
2413
2622
  pretty: t.Optional[bool] = None,
2414
2623
  ) -> ObjectApiResponse[t.Any]:
2415
2624
  """
2416
- Get index settings. Returns setting information for one or more indices. For
2417
- data streams, returns setting information for the stream’s backing indices.
2625
+ .. raw:: html
2626
+
2627
+ <p>Get index settings.
2628
+ Get setting information for one or more indices.
2629
+ For data streams, it returns setting information for the stream's backing indices.</p>
2630
+
2418
2631
 
2419
2632
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-settings.html>`_
2420
2633
 
@@ -2501,7 +2714,12 @@ class IndicesClient(NamespacedClient):
2501
2714
  pretty: t.Optional[bool] = None,
2502
2715
  ) -> ObjectApiResponse[t.Any]:
2503
2716
  """
2504
- Get index templates. Retrieves information about one or more index templates.
2717
+ .. raw:: html
2718
+
2719
+ <p>Get index templates.
2720
+ Get information about one or more index templates.</p>
2721
+ <p>IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.</p>
2722
+
2505
2723
 
2506
2724
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-template-v1.html>`_
2507
2725
 
@@ -2560,14 +2778,20 @@ class IndicesClient(NamespacedClient):
2560
2778
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2561
2779
  ) -> ObjectApiResponse[t.Any]:
2562
2780
  """
2563
- Convert an index alias to a data stream. Converts an index alias to a data stream.
2564
- You must have a matching index template that is data stream enabled. The alias
2565
- must meet the following criteria: The alias must have a write index; All indices
2566
- for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos`
2567
- field type; The alias must not have any filters; The alias must not use custom
2568
- routing. If successful, the request removes the alias and creates a data stream
2569
- with the same name. The indices for the alias become hidden backing indices for
2570
- the stream. The write index for the alias becomes the write index for the stream.
2781
+ .. raw:: html
2782
+
2783
+ <p>Convert an index alias to a data stream.
2784
+ Converts an index alias to a data stream.
2785
+ You must have a matching index template that is data stream enabled.
2786
+ The alias must meet the following criteria:
2787
+ The alias must have a write index;
2788
+ All indices for the alias must have a <code>@timestamp</code> field mapping of a <code>date</code> or <code>date_nanos</code> field type;
2789
+ The alias must not have any filters;
2790
+ The alias must not use custom routing.
2791
+ If successful, the request removes the alias and creates a data stream with the same name.
2792
+ The indices for the alias become hidden backing indices for the stream.
2793
+ The write index for the alias becomes the write index for the stream.</p>
2794
+
2571
2795
 
2572
2796
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
2573
2797
 
@@ -2619,8 +2843,11 @@ class IndicesClient(NamespacedClient):
2619
2843
  body: t.Optional[t.Dict[str, t.Any]] = None,
2620
2844
  ) -> ObjectApiResponse[t.Any]:
2621
2845
  """
2622
- Update data streams. Performs one or more data stream modification actions in
2623
- a single atomic operation.
2846
+ .. raw:: html
2847
+
2848
+ <p>Update data streams.
2849
+ Performs one or more data stream modification actions in a single atomic operation.</p>
2850
+
2624
2851
 
2625
2852
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
2626
2853
 
@@ -2680,7 +2907,26 @@ class IndicesClient(NamespacedClient):
2680
2907
  ] = None,
2681
2908
  ) -> ObjectApiResponse[t.Any]:
2682
2909
  """
2683
- Opens a closed index. For data streams, the API opens any closed backing indices.
2910
+ .. raw:: html
2911
+
2912
+ <p>Open a closed index.
2913
+ For data streams, the API opens any closed backing indices.</p>
2914
+ <p>A closed index is blocked for read/write operations and does not allow all operations that opened indices allow.
2915
+ It is not possible to index documents or to search for documents in a closed index.
2916
+ This allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster.</p>
2917
+ <p>When opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index.
2918
+ The shards will then go through the normal recovery process.
2919
+ The data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.</p>
2920
+ <p>You can open and close multiple indices.
2921
+ An error is thrown if the request explicitly refers to a missing index.
2922
+ This behavior can be turned off by using the <code>ignore_unavailable=true</code> parameter.</p>
2923
+ <p>By default, you must explicitly name the indices you are opening or closing.
2924
+ To open or close indices with <code>_all</code>, <code>*</code>, or other wildcard expressions, change the <code>action.destructive_requires_name</code> setting to <code>false</code>.
2925
+ This setting can also be changed with the cluster update settings API.</p>
2926
+ <p>Closed indices consume a significant amount of disk-space which can cause problems in managed environments.
2927
+ Closing indices can be turned off with the cluster settings API by setting <code>cluster.indices.close.enable</code> to <code>false</code>.</p>
2928
+ <p>Because opening or closing an index allocates its shards, the <code>wait_for_active_shards</code> setting on index creation applies to the <code>_open</code> and <code>_close</code> index actions as well.</p>
2929
+
2684
2930
 
2685
2931
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-open-close.html>`_
2686
2932
 
@@ -2755,18 +3001,18 @@ class IndicesClient(NamespacedClient):
2755
3001
  pretty: t.Optional[bool] = None,
2756
3002
  ) -> ObjectApiResponse[t.Any]:
2757
3003
  """
2758
- Promote a data stream. Promote a data stream from a replicated data stream managed
2759
- by cross-cluster replication (CCR) to a regular data stream. With CCR auto following,
2760
- a data stream from a remote cluster can be replicated to the local cluster. These
2761
- data streams can't be rolled over in the local cluster. These replicated data
2762
- streams roll over only if the upstream data stream rolls over. In the event that
2763
- the remote cluster is no longer available, the data stream in the local cluster
2764
- can be promoted to a regular data stream, which allows these data streams to
2765
- be rolled over in the local cluster. NOTE: When promoting a data stream, ensure
2766
- the local cluster has a data stream enabled index template that matches the data
2767
- stream. If this is missing, the data stream will not be able to roll over until
2768
- a matching index template is created. This will affect the lifecycle management
2769
- of the data stream and interfere with the data stream size and retention.
3004
+ .. raw:: html
3005
+
3006
+ <p>Promote a data stream.
3007
+ Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.</p>
3008
+ <p>With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster.
3009
+ These data streams can't be rolled over in the local cluster.
3010
+ These replicated data streams roll over only if the upstream data stream rolls over.
3011
+ In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.</p>
3012
+ <p>NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream.
3013
+ If this is missing, the data stream will not be able to roll over until a matching index template is created.
3014
+ This will affect the lifecycle management of the data stream and interfere with the data stream size and retention.</p>
3015
+
2770
3016
 
2771
3017
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams.html>`_
2772
3018
 
@@ -2828,7 +3074,11 @@ class IndicesClient(NamespacedClient):
2828
3074
  body: t.Optional[t.Dict[str, t.Any]] = None,
2829
3075
  ) -> ObjectApiResponse[t.Any]:
2830
3076
  """
2831
- Create or update an alias. Adds a data stream or index to an alias.
3077
+ .. raw:: html
3078
+
3079
+ <p>Create or update an alias.
3080
+ Adds a data stream or index to an alias.</p>
3081
+
2832
3082
 
2833
3083
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-aliases.html>`_
2834
3084
 
@@ -2930,8 +3180,11 @@ class IndicesClient(NamespacedClient):
2930
3180
  body: t.Optional[t.Dict[str, t.Any]] = None,
2931
3181
  ) -> ObjectApiResponse[t.Any]:
2932
3182
  """
2933
- Update data stream lifecycles. Update the data stream lifecycle of the specified
2934
- data streams.
3183
+ .. raw:: html
3184
+
3185
+ <p>Update data stream lifecycles.
3186
+ Update the data stream lifecycle of the specified data streams.</p>
3187
+
2935
3188
 
2936
3189
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-streams-put-lifecycle.html>`_
2937
3190
 
@@ -3032,8 +3285,30 @@ class IndicesClient(NamespacedClient):
3032
3285
  body: t.Optional[t.Dict[str, t.Any]] = None,
3033
3286
  ) -> ObjectApiResponse[t.Any]:
3034
3287
  """
3035
- Create or update an index template. Index templates define settings, mappings,
3036
- and aliases that can be applied automatically to new indices.
3288
+ .. raw:: html
3289
+
3290
+ <p>Create or update an index template.
3291
+ Index templates define settings, mappings, and aliases that can be applied automatically to new indices.</p>
3292
+ <p>Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name.
3293
+ Index templates are applied during data stream or index creation.
3294
+ For data streams, these settings and mappings are applied when the stream's backing indices are created.
3295
+ Settings and mappings specified in a create index API request override any settings or mappings specified in an index template.
3296
+ Changes to index templates do not affect existing indices, including the existing backing indices of a data stream.</p>
3297
+ <p>You can use C-style <code>/* *\\/</code> block comments in index templates.
3298
+ You can include comments anywhere in the request body, except before the opening curly bracket.</p>
3299
+ <p><strong>Multiple matching templates</strong></p>
3300
+ <p>If multiple index templates match the name of a new index or data stream, the template with the highest priority is used.</p>
3301
+ <p>Multiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.</p>
3302
+ <p><strong>Composing aliases, mappings, and settings</strong></p>
3303
+ <p>When multiple component templates are specified in the <code>composed_of</code> field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates.
3304
+ Any mappings, settings, or aliases from the parent index template are merged in next.
3305
+ Finally, any configuration on the index request itself is merged.
3306
+ Mapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration.
3307
+ If a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one.
3308
+ This recursive merging strategy applies not only to field mappings, but also root options like <code>dynamic_templates</code> and <code>meta</code>.
3309
+ If an earlier component contains a <code>dynamic_templates</code> block, then by default new <code>dynamic_templates</code> entries are appended onto the end.
3310
+ If an entry already exists with the same key, then it is overwritten by the new definition.</p>
3311
+
3037
3312
 
3038
3313
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-put-template.html>`_
3039
3314
 
@@ -3063,8 +3338,11 @@ class IndicesClient(NamespacedClient):
3063
3338
  :param master_timeout: Period to wait for a connection to the master node. If
3064
3339
  no response is received before the timeout expires, the request fails and
3065
3340
  returns an error.
3066
- :param meta: Optional user metadata about the index template. May have any contents.
3067
- This map is not automatically generated by Elasticsearch.
3341
+ :param meta: Optional user metadata about the index template. It may have any
3342
+ contents. It is not automatically generated or used by Elasticsearch. This
3343
+ user-defined object is stored in the cluster state, so keeping it short is
3344
+ preferable To unset the metadata, replace the template without specifying
3345
+ it.
3068
3346
  :param priority: Priority to determine index template precedence when a new data
3069
3347
  stream or index is created. The index template with the highest priority
3070
3348
  is chosen. If no priority is specified the template is treated as though
@@ -3073,7 +3351,9 @@ class IndicesClient(NamespacedClient):
3073
3351
  :param template: Template to be applied. It may optionally include an `aliases`,
3074
3352
  `mappings`, or `settings` configuration.
3075
3353
  :param version: Version number used to manage index templates externally. This
3076
- number is not automatically generated by Elasticsearch.
3354
+ number is not automatically generated by Elasticsearch. External systems
3355
+ can use these version numbers to simplify template management. To unset a
3356
+ version, replace the template without specifying one.
3077
3357
  """
3078
3358
  if name in SKIP_IN_PATH:
3079
3359
  raise ValueError("Empty value passed for parameter 'name'")
@@ -3161,10 +3441,7 @@ class IndicesClient(NamespacedClient):
3161
3441
  ] = None,
3162
3442
  dynamic_date_formats: t.Optional[t.Sequence[str]] = None,
3163
3443
  dynamic_templates: t.Optional[
3164
- t.Union[
3165
- t.Mapping[str, t.Mapping[str, t.Any]],
3166
- t.Sequence[t.Mapping[str, t.Mapping[str, t.Any]]],
3167
- ]
3444
+ t.Sequence[t.Mapping[str, t.Mapping[str, t.Any]]]
3168
3445
  ] = None,
3169
3446
  error_trace: t.Optional[bool] = None,
3170
3447
  expand_wildcards: t.Optional[
@@ -3192,9 +3469,29 @@ class IndicesClient(NamespacedClient):
3192
3469
  body: t.Optional[t.Dict[str, t.Any]] = None,
3193
3470
  ) -> ObjectApiResponse[t.Any]:
3194
3471
  """
3195
- Update field mappings. Adds new fields to an existing data stream or index. You
3196
- can also use this API to change the search settings of existing fields. For data
3197
- streams, these changes are applied to all backing indices by default.
3472
+ .. raw:: html
3473
+
3474
+ <p>Update field mappings.
3475
+ Add new fields to an existing data stream or index.
3476
+ You can also use this API to change the search settings of existing fields and add new properties to existing object fields.
3477
+ For data streams, these changes are applied to all backing indices by default.</p>
3478
+ <p><strong>Add multi-fields to an existing field</strong></p>
3479
+ <p>Multi-fields let you index the same field in different ways.
3480
+ You can use this API to update the fields mapping parameter and enable multi-fields for an existing field.
3481
+ WARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field.
3482
+ You can populate the new multi-field with the update by query API.</p>
3483
+ <p><strong>Change supported mapping parameters for an existing field</strong></p>
3484
+ <p>The documentation for each mapping parameter indicates whether you can update it for an existing field using this API.
3485
+ For example, you can use the update mapping API to update the <code>ignore_above</code> parameter.</p>
3486
+ <p><strong>Change the mapping of an existing field</strong></p>
3487
+ <p>Except for supported mapping parameters, you can't change the mapping or field type of an existing field.
3488
+ Changing an existing field could invalidate data that's already indexed.</p>
3489
+ <p>If you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams.
3490
+ If you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.</p>
3491
+ <p><strong>Rename a field</strong></p>
3492
+ <p>Renaming a field would invalidate data already indexed under the old field name.
3493
+ Instead, add an alias field to create an alternate field name.</p>
3494
+
3198
3495
 
3199
3496
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-put-mapping.html>`_
3200
3497
 
@@ -3323,8 +3620,23 @@ class IndicesClient(NamespacedClient):
3323
3620
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
3324
3621
  ) -> ObjectApiResponse[t.Any]:
3325
3622
  """
3326
- Update index settings. Changes dynamic index settings in real time. For data
3327
- streams, index setting changes are applied to all backing indices by default.
3623
+ .. raw:: html
3624
+
3625
+ <p>Update index settings.
3626
+ Changes dynamic index settings in real time.
3627
+ For data streams, index setting changes are applied to all backing indices by default.</p>
3628
+ <p>To revert a setting to the default value, use a null value.
3629
+ The list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.
3630
+ To preserve existing settings from being updated, set the <code>preserve_existing</code> parameter to <code>true</code>.</p>
3631
+ <p>NOTE: You can only define new analyzers on closed indices.
3632
+ To add an analyzer, you must close the index, define the analyzer, and reopen the index.
3633
+ You cannot close the write index of a data stream.
3634
+ To update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.
3635
+ Then roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.
3636
+ This affects searches and any new data added to the stream after the rollover.
3637
+ However, it does not affect the data stream's backing indices or their existing data.
3638
+ To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.</p>
3639
+
3328
3640
 
3329
3641
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-update-settings.html>`_
3330
3642
 
@@ -3428,17 +3740,24 @@ class IndicesClient(NamespacedClient):
3428
3740
  body: t.Optional[t.Dict[str, t.Any]] = None,
3429
3741
  ) -> ObjectApiResponse[t.Any]:
3430
3742
  """
3431
- Create or update an index template. Index templates define settings, mappings,
3432
- and aliases that can be applied automatically to new indices. Elasticsearch applies
3433
- templates to new indices based on an index pattern that matches the index name.
3434
- IMPORTANT: This documentation is about legacy index templates, which are deprecated
3435
- and will be replaced by the composable templates introduced in Elasticsearch
3436
- 7.8. Composable templates always take precedence over legacy templates. If no
3437
- composable template matches a new index, matching legacy templates are applied
3438
- according to their order. Index templates are only applied during index creation.
3439
- Changes to index templates do not affect existing indices. Settings and mappings
3440
- specified in create index API requests override any settings or mappings specified
3441
- in an index template.
3743
+ .. raw:: html
3744
+
3745
+ <p>Create or update an index template.
3746
+ Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
3747
+ Elasticsearch applies templates to new indices based on an index pattern that matches the index name.</p>
3748
+ <p>IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.</p>
3749
+ <p>Composable templates always take precedence over legacy templates.
3750
+ If no composable template matches a new index, matching legacy templates are applied according to their order.</p>
3751
+ <p>Index templates are only applied during index creation.
3752
+ Changes to index templates do not affect existing indices.
3753
+ Settings and mappings specified in create index API requests override any settings or mappings specified in an index template.</p>
3754
+ <p>You can use C-style <code>/* *\\/</code> block comments in index templates.
3755
+ You can include comments anywhere in the request body, except before the opening curly bracket.</p>
3756
+ <p><strong>Indices matching multiple templates</strong></p>
3757
+ <p>Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index.
3758
+ The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them.
3759
+ NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.</p>
3760
+
3442
3761
 
3443
3762
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-templates-v1.html>`_
3444
3763
 
@@ -3459,7 +3778,8 @@ class IndicesClient(NamespacedClient):
3459
3778
  with lower values.
3460
3779
  :param settings: Configuration options for the index.
3461
3780
  :param version: Version number used to manage index templates externally. This
3462
- number is not automatically generated by Elasticsearch.
3781
+ number is not automatically generated by Elasticsearch. To unset a version,
3782
+ replace the template without specifying one.
3463
3783
  """
3464
3784
  if name in SKIP_IN_PATH:
3465
3785
  raise ValueError("Empty value passed for parameter 'name'")
@@ -3518,25 +3838,28 @@ class IndicesClient(NamespacedClient):
3518
3838
  pretty: t.Optional[bool] = None,
3519
3839
  ) -> ObjectApiResponse[t.Any]:
3520
3840
  """
3521
- Get index recovery information. Get information about ongoing and completed shard
3522
- recoveries for one or more indices. For data streams, the API returns information
3523
- for the stream's backing indices. Shard recovery is the process of initializing
3524
- a shard copy, such as restoring a primary shard from a snapshot or creating a
3525
- replica shard from a primary shard. When a shard recovery completes, the recovered
3526
- shard is available for search and indexing. Recovery automatically occurs during
3527
- the following processes: * When creating an index for the first time. * When
3528
- a node rejoins the cluster and starts up any missing primary shard copies using
3529
- the data that it holds in its data path. * Creation of new replica shard copies
3530
- from the primary. * Relocation of a shard copy to a different node in the same
3531
- cluster. * A snapshot restore operation. * A clone, shrink, or split operation.
3532
- You can determine the cause of a shard recovery using the recovery or cat recovery
3533
- APIs. The index recovery API reports information about completed recoveries only
3534
- for shard copies that currently exist in the cluster. It only reports the last
3535
- recovery for each shard copy and does not report historical information about
3536
- earlier recoveries, nor does it report information about the recoveries of shard
3537
- copies that no longer exist. This means that if a shard copy completes a recovery
3538
- and then Elasticsearch relocates it onto a different node then the information
3539
- about the original recovery will not be shown in the recovery API.
3841
+ .. raw:: html
3842
+
3843
+ <p>Get index recovery information.
3844
+ Get information about ongoing and completed shard recoveries for one or more indices.
3845
+ For data streams, the API returns information for the stream's backing indices.</p>
3846
+ <p>All recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.</p>
3847
+ <p>Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard.
3848
+ When a shard recovery completes, the recovered shard is available for search and indexing.</p>
3849
+ <p>Recovery automatically occurs during the following processes:</p>
3850
+ <ul>
3851
+ <li>When creating an index for the first time.</li>
3852
+ <li>When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.</li>
3853
+ <li>Creation of new replica shard copies from the primary.</li>
3854
+ <li>Relocation of a shard copy to a different node in the same cluster.</li>
3855
+ <li>A snapshot restore operation.</li>
3856
+ <li>A clone, shrink, or split operation.</li>
3857
+ </ul>
3858
+ <p>You can determine the cause of a shard recovery using the recovery or cat recovery APIs.</p>
3859
+ <p>The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster.
3860
+ It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist.
3861
+ This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.</p>
3862
+
3540
3863
 
3541
3864
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-recovery.html>`_
3542
3865
 
@@ -3598,9 +3921,19 @@ class IndicesClient(NamespacedClient):
3598
3921
  pretty: t.Optional[bool] = None,
3599
3922
  ) -> ObjectApiResponse[t.Any]:
3600
3923
  """
3601
- Refresh an index. A refresh makes recent operations performed on one or more
3602
- indices available for search. For data streams, the API runs the refresh operation
3603
- on the stream’s backing indices.
3924
+ .. raw:: html
3925
+
3926
+ <p>Refresh an index.
3927
+ A refresh makes recent operations performed on one or more indices available for search.
3928
+ For data streams, the API runs the refresh operation on the stream’s backing indices.</p>
3929
+ <p>By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds.
3930
+ You can change this default interval with the <code>index.refresh_interval</code> setting.</p>
3931
+ <p>Refresh requests are synchronous and do not return a response until the refresh operation completes.</p>
3932
+ <p>Refreshes are resource-intensive.
3933
+ To ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.</p>
3934
+ <p>If your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's <code>refresh=wait_for</code> query parameter option.
3935
+ This option ensures the indexing operation waits for a periodic refresh before running the search.</p>
3936
+
3604
3937
 
3605
3938
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-refresh.html>`_
3606
3939
 
@@ -3670,21 +4003,20 @@ class IndicesClient(NamespacedClient):
3670
4003
  pretty: t.Optional[bool] = None,
3671
4004
  ) -> ObjectApiResponse[t.Any]:
3672
4005
  """
3673
- Reload search analyzers. Reload an index's search analyzers and their resources.
3674
- For data streams, the API reloads search analyzers and resources for the stream's
3675
- backing indices. IMPORTANT: After reloading the search analyzers you should clear
3676
- the request cache to make sure it doesn't contain responses derived from the
3677
- previous versions of the analyzer. You can use the reload search analyzers API
3678
- to pick up changes to synonym files used in the `synonym_graph` or `synonym`
3679
- token filter of a search analyzer. To be eligible, the token filter must have
3680
- an `updateable` flag of `true` and only be used in search analyzers. NOTE: This
3681
- API does not perform a reload for each shard of an index. Instead, it performs
3682
- a reload for each node containing index shards. As a result, the total shard
3683
- count returned by the API can differ from the number of index shards. Because
3684
- reloading affects every node with an index shard, it is important to update the
3685
- synonym file on every data node in the cluster--including nodes that don't contain
3686
- a shard replica--before using this API. This ensures the synonym file is updated
3687
- everywhere in the cluster in case shards are relocated in the future.
4006
+ .. raw:: html
4007
+
4008
+ <p>Reload search analyzers.
4009
+ Reload an index's search analyzers and their resources.
4010
+ For data streams, the API reloads search analyzers and resources for the stream's backing indices.</p>
4011
+ <p>IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.</p>
4012
+ <p>You can use the reload search analyzers API to pick up changes to synonym files used in the <code>synonym_graph</code> or <code>synonym</code> token filter of a search analyzer.
4013
+ To be eligible, the token filter must have an <code>updateable</code> flag of <code>true</code> and only be used in search analyzers.</p>
4014
+ <p>NOTE: This API does not perform a reload for each shard of an index.
4015
+ Instead, it performs a reload for each node containing index shards.
4016
+ As a result, the total shard count returned by the API can differ from the number of index shards.
4017
+ Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API.
4018
+ This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.</p>
4019
+
3688
4020
 
3689
4021
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-reload-analyzers.html>`_
3690
4022
 
@@ -3748,20 +4080,33 @@ class IndicesClient(NamespacedClient):
3748
4080
  pretty: t.Optional[bool] = None,
3749
4081
  ) -> ObjectApiResponse[t.Any]:
3750
4082
  """
3751
- Resolve the cluster. Resolve the specified index expressions to return information
3752
- about each cluster, including the local cluster, if included. Multiple patterns
3753
- and remote clusters are supported. This endpoint is useful before doing a cross-cluster
3754
- search in order to determine which remote clusters should be included in a search.
3755
- You use the same index expression with this endpoint as you would for cross-cluster
3756
- search. Index and cluster exclusions are also supported with this endpoint. For
3757
- each cluster in the index expression, information is returned about: * Whether
3758
- the querying ("local") cluster is currently connected to each remote cluster
3759
- in the index expression scope. * Whether each remote cluster is configured with
3760
- `skip_unavailable` as `true` or `false`. * Whether there are any indices, aliases,
3761
- or data streams on that cluster that match the index expression. * Whether the
3762
- search is likely to have errors returned when you do the cross-cluster search
3763
- (including any authorization errors if you do not have permission to query the
3764
- index). * Cluster version information, including the Elasticsearch server version.
4083
+ .. raw:: html
4084
+
4085
+ <p>Resolve the cluster.
4086
+ Resolve the specified index expressions to return information about each cluster, including the local cluster, if included.
4087
+ Multiple patterns and remote clusters are supported.</p>
4088
+ <p>This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.</p>
4089
+ <p>You use the same index expression with this endpoint as you would for cross-cluster search.
4090
+ Index and cluster exclusions are also supported with this endpoint.</p>
4091
+ <p>For each cluster in the index expression, information is returned about:</p>
4092
+ <ul>
4093
+ <li>Whether the querying (&quot;local&quot;) cluster is currently connected to each remote cluster in the index expression scope.</li>
4094
+ <li>Whether each remote cluster is configured with <code>skip_unavailable</code> as <code>true</code> or <code>false</code>.</li>
4095
+ <li>Whether there are any indices, aliases, or data streams on that cluster that match the index expression.</li>
4096
+ <li>Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).</li>
4097
+ <li>Cluster version information, including the Elasticsearch server version.</li>
4098
+ </ul>
4099
+ <p>For example, <code>GET /_resolve/cluster/my-index-*,cluster*:my-index-*</code> returns information about the local cluster and all remotely configured clusters that start with the alias <code>cluster*</code>.
4100
+ Each cluster returns information about whether it has any indices, aliases or data streams that match <code>my-index-*</code>.</p>
4101
+ <p><strong>Advantages of using this endpoint before a cross-cluster search</strong></p>
4102
+ <p>You may want to exclude a cluster or index from a search when:</p>
4103
+ <ul>
4104
+ <li>A remote cluster is not currently connected and is configured with <code>skip_unavailable=false</code>. Running a cross-cluster search under those conditions will cause the entire search to fail.</li>
4105
+ <li>A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is <code>logs*,remote1:logs*</code> and the remote1 cluster has no indices, aliases or data streams that match <code>logs*</code>. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.</li>
4106
+ <li>The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the &quot;error&quot; field in the <code>_resolve/cluster</code> response will be present. (This is also where security/permission errors will be shown.)</li>
4107
+ <li>A remote cluster is an older version that does not support the feature you want to use in your search.</li>
4108
+ </ul>
4109
+
3765
4110
 
3766
4111
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-resolve-cluster-api.html>`_
3767
4112
 
@@ -3834,8 +4179,12 @@ class IndicesClient(NamespacedClient):
3834
4179
  pretty: t.Optional[bool] = None,
3835
4180
  ) -> ObjectApiResponse[t.Any]:
3836
4181
  """
3837
- Resolve indices. Resolve the names and/or index patterns for indices, aliases,
3838
- and data streams. Multiple patterns and remote clusters are supported.
4182
+ .. raw:: html
4183
+
4184
+ <p>Resolve indices.
4185
+ Resolve the names and/or index patterns for indices, aliases, and data streams.
4186
+ Multiple patterns and remote clusters are supported.</p>
4187
+
3839
4188
 
3840
4189
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-resolve-index-api.html>`_
3841
4190
 
@@ -3908,7 +4257,35 @@ class IndicesClient(NamespacedClient):
3908
4257
  body: t.Optional[t.Dict[str, t.Any]] = None,
3909
4258
  ) -> ObjectApiResponse[t.Any]:
3910
4259
  """
3911
- Roll over to a new index. Creates a new index for a data stream or index alias.
4260
+ .. raw:: html
4261
+
4262
+ <p>Roll over to a new index.
4263
+ TIP: It is recommended to use the index lifecycle rollover action to automate rollovers.</p>
4264
+ <p>The rollover API creates a new index for a data stream or index alias.
4265
+ The API behavior depends on the rollover target.</p>
4266
+ <p><strong>Roll over a data stream</strong></p>
4267
+ <p>If you roll over a data stream, the API creates a new write index for the stream.
4268
+ The stream's previous write index becomes a regular backing index.
4269
+ A rollover also increments the data stream's generation.</p>
4270
+ <p><strong>Roll over an index alias with a write index</strong></p>
4271
+ <p>TIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.
4272
+ Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers.</p>
4273
+ <p>If an index alias points to multiple indices, one of the indices must be a write index.
4274
+ The rollover API creates a new write index for the alias with <code>is_write_index</code> set to <code>true</code>.
4275
+ The API also <code>sets is_write_index</code> to <code>false</code> for the previous write index.</p>
4276
+ <p><strong>Roll over an index alias with one index</strong></p>
4277
+ <p>If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.</p>
4278
+ <p>NOTE: A rollover creates a new index and is subject to the <code>wait_for_active_shards</code> setting.</p>
4279
+ <p><strong>Increment index names for an alias</strong></p>
4280
+ <p>When you roll over an index alias, you can specify a name for the new index.
4281
+ If you don't specify a name and the current index ends with <code>-</code> and a number, such as <code>my-index-000001</code> or <code>my-index-3</code>, the new index name increments that number.
4282
+ For example, if you roll over an alias with a current index of <code>my-index-000001</code>, the rollover creates a new index named <code>my-index-000002</code>.
4283
+ This number is always six characters and zero-padded, regardless of the previous index's name.</p>
4284
+ <p>If you use an index alias for time series data, you can use date math in the index name to track the rollover date.
4285
+ For example, you can create an alias that points to an index named <code>&lt;my-index-{now/d}-000001&gt;</code>.
4286
+ If you create the index on May 6, 2099, the index's name is <code>my-index-2099.05.06-000001</code>.
4287
+ If you roll over the alias on May 7, 2099, the new index's name is <code>my-index-2099.05.07-000002</code>.</p>
4288
+
3912
4289
 
3913
4290
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-rollover-index.html>`_
3914
4291
 
@@ -4013,9 +4390,12 @@ class IndicesClient(NamespacedClient):
4013
4390
  verbose: t.Optional[bool] = None,
4014
4391
  ) -> ObjectApiResponse[t.Any]:
4015
4392
  """
4016
- Get index segments. Get low-level information about the Lucene segments in index
4017
- shards. For data streams, the API returns information about the stream's backing
4018
- indices.
4393
+ .. raw:: html
4394
+
4395
+ <p>Get index segments.
4396
+ Get low-level information about the Lucene segments in index shards.
4397
+ For data streams, the API returns information about the stream's backing indices.</p>
4398
+
4019
4399
 
4020
4400
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-segments.html>`_
4021
4401
 
@@ -4094,14 +4474,20 @@ class IndicesClient(NamespacedClient):
4094
4474
  ] = None,
4095
4475
  ) -> ObjectApiResponse[t.Any]:
4096
4476
  """
4097
- Get index shard stores. Get store information about replica shards in one or
4098
- more indices. For data streams, the API retrieves store information for the stream's
4099
- backing indices. The index shard stores API returns the following information:
4100
- * The node on which each replica shard exists. * The allocation ID for each replica
4101
- shard. * A unique ID for each replica shard. * Any errors encountered while opening
4102
- the shard index or from an earlier failure. By default, the API returns store
4103
- information only for primary shards that are unassigned or have one or more unassigned
4104
- replica shards.
4477
+ .. raw:: html
4478
+
4479
+ <p>Get index shard stores.
4480
+ Get store information about replica shards in one or more indices.
4481
+ For data streams, the API retrieves store information for the stream's backing indices.</p>
4482
+ <p>The index shard stores API returns the following information:</p>
4483
+ <ul>
4484
+ <li>The node on which each replica shard exists.</li>
4485
+ <li>The allocation ID for each replica shard.</li>
4486
+ <li>A unique ID for each replica shard.</li>
4487
+ <li>Any errors encountered while opening the shard index or from an earlier failure.</li>
4488
+ </ul>
4489
+ <p>By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.</p>
4490
+
4105
4491
 
4106
4492
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-shards-stores.html>`_
4107
4493
 
@@ -4172,39 +4558,38 @@ class IndicesClient(NamespacedClient):
4172
4558
  body: t.Optional[t.Dict[str, t.Any]] = None,
4173
4559
  ) -> ObjectApiResponse[t.Any]:
4174
4560
  """
4175
- Shrink an index. Shrink an index into a new index with fewer primary shards.
4176
- Before you can shrink an index: * The index must be read-only. * A copy of every
4177
- shard in the index must reside on the same node. * The index must have a green
4178
- health status. To make shard allocation easier, we recommend you also remove
4179
- the index's replica shards. You can later re-add replica shards as part of the
4180
- shrink operation. The requested number of primary shards in the target index
4181
- must be a factor of the number of shards in the source index. For example an
4182
- index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an
4183
- index with 15 primary shards can be shrunk into 5, 3 or 1. If the number of shards
4184
- in the index is a prime number it can only be shrunk into a single primary shard
4185
- Before shrinking, a (primary or replica) copy of every shard in the index must
4186
- be present on the same node. The current write index on a data stream cannot
4187
- be shrunk. In order to shrink the current write index, the data stream must first
4188
- be rolled over so that a new write index is created and then the previous write
4189
- index can be shrunk. A shrink operation: * Creates a new target index with the
4190
- same definition as the source index, but with a smaller number of primary shards.
4191
- * Hard-links segments from the source index into the target index. If the file
4192
- system does not support hard-linking, then all segments are copied into the new
4193
- index, which is a much more time consuming process. Also if using multiple data
4194
- paths, shards on different data paths require a full copy of segment files if
4195
- they are not on the same disk since hardlinks do not work across disks. * Recovers
4196
- the target index as though it were a closed index which had just been re-opened.
4197
- Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.
4198
- IMPORTANT: Indices can only be shrunk if they satisfy the following requirements:
4199
- * The target index must not exist. * The source index must have more primary
4200
- shards than the target index. * The number of primary shards in the target index
4201
- must be a factor of the number of primary shards in the source index. The source
4202
- index must have more primary shards than the target index. * The index must not
4203
- contain more than 2,147,483,519 documents in total across all shards that will
4204
- be shrunk into a single shard on the target index as this is the maximum number
4205
- of docs that can fit into a single shard. * The node handling the shrink process
4206
- must have sufficient free disk space to accommodate a second copy of the existing
4207
- index.
4561
+ .. raw:: html
4562
+
4563
+ <p>Shrink an index.
4564
+ Shrink an index into a new index with fewer primary shards.</p>
4565
+ <p>Before you can shrink an index:</p>
4566
+ <ul>
4567
+ <li>The index must be read-only.</li>
4568
+ <li>A copy of every shard in the index must reside on the same node.</li>
4569
+ <li>The index must have a green health status.</li>
4570
+ </ul>
4571
+ <p>To make shard allocation easier, we recommend you also remove the index's replica shards.
4572
+ You can later re-add replica shards as part of the shrink operation.</p>
4573
+ <p>The requested number of primary shards in the target index must be a factor of the number of shards in the source index.
4574
+ For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1.
4575
+ If the number of shards in the index is a prime number it can only be shrunk into a single primary shard
4576
+ Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.</p>
4577
+ <p>The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk.</p>
4578
+ <p>A shrink operation:</p>
4579
+ <ul>
4580
+ <li>Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.</li>
4581
+ <li>Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.</li>
4582
+ <li>Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the <code>.routing.allocation.initial_recovery._id</code> index setting.</li>
4583
+ </ul>
4584
+ <p>IMPORTANT: Indices can only be shrunk if they satisfy the following requirements:</p>
4585
+ <ul>
4586
+ <li>The target index must not exist.</li>
4587
+ <li>The source index must have more primary shards than the target index.</li>
4588
+ <li>The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index.</li>
4589
+ <li>The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard.</li>
4590
+ <li>The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index.</li>
4591
+ </ul>
4592
+
4208
4593
 
4209
4594
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-shrink-index.html>`_
4210
4595
 
@@ -4279,8 +4664,11 @@ class IndicesClient(NamespacedClient):
4279
4664
  pretty: t.Optional[bool] = None,
4280
4665
  ) -> ObjectApiResponse[t.Any]:
4281
4666
  """
4282
- Simulate an index. Returns the index configuration that would be applied to the
4283
- specified index from an existing index template.
4667
+ .. raw:: html
4668
+
4669
+ <p>Simulate an index.
4670
+ Get the index configuration that would be applied to the specified index from an existing index template.</p>
4671
+
4284
4672
 
4285
4673
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-simulate-index.html>`_
4286
4674
 
@@ -4357,8 +4745,11 @@ class IndicesClient(NamespacedClient):
4357
4745
  body: t.Optional[t.Dict[str, t.Any]] = None,
4358
4746
  ) -> ObjectApiResponse[t.Any]:
4359
4747
  """
4360
- Simulate an index template. Returns the index configuration that would be applied
4361
- by a particular index template.
4748
+ .. raw:: html
4749
+
4750
+ <p>Simulate an index template.
4751
+ Get the index configuration that would be applied by a particular index template.</p>
4752
+
4362
4753
 
4363
4754
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-simulate-template.html>`_
4364
4755
 
@@ -4489,27 +4880,44 @@ class IndicesClient(NamespacedClient):
4489
4880
  body: t.Optional[t.Dict[str, t.Any]] = None,
4490
4881
  ) -> ObjectApiResponse[t.Any]:
4491
4882
  """
4492
- Split an index. Split an index into a new index with more primary shards. * Before
4493
- you can split an index: * The index must be read-only. * The cluster health status
4494
- must be green. The number of times the index can be split (and the number of
4495
- shards that each original shard can be split into) is determined by the `index.number_of_routing_shards`
4496
- setting. The number of routing shards specifies the hashing space that is used
4497
- internally to distribute documents across shards with consistent hashing. For
4498
- instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x
4499
- 3) could be split by a factor of 2 or 3. A split operation: * Creates a new target
4500
- index with the same definition as the source index, but with a larger number
4501
- of primary shards. * Hard-links segments from the source index into the target
4502
- index. If the file system doesn't support hard-linking, all segments are copied
4503
- into the new index, which is a much more time consuming process. * Hashes all
4504
- documents again, after low level files are created, to delete documents that
4505
- belong to a different shard. * Recovers the target index as though it were a
4506
- closed index which had just been re-opened. IMPORTANT: Indices can only be split
4507
- if they satisfy the following requirements: * The target index must not exist.
4508
- * The source index must have fewer primary shards than the target index. * The
4509
- number of primary shards in the target index must be a multiple of the number
4510
- of primary shards in the source index. * The node handling the split process
4511
- must have sufficient free disk space to accommodate a second copy of the existing
4512
- index.
4883
+ .. raw:: html
4884
+
4885
+ <p>Split an index.
4886
+ Split an index into a new index with more primary shards.</p>
4887
+ <ul>
4888
+ <li>
4889
+ <p>Before you can split an index:</p>
4890
+ </li>
4891
+ <li>
4892
+ <p>The index must be read-only.</p>
4893
+ </li>
4894
+ <li>
4895
+ <p>The cluster health status must be green.</p>
4896
+ </li>
4897
+ </ul>
4898
+ <p>You can do make an index read-only with the following request using the add index block API:</p>
4899
+ <pre><code>PUT /my_source_index/_block/write
4900
+ </code></pre>
4901
+ <p>The current write index on a data stream cannot be split.
4902
+ In order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split.</p>
4903
+ <p>The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the <code>index.number_of_routing_shards</code> setting.
4904
+ The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing.
4905
+ For instance, a 5 shard index with <code>number_of_routing_shards</code> set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.</p>
4906
+ <p>A split operation:</p>
4907
+ <ul>
4908
+ <li>Creates a new target index with the same definition as the source index, but with a larger number of primary shards.</li>
4909
+ <li>Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.</li>
4910
+ <li>Hashes all documents again, after low level files are created, to delete documents that belong to a different shard.</li>
4911
+ <li>Recovers the target index as though it were a closed index which had just been re-opened.</li>
4912
+ </ul>
4913
+ <p>IMPORTANT: Indices can only be split if they satisfy the following requirements:</p>
4914
+ <ul>
4915
+ <li>The target index must not exist.</li>
4916
+ <li>The source index must have fewer primary shards than the target index.</li>
4917
+ <li>The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.</li>
4918
+ <li>The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index.</li>
4919
+ </ul>
4920
+
4513
4921
 
4514
4922
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-split-index.html>`_
4515
4923
 
@@ -4601,14 +5009,17 @@ class IndicesClient(NamespacedClient):
4601
5009
  pretty: t.Optional[bool] = None,
4602
5010
  ) -> ObjectApiResponse[t.Any]:
4603
5011
  """
4604
- Get index statistics. For data streams, the API retrieves statistics for the
4605
- stream's backing indices. By default, the returned statistics are index-level
4606
- with `primaries` and `total` aggregations. `primaries` are the values for only
4607
- the primary shards. `total` are the accumulated values for both primary and replica
4608
- shards. To get shard-level statistics, set the `level` parameter to `shards`.
4609
- NOTE: When moving to another node, the shard-level statistics for a shard are
4610
- cleared. Although the shard is no longer part of the node, that node retains
4611
- any node-level statistics to which the shard contributed.
5012
+ .. raw:: html
5013
+
5014
+ <p>Get index statistics.
5015
+ For data streams, the API retrieves statistics for the stream's backing indices.</p>
5016
+ <p>By default, the returned statistics are index-level with <code>primaries</code> and <code>total</code> aggregations.
5017
+ <code>primaries</code> are the values for only the primary shards.
5018
+ <code>total</code> are the accumulated values for both primary and replica shards.</p>
5019
+ <p>To get shard-level statistics, set the <code>level</code> parameter to <code>shards</code>.</p>
5020
+ <p>NOTE: When moving to another node, the shard-level statistics for a shard are cleared.
5021
+ Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.</p>
5022
+
4612
5023
 
4613
5024
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-stats.html>`_
4614
5025
 
@@ -4711,8 +5122,11 @@ class IndicesClient(NamespacedClient):
4711
5122
  wait_for_active_shards: t.Optional[str] = None,
4712
5123
  ) -> ObjectApiResponse[t.Any]:
4713
5124
  """
4714
- Unfreeze an index. When a frozen index is unfrozen, the index goes through the
4715
- normal recovery process and becomes writeable again.
5125
+ .. raw:: html
5126
+
5127
+ <p>Unfreeze an index.
5128
+ When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.</p>
5129
+
4716
5130
 
4717
5131
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/unfreeze-index-api.html>`_
4718
5132
 
@@ -4786,7 +5200,11 @@ class IndicesClient(NamespacedClient):
4786
5200
  body: t.Optional[t.Dict[str, t.Any]] = None,
4787
5201
  ) -> ObjectApiResponse[t.Any]:
4788
5202
  """
4789
- Create or update an alias. Adds a data stream or index to an alias.
5203
+ .. raw:: html
5204
+
5205
+ <p>Create or update an alias.
5206
+ Adds a data stream or index to an alias.</p>
5207
+
4790
5208
 
4791
5209
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-aliases.html>`_
4792
5210
 
@@ -4861,7 +5279,11 @@ class IndicesClient(NamespacedClient):
4861
5279
  body: t.Optional[t.Dict[str, t.Any]] = None,
4862
5280
  ) -> ObjectApiResponse[t.Any]:
4863
5281
  """
4864
- Validate a query. Validates a query without running it.
5282
+ .. raw:: html
5283
+
5284
+ <p>Validate a query.
5285
+ Validates a query without running it.</p>
5286
+
4865
5287
 
4866
5288
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-validate.html>`_
4867
5289