NAME
OpenSearch::Client::Core::3_0::Direct::Notifications
VERSION
version 3.007009
SYNOPSIS
use OpenSearch::Client;
my $client = OpenSearch::Client->new( ... );
my $response = $client->notifications-><methodname>(
valone => $value1,
valtwo => $value2
);DESCRIPTION
Notifications
The Notifications plugin provides a central location for all of your notifications from OpenSearch plugins. Using the plugin, you can configure which communication service you want to use and see relevant statistics and troubleshooting information. Currently, the Alerting and ISM plugins have integrated with the Notifications plugin.
See OpenSearch documentation for notifications.
METHODS
create_config
Create channel configuration.
Paths served by this method:
Method added in OpenSearch version 2.0
$resp = $client->notifications->create_config(
'body' => $body, # optional
# 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 notifications->create_config
delete_config
Delete a channel configuration.
Paths served by this method:
Method added in OpenSearch version 2.0
$resp = $client->notifications->delete_config(
# path parameters
'config_id' => $config_id, # 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 notifications->delete_config
delete_configs
Delete multiple channel configurations.
Paths served by this method:
Method added in OpenSearch version 2.2
$resp = $client->notifications->delete_configs(
# Endpoint specific query string parameters
'config_id' => $qval1, # string
'config_id_list' => $qval2, # string
# 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 notifications->delete_configs
get_config
Get a specific channel configuration.
Paths served by this method:
Method added in OpenSearch version 2.0
$resp = $client->notifications->get_config(
# path parameters
'config_id' => $config_id, # 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 notifications->get_config
get_configs
Get multiple channel configurations with filtering.
Paths served by this method:
Method added in OpenSearch version 2.0
$resp = $client->notifications->get_configs(
'body' => $body, # optional
# Endpoint specific query string parameters
'chime.url' => $qval1, # string
'chime.url.keyword' => $qval2, # string
'config_id' => $qval3, # string
'config_id_list' => $qval4, # list
'config_type' => $qval5, # string
'created_time_ms' => $qval6, # number
'description' => $qval7, # string
'description.keyword' => $qval8, # string
'email.email_account_id' => $qval9, # string
'email.email_group_id_list' => $qval10, # string
'email.recipient_list.recipient' => $qval11, # string
'email.recipient_list.recipient.keyword' => $qval12, # string
'email_group.recipient_list.recipient' => $qval13, # string
'email_group.recipient_list.recipient.keyword' => $qval14, # string
'is_enabled' => $qval15, # boolean
'last_updated_time_ms' => $qval16, # number
'microsoft_teams.url' => $qval17, # string
'microsoft_teams.url.keyword' => $qval18, # string
'name' => $qval19, # string
'name.keyword' => $qval20, # string
'query' => $qval21, # string
'ses_account.from_address' => $qval22, # string
'ses_account.from_address.keyword' => $qval23, # string
'ses_account.region' => $qval24, # string
'ses_account.role_arn' => $qval25, # string
'ses_account.role_arn.keyword' => $qval26, # string
'slack.url' => $qval27, # string
'slack.url.keyword' => $qval28, # string
'smtp_account.from_address' => $qval29, # string
'smtp_account.from_address.keyword' => $qval30, # string
'smtp_account.host' => $qval31, # string
'smtp_account.host.keyword' => $qval32, # string
'smtp_account.method' => $qval33, # string
'sns.role_arn' => $qval34, # string
'sns.role_arn.keyword' => $qval35, # string
'sns.topic_arn' => $qval36, # string
'sns.topic_arn.keyword' => $qval37, # string
'text_query' => $qval38, # string
'webhook.url' => $qval39, # string
'webhook.url.keyword' => $qval40, # string
# Common API query string parameters
'error_trace' => $qval41, # boolean
'filter_path' => $qval42, # list
'human' => $qval43, # boolean
'pretty' => $qval44, # boolean
'source' => $qval45, # string
);OpenSearch documentation for notifications->get_configs
list_channels
List created notification channels.
Paths served by this method:
Method added in OpenSearch version 2.0
$resp = $client->notifications->list_channels(
# 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 notifications->list_channels
list_features
List supported channel configurations.
Paths served by this method:
Method added in OpenSearch version 2.0
$resp = $client->notifications->list_features(
# 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 notifications->list_features
send_test
Send a test notification.
Paths served by this method:
GET /_plugins/_notifications/feature/test/{config_id}POST /_plugins/_notifications/feature/test/{config_id}
Method added in OpenSearch version 2.0
$resp = $client->notifications->send_test(
# path parameters
'config_id' => $config_id, # 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 notifications->send_test
update_config
Update channel configuration.
Paths served by this method:
Method added in OpenSearch version 2.0
$resp = $client->notifications->update_config(
'body' => $body, # optional
# path parameters
'config_id' => $config_id, # 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 notifications->update_config
method_supported_in_version
Return whether a method in this module namespace is supported for an OpenSearch server version
my $boolean = $os->notifications->method_supported_in_version(
method => 'create_config',
version => '2.4.0'
);Both method and version are required.
See also global_method_supported_in_version
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