Creates a new case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.
Request Syntax
POST /domains/domainId/case-rules HTTP/1.1
Content-type: application/json
{
"description": "string",
"name": "string",
"rule": { ... }
}URI Request Parameters
The request uses the following URI parameters.
- domainId
-
Unique identifier of a 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.
- description
-
The description of a case rule.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Required: No
- name
-
Name of the case rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^.*[\S]$Required: Yes
- rule
-
Represents what rule type should take place, under what conditions.
Type: CaseRuleDetails object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"caseRuleArn": "string",
"caseRuleId": "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.
- caseRuleArn
-
The Amazon Resource Name (ARN) of a case rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
- caseRuleId
-
Unique identifier of a case rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
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
- ConflictException
-
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
HTTP Status Code: 409
- 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
- ServiceQuotaExceededException
-
The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
HTTP Status Code: 402
- 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
Example
This example illustrates one usage of CreateCaseRule.
CreateCaseRule
POST /domains/domainId/case-rules HTTP/1.1
Content-type: application/json
{
"name": "RequiredIfStatusOpen",
"description": "Makes field required if status is set to Open",
"rule": {
"required": {
"conditions": [
{
"equalTo": {
"operandOne": {
"fieldId": "status"
},
"operandTwo": {
"doubleValue": "Open"
},
"result": true
}
}
],
"defaultValue": false
}
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
