BatchGetCaseRuleCommand

Suggest an Edit

Gets a batch of case rules. 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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectCasesClient, BatchGetCaseRuleCommand } from "@aws-sdk/client-connectcases"; // ES Modules import
// const { ConnectCasesClient, BatchGetCaseRuleCommand } = require("@aws-sdk/client-connectcases"); // CommonJS import
const client = new ConnectCasesClient(config);
const input = { // BatchGetCaseRuleRequest
  domainId: "STRING_VALUE", // required
  caseRules: [ // CaseRuleIdentifierList // required
    { // CaseRuleIdentifier
      id: "STRING_VALUE", // required
    },
  ],
};
const command = new BatchGetCaseRuleCommand(input);
const response = await client.send(command);
// { // BatchGetCaseRuleResponse
//   caseRules: [ // BatchGetCaseRuleList // required
//     { // GetCaseRuleResponse
//       caseRuleId: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       caseRuleArn: "STRING_VALUE", // required
//       rule: { // CaseRuleDetails Union: only one key present
//         required: { // RequiredCaseRule
//           defaultValue: true || false, // required
//           conditions: [ // BooleanConditionList // required
//             { // BooleanCondition Union: only one key present
//               equalTo: { // BooleanOperands
//                 operandOne: { // OperandOne Union: only one key present
//                   fieldId: "STRING_VALUE",
//                 },
//                 operandTwo: { // OperandTwo Union: only one key present
//                   stringValue: "STRING_VALUE",
//                   booleanValue: true || false,
//                   doubleValue: Number("double"),
//                   emptyValue: {},
//                 },
//                 result: true || false, // required
//               },
//               notEqualTo: {
//                 operandOne: {//  Union: only one key present
//                   fieldId: "STRING_VALUE",
//                 },
//                 operandTwo: {//  Union: only one key present
//                   stringValue: "STRING_VALUE",
//                   booleanValue: true || false,
//                   doubleValue: Number("double"),
//                   emptyValue: {},
//                 },
//                 result: true || false, // required
//               },
//             },
//           ],
//         },
//       },
//       description: "STRING_VALUE",
//       deleted: true || false,
//       createdTime: new Date("TIMESTAMP"),
//       lastModifiedTime: new Date("TIMESTAMP"),
//       tags: { // Tags
//         "<keys>": "STRING_VALUE",
//       },
//     },
//   ],
//   errors: [ // BatchGetCaseRuleErrorList // required
//     { // CaseRuleError
//       id: "STRING_VALUE", // required
//       errorCode: "STRING_VALUE", // required
//       message: "STRING_VALUE",
//     },
//   ],
// };

BatchGetCaseRuleCommand Input

See BatchGetCaseRuleCommandInput for more details

Parameter
Type
Description
caseRules
Required
CaseRuleIdentifier[] | undefined

List of case rule identifiers.

domainId
Required
string | undefined

Unique identifier of a Cases domain.

BatchGetCaseRuleCommand Output

See BatchGetCaseRuleCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
caseRules
Required
GetCaseRuleResponse[] | undefined

List of detailed case rule information.

errors
Required
CaseRuleError[] | undefined

List of case rule errors.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException
client

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ThrottlingException
client

The rate has been exceeded for this API. Please try again after a few minutes.

ValidationException
client

The request isn't valid. Check the syntax and try again.

ConnectCasesServiceException
Base exception class for all service exceptions from ConnectCases service.