Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateRule

Updates a rule for the specified Amazon Connect instance.

Use the Rules Function language to code conditions for the rule.

Request Syntax


PUT /rules/InstanceId/RuleId HTTP/1.1
Content-type: application/json

{
   "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" : { 
                  "Arn": "string",
                  "Status": "string",
                  "StatusReason": "string",
                  "Type": "string",
                  "Value": "string"
               }
            }
         },
         "UpdateCaseAction": { 
            "Fields": [ 
               { 
                  "Id": "string",
                  "Value": { 
                     "BooleanValue": boolean,
                     "DoubleValue": number,
                     "EmptyValue": { 
                     },
                     "StringValue": "string"
                  }
               }
            ]
         }
      }
   ],
   "Function": "string",
   "Name": "string",
   "PublishStatus": "string"
}

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 accepts the following data in JSON format.

Actions

A list of actions to be run when the rule is triggered.

Type: Array of RuleAction objects

Required: Yes

Function

The conditions of the rule.

Type: String

Required: Yes

Name

The name of the rule. You can change the name only if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z._-]+

Required: Yes

PublishStatus

The publish status of the rule.

Type: String

Valid Values: DRAFT | PUBLISHED

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 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

ResourceConflictException

A resource already has that name.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429