PutCaseEventConfiguration
Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator Guide
Request Syntax
PUT /domains/domainId/case-event-configuration HTTP/1.1
Content-type: application/json
{
"eventBridge": {
"enabled": boolean,
"includedData": {
"caseData": {
"fields": [
{
"id": "string"
}
]
},
"relatedItemData": {
"includeContent": boolean
}
}
}
}URI Request Parameters
The request uses the following URI parameters.
- domainId
-
The unique identifier of the Cases domain.
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- eventBridge
-
Configuration to enable EventBridge case event delivery and determine what data is delivered.
Type: EventBridgeConfiguration object
Required: Yes
Response Syntax
HTTP/1.1 200
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.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
We couldn't process your request because of an issue with the server. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.
HTTP Status Code: 404
- ThrottlingException
-
The rate has been exceeded for this API. Please try again after a few minutes.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. Check the syntax and try again.
HTTP Status Code: 400
Examples
Request and Response example
This example illustrates one use of PutCaseEventConfiguration.
{
"enabled":true,
"includedData":{
"caseData":{
"fields":[
{
"id":"status"
},
{
"id":"title"
},
{
"id":"customer_id"
},
{
"id":"case_reason"
}
]
},
"relatedItemData":{
"includeContent":true
}
}}{ }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
