Obtaining the Message Notification Configuration List

Function

This API is used to obtain the message notification configuration list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
AccessAnalyzer:notificationSetting:list	Read	notificationSetting *	-	-	-

URI

GET /v5/notification-settings

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results on a page Minimum: 1 Maximum: 200 Default: 100
marker	No	String	Page marker Minimum: 4 Maximum: 400

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
notification_settings	Array of NotificationSettingSummary objects	Message notification configuration list.
page_info	PageInfo object	Information on the page

**Table 3** NotificationSettingSummary
Parameter	Type	Description
id	String	Unique identifier of the message notification configuration.
urn	String	Unique resource identifier of the message notification configuration.
analyzer_id	String	Unique identifier of an analyzer
analyzer_name	String	Name of an analyzer
analyzer_type	String	Type of an access analyzer. account: account-level external access analyzer organization: organization-level external access analyzer account_unused_access: account-level unused access analyzer organization_unused_access: organization-level unused access analyzer account_privilege_escalation: account-level privilege escalation access analyzer account_iam_best_practice: account-level IAM best practice analyzer
mc_switch	Boolean	Whether to enable message notifications.
smn_topic_urns	Array of strings	URN list of SMN topics configured for message notifications.
created_at	String	Time when the message notification configuration is created.
updated_at	String	Time when the message notification configuration was last updated.

**Table 4** PageInfo
Parameter	Type	Description
current_count	Integer	Number of items on the current page
next_marker	String	If present, it indicates that the available output is more than the output contained in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this operation until the next_marker response returns null.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.
encoded_authorization_message	String	Authentication information.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.
encoded_authorization_message	String	Authentication information.

Example Requests

Obtaining the message notification configuration list

GET https://{hostname}/v5/notification-settings

Example Responses

Status code: 200

{
  "notification_settings" : [ {
    "id" : "{notification_setting_id}",
    "urn" : "AccessAnalyzer:{region_id}:{domain_id}:notificationSetting:{notification_setting_id}",
    "analyzer_id" : "3de500b3f6c74b0a8ef170656f8a6376",
    "analyzer_type" : "account",
    "analyzer_name" : "external_analyzer_1",
    "mc_switch" : true,
    "smn_topic_urns" : [ "urn:smn:cn-north-7:******:test1" ],
    "created_at" : "2023-09-07T08:04:41.698Z",
    "updated_at" : "2023-09-07T08:04:41.698Z"
  }, {
    "id" : "{notification_setting_id}",
    "urn" : "AccessAnalyzer:{region_id}:{domain_id}:notificationSetting:{notification_setting_id}",
    "analyzer_id" : "7d866d909fda4e32b1fc2aae45c34a97",
    "analyzer_type" : "account",
    "analyzer_name" : "external_analyzer_2",
    "mc_switch" : true,
    "smn_topic_urns" : [ "urn:smn:cn-north-7:******:test1" ],
    "created_at" : "2023-09-07T08:04:41.698Z",
    "updated_at" : "2023-09-07T08:04:41.698Z"
  } ],
  "page_info" : {
    "current_count" : 2,
    "next_marker" : null
  }
}