NAME
OpenSearch::Client::Core::3_0::Direct::SnapshotManagement
VERSION
version 3.007002
SYNOPSIS
use OpenSearch::Client;
my $client = OpenSearch::Client->new( ... );
my $response = $client->sm-><methodname>(
valone => $value1,
valtwo => $value2
);DESCRIPTION
Snapshot Management API
Use the Snapshot Management (SM) API to automate taking snapshots.
See OpenSearch documentation for sm.
METHODS
sm->create_policy
Creates a snapshot management policy.
Paths served by this method:
$resp = $client->sm->create_policy(
'body' => $body, # optional
# path parameters
'policy_name' => $policy_name, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for sm.create_policy
sm->delete_policy
Deletes a snapshot management policy.
Paths served by this method:
$resp = $client->sm->delete_policy(
# path parameters
'policy_name' => $policy_name, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for sm.delete_policy
sm->explain_policy
Explains the state of the snapshot management policy.
Paths served by this method:
$resp = $client->sm->explain_policy(
# path parameters
'policy_name' => $policy_name, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for sm.explain_policy
sm->get_policies
Retrieves all snapshot management policies with optional pagination and filtering.
Paths served by this method:
$resp = $client->sm->get_policies(
# Endpoint specific query string parameters
'from' => $qval1, # number
'queryString' => $qval2, # string
'size' => $qval3, # number
'sortField' => $qval4, # string
'sortOrder' => $qval5, # string
# Common API query string parameters
'error_trace' => $qval6, # boolean
'filter_path' => $qval7, # list
'human' => $qval8, # boolean
'pretty' => $qval9, # boolean
'source' => $qval10, # string
);OpenSearch documentation for sm.get_policies
sm->get_policy
Retrieves a specific snapshot management policy by name.
Paths served by this method:
$resp = $client->sm->get_policy(
# path parameters
'policy_name' => $policy_name, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for sm.get_policy
sm->start_policy
Starts a snapshot management policy.
Paths served by this method:
$resp = $client->sm->start_policy(
# path parameters
'policy_name' => $policy_name, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for sm.start_policy
sm->stop_policy
Stops a snapshot management policy.
Paths served by this method:
$resp = $client->sm->stop_policy(
# path parameters
'policy_name' => $policy_name, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for sm.stop_policy
sm->update_policy
Updates an existing snapshot management policy. Requires `if_seq_no` and `if_primary_term`.
Paths served by this method:
$resp = $client->sm->update_policy(
'body' => $body, # optional
# path parameters
'policy_name' => $policy_name, # required
# Endpoint specific query string parameters
'if_primary_term' => $qval1, # number
'if_seq_no' => $qval2, # number
# Common API query string parameters
'error_trace' => $qval3, # boolean
'filter_path' => $qval4, # list
'human' => $qval5, # boolean
'pretty' => $qval6, # boolean
'source' => $qval7, # string
);OpenSearch documentation for sm.update_policy
MANUAL
Documentation index OpenSearch::Client::Manual
HISTORY
This distribution is derived from Search::Elasticsearch version 7.714. All subsequent changes are unique to this distribution.
AUTHOR
Mark Dootson <mdootson@cpan.org> ( current maintainer )
CREDITS
OpenSearch::Client is based on Search::Elasticsearch version 7.714 by Enrico Zimuel <enrico.zimuel@elastic.co>.
COPYRIGHT AND LICENSE
Copyright (C) 2026 by Mark Dootson ( this distribution )
Copyright (C) 2021 by Elasticsearch BV ( original distribution )
This is free software, licensed under:
The Apache License, Version 2.0, January 2004