Execute Snapshot Lifecycle Policy APIedit


The Execute Snapshot Lifecycle Policy API allows you to execute a Snapshot Lifecycle Management Policy, taking a snapshot immediately.

ExecuteSnapshotLifecyclePolicyRequest executeRequest =
    new ExecuteSnapshotLifecyclePolicyRequest("policy_id"); 

The policy id to execute


The returned ExecuteSnapshotLifecyclePolicyResponse contains the name of the snapshot that was created.

final String snapshotName = executeResponse.getSnapshotName(); 

The created snapshot name

Synchronous executionedit

When executing a ExecuteSnapshotLifecyclePolicyRequest in the following manner, the client waits for the ExecuteSnapshotLifecyclePolicyResponse to be returned before continuing with code execution:

ExecuteSnapshotLifecyclePolicyResponse executeResponse =

Synchronous calls may throw an IOException in case of either failing to parse the REST response in the high-level REST client, the request times out or similar cases where there is no response coming back from the server.

In cases where the server returns a 4xx or 5xx error code, the high-level client tries to parse the response body error details instead and then throws a generic ElasticsearchException and adds the original ResponseException as a suppressed exception to it.

Asynchronous executionedit

Executing a ExecuteSnapshotLifecyclePolicyRequest can also be done in an asynchronous fashion so that the client can return directly. Users need to specify how the response or potential failures will be handled by passing the request and a listener to the asynchronous slm-execute-snapshot-lifecycle-policy method:

        RequestOptions.DEFAULT, executeListener); 

The ExecuteSnapshotLifecyclePolicyRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for slm-execute-snapshot-lifecycle-policy looks like:

ActionListener<ExecuteSnapshotLifecyclePolicyResponse> executeListener =
        new ActionListener<ExecuteSnapshotLifecyclePolicyResponse>() {
    public void onResponse(ExecuteSnapshotLifecyclePolicyResponse r) {
        String snapshotName = r.getSnapshotName(); 

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole ExecuteSnapshotLifecyclePolicyRequest fails.