PutNotificationChannel
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.
To perform this action outside of the console, you must first configure the SNS topic's access policy to allow the SnsRoleName to publish SNS logs. If the SnsRoleName provided is a role other than the AWSServiceRoleForFMS service-linked role, this role must have a trust relationship configured to allow the Firewall Manager service principal fms.amazonaws.com to assume this role. For information about configuring an SNS access policy, see
Service roles for Firewall Manager in the
AWS Firewall Manager Developer Guide.
Request Syntax
{
"SnsRoleName": "string",
"SnsTopicArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- SnsRoleName
-
The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record AWS Firewall Manager activity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$Required: Yes
- SnsTopicArn
-
The Amazon Resource Name (ARN) of the SNS topic that collects notifications from AWS Firewall Manager.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 400
- InvalidOperationException
-
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for AWS Organizations before you can access it.HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
