Obtaining a Message Notification Configuration

Function

This API is used to obtain a message notification configuration.

Authorization Information

Each account root user 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:get	Read	notificationSetting *	-	-	-

URI

GET /v5/notification-settings/{notification_setting_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
notification_setting_id	Yes	String	Definition: Unique identifier of the message notification configuration. You can call ListNotificationSettings API. This API returns a list of message notification configurations. Each configuration summary object in the list contains a unique id field, which is the message notification configuration ID. Range: 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
id	String	Definition: Unique identifier of the message notification configuration. Range: 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
urn	String	Definition: Unique resource identifier of the message notification configuration. Range: The value contains 1 to 1,500 characters.
analyzer_id	String	Definition: Unique identifier of an analyzer. Range: 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
analyzer_name	String	Definition: Analyzer name. Range: 1 to 255 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
analyzer_type	String	Definition: Analyzer type. Range: 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	Definition: Whether to enable message notifications. Range: N/A
smn_topic_urns	Array of strings	Definition: URN list of SMN topics configured for message notifications. Range: The array length ranges from 0 to 3. The array element contains 1 to 1,500 characters.
created_at	String	Definition: Time when the message notification configuration is created. The UTC+0 time zone is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-07T07:51:10.502Z. Range: N/A
updated_at	String	Definition: Time when the message notification configuration was last updated. The UTC+0 time zone is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-07T07:51:10.502Z. Range: N/A

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A
request_id	String	Definition: Request ID. Range: N/A
encoded_authorization_message	String	Definition: Authentication information. Range: N/A

Status code: 403

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A
request_id	String	Definition: Request ID. Range: N/A
encoded_authorization_message	String	Definition: Authentication information. Range: N/A

Status code: 404

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A
request_id	String	Definition: Request ID. Range: N/A
encoded_authorization_message	String	Definition: Authentication information. Range: N/A

Example Requests

Obtaining a message notification configuration

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

Example Responses

Status code: 200

{
  "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"
}