AddNotificationChannel
Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics.
Request Syntax
PUT /channels HTTP/1.1
Content-type: application/json
{
"Config": {
"Filters": {
"MessageTypes": [ "string
" ],
"Severities": [ "string
" ]
},
"Sns": {
"TopicArn": "string
"
}
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Config
-
A
NotificationChannelConfig
object that specifies what type of notification channel to add. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).Type: NotificationChannelConfig object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Id": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Id
-
The ID of the added notification channel.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
HTTP Status Code: 403
- ConflictException
-
An exception that is thrown when a conflict occurs.
HTTP Status Code: 409
- InternalServerException
-
An internal failure in an Amazon service occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
A requested resource could not be found
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The request contains a value that exceeds a maximum quota.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to a request throttling.
HTTP Status Code: 429
- ValidationException
-
Contains information about data passed in to a field during a request that is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: