DescribeRule
Describes a rule for the specified Amazon Connect instance.
Request Syntax
GET /rules/InstanceId
/RuleId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- RuleId
-
A unique identifier for the rule.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Rule": {
"Actions": [
{
"ActionType": "string",
"AssignContactCategoryAction": {
},
"CreateCaseAction": {
"Fields": [
{
"Id": "string",
"Value": {
"BooleanValue": boolean,
"DoubleValue": number,
"EmptyValue": {
},
"StringValue": "string"
}
}
],
"TemplateId": "string"
},
"EndAssociatedTasksAction": {
},
"EventBridgeAction": {
"Name": "string"
},
"SendNotificationAction": {
"Content": "string",
"ContentType": "string",
"DeliveryMethod": "string",
"Recipient": {
"UserIds": [ "string" ],
"UserTags": {
"string" : "string"
}
},
"Subject": "string"
},
"SubmitAutoEvaluationAction": {
"EvaluationFormId": "string"
},
"TaskAction": {
"ContactFlowId": "string",
"Description": "string",
"Name": "string",
"References": {
"string" : {
"Type": "string",
"Value": "string"
}
}
},
"UpdateCaseAction": {
"Fields": [
{
"Id": "string",
"Value": {
"BooleanValue": boolean,
"DoubleValue": number,
"EmptyValue": {
},
"StringValue": "string"
}
}
]
}
}
],
"CreatedTime": number,
"Function": "string",
"LastUpdatedBy": "string",
"LastUpdatedTime": number,
"Name": "string",
"PublishStatus": "string",
"RuleArn": "string",
"RuleId": "string",
"Tags": {
"string" : "string"
},
"TriggerEventSource": {
"EventSourceName": "string",
"IntegrationAssociationId": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: