case_rules

Creates, updates, deletes, gets or lists a case_rules resource.

Overview

Name	case_rules
Type	Resource
Id	aws.connectcases.case_rules

Fields

The following fields are returned by SELECT queries:

batch_get_case_rule

Name	Datatype	Description
case_rules	array	A list of detailed case rule information.
errors	array	A list of case rule errors.
unprocessed_case_rules	array	A list of unprocessed case rule identifiers.

list_case_rules

Name	Datatype	Description
name	string	Name of the case rule. (pattern: <code>.*[\S]</code>)
case_rule_arn	string	The Amazon Resource Name (ARN) of the case rule.
case_rule_id	string	Unique identifier of a case rule.
description	string	Description of a case rule.
rule_type	string	Possible types for a rule. (Required, Hidden, FieldOptions)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_case_rule	select	domain_id, region		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.
list_case_rules	select	domain_id, region	maxResults, nextToken	Lists all case rules in a Cases domain. 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.
create_case_rule	insert	domain_id, region, name, rule		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.
update_case_rule	update	domain_id, case_rule_id, region		Updates a 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.
delete_case_rule	delete	domain_id, case_rule_id, region		Deletes a 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
case_rule_id	string	Unique identifier of a case rule.
domain_id	string	Unique identifier of a Cases domain.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

batch_get_case_rule

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.

SELECT
case_rules,
errors,
unprocessed_case_rules
FROM aws.connectcases.case_rules
WHERE domain_id = '{{ domain_id }}' -- required
AND region = '{{ region }}' -- required
;

list_case_rules

Lists all case rules in a Cases domain. 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.

SELECT
name,
case_rule_arn,
case_rule_id,
description,
rule_type
FROM aws.connectcases.case_rules
WHERE domain_id = '{{ domain_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_case_rule

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.

INSERT INTO aws.connectcases.case_rules (
name,
description,
rule,
domain_id,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ rule }}' /* required */,
'{{ domain_id }}',
'{{ region }}'
RETURNING
case_rule_arn,
case_rule_id
;

Manifest

# Description fields are for documentation purposes
- name: case_rules
props:
  - name: domain_id
    value: "{{ domain_id }}"
    description: Required parameter for the case_rules resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the case_rules resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: rule
    description: |
      Represents what rule type should take place, under what conditions. 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.
    value:
      required_:
        defaultValue: {{ defaultValue }}
        conditions:
          - equalTo:
              operandOne:
                fieldId: "{{ fieldId }}"
              operandTwo:
                stringValue: "{{ stringValue }}"
                booleanValue: {{ booleanValue }}
                doubleValue: {{ doubleValue }}
                emptyValue: "{{ emptyValue }}"
              result: {{ result }}
            notEqualTo:
              operandOne:
                fieldId: "{{ fieldId }}"
              operandTwo:
                stringValue: "{{ stringValue }}"
                booleanValue: {{ booleanValue }}
                doubleValue: {{ doubleValue }}
                emptyValue: "{{ emptyValue }}"
              result: {{ result }}
            andAll:
              conditions:
                - equalTo:
                    operandOne: "{{ operandOne }}"
                    operandTwo: "{{ operandTwo }}"
                    result: {{ result }}
                  notEqualTo:
                    operandOne: "{{ operandOne }}"
                    operandTwo: "{{ operandTwo }}"
                    result: {{ result }}
                  andAll:
                    conditions: "{{ conditions }}"
                  orAll:
                    conditions: "{{ conditions }}"
            orAll:
              conditions:
                - equalTo:
                    operandOne: "{{ operandOne }}"
                    operandTwo: "{{ operandTwo }}"
                    result: {{ result }}
                  notEqualTo:
                    operandOne: "{{ operandOne }}"
                    operandTwo: "{{ operandTwo }}"
                    result: {{ result }}
                  andAll:
                    conditions: "{{ conditions }}"
                  orAll:
                    conditions: "{{ conditions }}"
      fieldOptions:
        parentFieldId: "{{ parentFieldId }}"
        childFieldId: "{{ childFieldId }}"
        parentChildFieldOptionsMappings:
          - parentFieldOptionValue: "{{ parentFieldOptionValue }}"
            childFieldOptionValues: "{{ childFieldOptionValues }}"
      hidden:
        defaultValue: {{ defaultValue }}
        conditions:
          - equalTo:
              operandOne:
                fieldId: "{{ fieldId }}"
              operandTwo:
                stringValue: "{{ stringValue }}"
                booleanValue: {{ booleanValue }}
                doubleValue: {{ doubleValue }}
                emptyValue: "{{ emptyValue }}"
              result: {{ result }}
            notEqualTo:
              operandOne:
                fieldId: "{{ fieldId }}"
              operandTwo:
                stringValue: "{{ stringValue }}"
                booleanValue: {{ booleanValue }}
                doubleValue: {{ doubleValue }}
                emptyValue: "{{ emptyValue }}"
              result: {{ result }}
            andAll:
              conditions:
                - equalTo:
                    operandOne: "{{ operandOne }}"
                    operandTwo: "{{ operandTwo }}"
                    result: {{ result }}
                  notEqualTo:
                    operandOne: "{{ operandOne }}"
                    operandTwo: "{{ operandTwo }}"
                    result: {{ result }}
                  andAll:
                    conditions: "{{ conditions }}"
                  orAll:
                    conditions: "{{ conditions }}"
            orAll:
              conditions:
                - equalTo:
                    operandOne: "{{ operandOne }}"
                    operandTwo: "{{ operandTwo }}"
                    result: {{ result }}
                  notEqualTo:
                    operandOne: "{{ operandOne }}"
                    operandTwo: "{{ operandTwo }}"
                    result: {{ result }}
                  andAll:
                    conditions: "{{ conditions }}"
                  orAll:
                    conditions: "{{ conditions }}"

UPDATE examples

update_case_rule

Updates a 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.

UPDATE aws.connectcases.case_rules
SET 
name = '{{ name }}',
description = '{{ description }}',
rule = '{{ rule }}'
WHERE 
domain_id = '{{ domain_id }}' --required
AND case_rule_id = '{{ case_rule_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_case_rule

Deletes a 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.

DELETE FROM aws.connectcases.case_rules
WHERE domain_id = '{{ domain_id }}' --required
AND case_rule_id = '{{ case_rule_id }}' --required
AND region = '{{ region }}' --required
;