[[reference-ilm-explain_lifecycle]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.ilm.explainLifecycle

Retrieves information about the index’s current lifecycle state, such as the currently executing phase, action, and step. Shows when the index entered each one, the definition of the running phase, and information about any failures.

{ref}/ilm-explain-lifecycle.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(IlmExplainLifecycleRequest, options?): Promise<IlmExplainLifecycleResponse>
----

[discrete]
===== `IlmExplainLifecycleRequest`

[source,ts]
----
interface IlmExplainLifecycleRequest extends <<shared-type-request-base, RequestBase>> {
  index: <<shared-type-index-name, IndexName>>
  only_errors?: boolean
  only_managed?: boolean
  master_timeout?: <<shared-type-duration, Duration>>
  timeout?: <<shared-type-duration, Duration>>
}
----

[discrete]
===== `IlmExplainLifecycleResponse`

[source,ts]
----
interface IlmExplainLifecycleResponse {
  indices: Record<<<shared-type-index-name, IndexName>>, IlmExplainLifecycleLifecycleExplain>
}
----