@@ -571,8 +571,8 @@ async def create_data_stream(
571
571
pretty : t .Optional [bool ] = None ,
572
572
) -> ObjectApiResponse [t .Any ]:
573
573
"""
574
- Creates a data stream. You must have a matching index template with data stream
575
- enabled.
574
+ Create a data stream. Creates a data stream. You must have a matching index template
575
+ with data stream enabled.
576
576
577
577
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html>`_
578
578
@@ -624,7 +624,7 @@ async def data_streams_stats(
624
624
pretty : t .Optional [bool ] = None ,
625
625
) -> ObjectApiResponse [t .Any ]:
626
626
"""
627
- Retrieves statistics for one or more data streams.
627
+ Get data stream stats. Retrieves statistics for one or more data streams.
628
628
629
629
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html>`_
630
630
@@ -825,8 +825,8 @@ async def delete_data_lifecycle(
825
825
timeout : t .Optional [t .Union ["t.Literal[-1]" , "t.Literal[0]" , str ]] = None ,
826
826
) -> ObjectApiResponse [t .Any ]:
827
827
"""
828
- Removes the data lifecycle from a data stream rendering it not managed by the
829
- data stream lifecycle
828
+ Delete data stream lifecycles. Removes the data stream lifecycle from a data
829
+ stream, rendering it not managed by the data stream lifecycle.
830
830
831
831
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html>`_
832
832
@@ -885,7 +885,7 @@ async def delete_data_stream(
885
885
pretty : t .Optional [bool ] = None ,
886
886
) -> ObjectApiResponse [t .Any ]:
887
887
"""
888
- Deletes one or more data streams and their backing indices.
888
+ Delete data streams. Deletes one or more data streams and their backing indices.
889
889
890
890
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html>`_
891
891
@@ -934,9 +934,10 @@ async def delete_index_template(
934
934
timeout : t .Optional [t .Union ["t.Literal[-1]" , "t.Literal[0]" , str ]] = None ,
935
935
) -> ObjectApiResponse [t .Any ]:
936
936
"""
937
- The provided <index-template> may contain multiple template names separated by
938
- a comma. If multiple template names are specified then there is no wildcard support
939
- and the provided names should match completely with existing templates.
937
+ Delete an index template. The provided <index-template> may contain multiple
938
+ template names separated by a comma. If multiple template names are specified
939
+ then there is no wildcard support and the provided names should match completely
940
+ with existing templates.
940
941
941
942
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html>`_
942
943
@@ -1396,7 +1397,8 @@ async def exists_template(
1396
1397
pretty : t .Optional [bool ] = None ,
1397
1398
) -> HeadApiResponse :
1398
1399
"""
1399
- Returns information about whether a particular index template exists.
1400
+ Check existence of index templates. Returns information about whether a particular
1401
+ index template exists.
1400
1402
1401
1403
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-template-exists-v1.html>`_
1402
1404
@@ -1955,7 +1957,8 @@ async def get_data_lifecycle(
1955
1957
pretty : t .Optional [bool ] = None ,
1956
1958
) -> ObjectApiResponse [t .Any ]:
1957
1959
"""
1958
- Retrieves the data stream lifecycle configuration of one or more data streams.
1960
+ Get data stream lifecycles. Retrieves the data stream lifecycle configuration
1961
+ of one or more data streams.
1959
1962
1960
1963
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html>`_
1961
1964
@@ -2014,7 +2017,7 @@ async def get_data_stream(
2014
2017
pretty : t .Optional [bool ] = None ,
2015
2018
) -> ObjectApiResponse [t .Any ]:
2016
2019
"""
2017
- Retrieves information about one or more data streams.
2020
+ Get data streams. Retrieves information about one or more data streams.
2018
2021
2019
2022
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html>`_
2020
2023
@@ -2160,7 +2163,7 @@ async def get_index_template(
2160
2163
pretty : t .Optional [bool ] = None ,
2161
2164
) -> ObjectApiResponse [t .Any ]:
2162
2165
"""
2163
- Returns information about one or more index templates.
2166
+ Get index templates. Returns information about one or more index templates.
2164
2167
2165
2168
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html>`_
2166
2169
@@ -2412,7 +2415,7 @@ async def get_template(
2412
2415
pretty : t .Optional [bool ] = None ,
2413
2416
) -> ObjectApiResponse [t .Any ]:
2414
2417
"""
2415
- Retrieves information about one or more index templates.
2418
+ Get index templates. Retrieves information about one or more index templates.
2416
2419
2417
2420
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html>`_
2418
2421
@@ -2469,14 +2472,14 @@ async def migrate_to_data_stream(
2469
2472
pretty : t .Optional [bool ] = None ,
2470
2473
) -> ObjectApiResponse [t .Any ]:
2471
2474
"""
2472
- Converts an index alias to a data stream. You must have a matching index template
2473
- that is data stream enabled. The alias must meet the following criteria: The
2474
- alias must have a write index; All indices for the alias must have a `@timestamp`
2475
- field mapping of a `date` or `date_nanos` field type; The alias must not have
2476
- any filters ; The alias must not use custom routing. If successful, the request
2477
- removes the alias and creates a data stream with the same name. The indices for
2478
- the alias become hidden backing indices for the stream. The write index for the
2479
- alias becomes the write index for the stream.
2475
+ Convert an index alias to a data stream. Converts an index alias to a data stream.
2476
+ You must have a matching index template that is data stream enabled. The alias
2477
+ must meet the following criteria: The alias must have a write index; All indices
2478
+ for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos`
2479
+ field type ; The alias must not have any filters; The alias must not use custom
2480
+ routing. If successful, the request removes the alias and creates a data stream
2481
+ with the same name. The indices for the alias become hidden backing indices for
2482
+ the stream. The write index for the alias becomes the write index for the stream.
2480
2483
2481
2484
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html>`_
2482
2485
@@ -2519,7 +2522,8 @@ async def modify_data_stream(
2519
2522
body : t .Optional [t .Dict [str , t .Any ]] = None ,
2520
2523
) -> ObjectApiResponse [t .Any ]:
2521
2524
"""
2522
- Performs one or more data stream modification actions in a single atomic operation.
2525
+ Update data streams. Performs one or more data stream modification actions in
2526
+ a single atomic operation.
2523
2527
2524
2528
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html>`_
2525
2529
@@ -2821,7 +2825,8 @@ async def put_data_lifecycle(
2821
2825
body : t .Optional [t .Dict [str , t .Any ]] = None ,
2822
2826
) -> ObjectApiResponse [t .Any ]:
2823
2827
"""
2824
- Update the data lifecycle of the specified data streams.
2828
+ Update data stream lifecycles. Update the data stream lifecycle of the specified
2829
+ data streams.
2825
2830
2826
2831
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html>`_
2827
2832
@@ -2924,7 +2929,7 @@ async def put_index_template(
2924
2929
body : t .Optional [t .Dict [str , t .Any ]] = None ,
2925
2930
) -> ObjectApiResponse [t .Any ]:
2926
2931
"""
2927
- Creates or updates an index template. Index templates define settings, mappings,
2932
+ Create or update an index template. Index templates define settings, mappings,
2928
2933
and aliases that can be applied automatically to new indices.
2929
2934
2930
2935
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html>`_
@@ -3326,7 +3331,7 @@ async def put_template(
3326
3331
body : t .Optional [t .Dict [str , t .Any ]] = None ,
3327
3332
) -> ObjectApiResponse [t .Any ]:
3328
3333
"""
3329
- Creates or updates an index template. Index templates define settings, mappings,
3334
+ Create or update an index template. Index templates define settings, mappings,
3330
3335
and aliases that can be applied automatically to new indices.
3331
3336
3332
3337
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html>`_
@@ -4081,7 +4086,8 @@ async def simulate_index_template(
4081
4086
pretty : t .Optional [bool ] = None ,
4082
4087
) -> ObjectApiResponse [t .Any ]:
4083
4088
"""
4084
-
4089
+ Simulate an index. Returns the index configuration that would be applied to the
4090
+ specified index from an existing index template.
4085
4091
4086
4092
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html>`_
4087
4093
@@ -4160,7 +4166,8 @@ async def simulate_template(
4160
4166
body : t .Optional [t .Dict [str , t .Any ]] = None ,
4161
4167
) -> ObjectApiResponse [t .Any ]:
4162
4168
"""
4163
- Returns the index configuration that would be applied by a particular index template.
4169
+ Simulate an index template. Returns the index configuration that would be applied
4170
+ by a particular index template.
4164
4171
4165
4172
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html>`_
4166
4173
0 commit comments