Subscribe
Creates an association between a notification rule and an Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client so that the associated target can receive notifications when the events described in the rule are triggered.
Request Syntax
POST /subscribe HTTP/1.1
Content-type: application/json
{
"Arn": "string",
"ClientRequestToken": "string",
"Target": {
"TargetAddress": "string",
"TargetType": "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Arn
-
The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.
Type: String
Pattern:
^arn:aws[^:\s]*:codestar-notifications:[^:\s]+:\d{12}:notificationrule\/(.*\S)?$Required: Yes
- ClientRequestToken
-
An enumeration token that, when provided in a request, returns the next batch of the results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[\w:/-]+$Required: No
- Target
-
Information about the Amazon Q Developer in chat applications topics or Amazon Q Developer in chat applications clients associated with a notification rule.
Type: Target object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "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.
- Arn
-
The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.
Type: String
Pattern:
^arn:aws[^:\s]*:codestar-notifications:[^:\s]+:\d{12}:notificationrule\/(.*\S)?$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConfigurationException
-
Some or all of the configuration is incomplete, missing, or not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
AWS CodeStar Notifications can't find a resource that matches the provided ARN.
HTTP Status Code: 404
- ValidationException
-
One or more parameter values are 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:
