Class OpenSearch\Namespaces\NotificationsNamespace

Create channel configuration.

$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

Delete a channel configuration.

$params['config_id'] = (string) The ID of the channel configuration to delete. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

Delete multiple channel configurations.

$params['config_id'] = (string) The ID of the channel configuration to delete. $params['config_id_list'] = (string) A comma-separated list of channel IDs to delete. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

Get a specific channel configuration.

$params['config_id'] = (string) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

Get multiple channel configurations with filtering.

$params['chime.url'] = (string) $params['chime.url.keyword'] = (string) $params['config_id'] = (string) Notification configuration ID. $params['config_id_list'] = (array) Notification configuration IDs. $params['config_type'] = (enum) Type of notification configuration. (Options = chime,email,email_group,microsoft_teams,ses_account,slack,smtp_account,sns,webhook) $params['created_time_ms'] = (integer) $params['description'] = (string) $params['description.keyword'] = (string) $params['email.email_account_id'] = (string) $params['email.email_group_id_list'] = (string) $params['email.recipient_list.recipient'] = (string) $params['email.recipient_list.recipient.keyword'] = (string) $params['email_group.recipient_list.recipient'] = (string) $params['email_group.recipient_list.recipient.keyword'] = (string) $params['is_enabled'] = (boolean) $params['last_updated_time_ms'] = (integer) $params['microsoft_teams.url'] = (string) $params['microsoft_teams.url.keyword'] = (string) $params['name'] = (string) $params['name.keyword'] = (string) $params['query'] = (string) $params['ses_account.from_address'] = (string) $params['ses_account.from_address.keyword'] = (string) $params['ses_account.region'] = (string) $params['ses_account.role_arn'] = (string) $params['ses_account.role_arn.keyword'] = (string) $params['slack.url'] = (string) $params['slack.url.keyword'] = (string) $params['smtp_account.from_address'] = (string) $params['smtp_account.from_address.keyword'] = (string) $params['smtp_account.host'] = (string) $params['smtp_account.host.keyword'] = (string) $params['smtp_account.method'] = (string) $params['sns.role_arn'] = (string) $params['sns.role_arn.keyword'] = (string) $params['sns.topic_arn'] = (string) $params['sns.topic_arn.keyword'] = (string) $params['text_query'] = (string) $params['webhook.url'] = (string) $params['webhook.url.keyword'] = (string) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

List created notification channels.

$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

List supported channel configurations.

$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

Send a test notification.

$params['config_id'] = (string) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".

Update channel configuration.

$params['config_id'] = (string) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".