iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn synced 2025-02-06 11:48:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Comments

Browse Source 
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
This commit is contained in:
keithhc2 2022-05-18 17:21:52 -07:00
parent f30555ca65
commit 8529563bab
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
_notifications-plugin/api.md
View File

@ -8,7 +8,7 @@ redirect_from:
# Notifications API
If you want to programmatically define your notifications channels and sources for versioning and reuse, you can use the REST API to define, configure, and delete notification channels, as well as send test messages.
If you want to programmatically define your notifications channels and sources for versioning and reuse, you can use the Notifications REST API to define, configure, and delete notification channels, as well as send test messages.
---
@ -20,7 +20,7 @@ If you want to programmatically define your notifications channels and sources f
## List supported channel types
Lists supported channel types.
Returns a list of supported channel types.
#### Sample Request
@ -102,15 +102,15 @@ You can include query parameters in your request path to filter the notification
Parameter | Description
:--- | :---
config_id | identifier of a channel.
config_id_list | Comma-separated list of channel IDs.
config_id | Specifies the channel identifier.
config_id_list | Specifies a comma-separated list of channel IDs.
from_index | The starting index to search from.
max_items | The maximum amount of items to return in your request.
sort_order | Specifies the direction to sort results in. Valid options are asc and desc.
sort_order | Specifies the direction to sort results in. Valid options are `asc` and `desc`.
sort_field | Field to sort results with.
last_updated_time_ms | The unix time in milliseconds of when the channel was last updated.
created_time_ms | The unix time in milliseconds of when the channel was created.
is_enabled | Whether the channel is enabled.
is_enabled | Indicates whether the channel is enabled.
config_type | The channel type. Valid options are `sns`, `slack`, `chime`, `webhook`, `smtp_account`, `ses_account`, `email_group`, `email`.
name | The channel's name.
description | The channel's description.
@ -163,7 +163,7 @@ config | Object | Contains all of relevant information such as channel name, con
name | String | Name of the channel. | Yes
description | String | The channel's description. | No
config_type | String | The destination of your notification. Valid options are `sns`, `slack`, `chime`, `webhook`, `smtp_account`, `ses_account`, `email_group`, `email`. | Yes
is_enabled | Boolean | Whether to enable to channel for sending and receiving notifications. Default is true. | No
is_enabled | Boolean | Whether the channel is enabled for sending and receiving notifications. Default is true. | No
The create channel operation accepts multiple `config_types` as possible notification destinations, so follow the format for your preferred `config_type`.

6
_notifications-plugin/index.md
View File

@ -14,7 +14,7 @@ The notifications plugin provides a central location for all of your notificatio
You can use either OpenSearch Dashboards or the REST API to configure notifications. Dashboards offers a more organized way of selecting a channel type and selecting which OpenSearch plugin sources you want to use, whereas the REST API lets you programmatically define your notification channels for better versioning and reuse later on.
1. Use the Dashboards UI to first create a channel that receives notifications from other plugins. Supported communication channels include Amazon Chime, Amazon SNS, Email, Slack, and custom webhooks when selecting how you want the plugin to send notifications. After you’ve configured your channel and plugin sources, send messages and start tracking your notifications from the notifications plugin’s Dashboard.
2. Use the Notifications REST API to configure all of the settings of your channel. To use the API, you must prepare your notification’s details beforehand, which contains the notification’s name, description, channel type, which OpenSearch plugins to use as sources, and other associated URLs or groups.
2. Use the Notifications REST API to configure all of the settings of your channel. To use the API, you must have your notification’s details that contain the notification’s name, description, channel type, which OpenSearch plugins to use as sources, and other associated URLs or groups.
## Create a channel
@ -36,8 +36,8 @@ OpenSearch supports Amazon SNS for notifications. This integration with Amazon S
The notifications plugin currently supports two ways of user authentication:
1. Providing the user with full access to Amazon SNS.
2. Letting the user assume an IAM role that has permissions to Amazon SNS. Once you configure the notification channel to use the right Amazon SNS permissions, select the OpenSearch plugins that can trigger notifications.
1. Provide the user with full access to Amazon SNS.
2. Let the user assume an IAM role that has permissions to access Amazon SNS. Once you configure the notification channel to use the right Amazon SNS permissions, select the OpenSearch plugins that can trigger notifications.
### Provide full Amazon SNS access permissions