AssociateChannel
Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications,
the AWS Console Mobile Application, and emails (notifications-contacts).
Request Syntax
POST /channels/associate/arn HTTP/1.1
Content-type: application/json
{
"notificationConfigurationArn": "string"
}URI Request Parameters
The request uses the following URI parameters.
- arn
-
The Amazon Resource Name (ARN) of the Channel to associate with the
NotificationConfiguration.Supported ARNs include Amazon Q Developer in chat applications, the Console Mobile Application, and notifications-contacts.
Pattern:
arn:aws:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- notificationConfigurationArn
-
The ARN of the
NotificationConfigurationto associate with the Channel.Type: String
Pattern:
arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}Required: Yes
Response Syntax
HTTP/1.1 201
Response Elements
If the action is successful, the service sends back an HTTP 201 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
User does not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
Unexpected error during processing of request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Request references a resource which does not exist.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
Request would cause a service quota to be exceeded.
HTTP Status Code: 402
- ThrottlingException
-
Request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
This exception is thrown when the notification event fails validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
