evaluation_forms

Creates, updates, deletes or gets an evaluation_form resource or lists evaluation_forms in a region

Overview

Name	evaluation_forms
Type	Resource
Description	Creates an evaluation form for the specified CON instance.
Id	aws.connect.evaluation_forms

Fields

Name	Datatype	Description
title	string	A title of the evaluation form.
description	string	The description of the evaluation form. *Length Constraints*: Minimum length of 0. Maximum length of 1024.
evaluation_form_arn	string
instance_arn	string	The identifier of the Amazon Connect instance.
items	array	Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section. *Minimum size*: 1 *Maximum size*: 100
scoring_strategy	object	A scoring strategy of the evaluation form.
status	string	The status of the evaluation form. *Allowed values*: DRAFT | ACTIVE
tags	array	The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
region	string	AWS region.

For more information, see AWS::Connect::EvaluationForm.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Title, InstanceArn, Items, Status, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all evaluation_forms in a region.

SELECT
region,
title,
description,
evaluation_form_arn,
instance_arn,
items,
scoring_strategy,
status,
tags
FROM aws.connect.evaluation_forms
WHERE region = 'us-east-1';

Gets all properties from an individual evaluation_form.

SELECT
region,
title,
description,
evaluation_form_arn,
instance_arn,
items,
scoring_strategy,
status,
tags
FROM aws.connect.evaluation_forms
WHERE region = 'us-east-1' AND data__Identifier = '<EvaluationFormArn>';

INSERT example

Use the following StackQL query and manifest file to create a new evaluation_form resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.connect.evaluation_forms (
 Title,
 InstanceArn,
 Items,
 Status,
 region
)
SELECT 
'{{ Title }}',
 '{{ InstanceArn }}',
 '{{ Items }}',
 '{{ Status }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.evaluation_forms (
 Title,
 Description,
 InstanceArn,
 Items,
 ScoringStrategy,
 Status,
 Tags,
 region
)
SELECT 
 '{{ Title }}',
 '{{ Description }}',
 '{{ InstanceArn }}',
 '{{ Items }}',
 '{{ ScoringStrategy }}',
 '{{ Status }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: evaluation_form
    props:
      - name: Title
        value: '{{ Title }}'
      - name: Description
        value: '{{ Description }}'
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Items
        value:
          - Section:
              Title: '{{ Title }}'
              Instructions: '{{ Instructions }}'
              RefId: '{{ RefId }}'
              Items:
                - Section: null
                  Question:
                    Title: '{{ Title }}'
                    Instructions: '{{ Instructions }}'
                    RefId: null
                    NotApplicableEnabled: '{{ NotApplicableEnabled }}'
                    QuestionType: '{{ QuestionType }}'
                    QuestionTypeProperties:
                      Numeric:
                        MinValue: '{{ MinValue }}'
                        MaxValue: '{{ MaxValue }}'
                        Options:
                          - MinValue: '{{ MinValue }}'
                            MaxValue: '{{ MaxValue }}'
                            Score: '{{ Score }}'
                            AutomaticFail: '{{ AutomaticFail }}'
                        Automation:
                          PropertyValue:
                            Label: '{{ Label }}'
                      SingleSelect:
                        Options:
                          - RefId: null
                            Text: '{{ Text }}'
                            Score: null
                            AutomaticFail: '{{ AutomaticFail }}'
                        DisplayAs: '{{ DisplayAs }}'
                        Automation:
                          Options:
                            - RuleCategory:
                                Category: '{{ Category }}'
                                Condition: '{{ Condition }}'
                                OptionRefId: null
                          DefaultOptionRefId: null
                    Weight: null
              Weight: null
      - name: ScoringStrategy
        value:
          Mode: '{{ Mode }}'
          Status: '{{ Status }}'
      - name: Status
        value: '{{ Status }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.connect.evaluation_forms
WHERE data__Identifier = '<EvaluationFormArn>'
AND region = 'us-east-1';

Permissions

To operate on the evaluation_forms resource, the following permissions are required:

Create

connect:CreateEvaluationForm,
connect:ActivateEvaluationForm,
connect:TagResource

Read

connect:DescribeEvaluationForm,
connect:ListEvaluationFormVersions

List

connect:ListEvaluationForms

Update

connect:UpdateEvaluationForm,
connect:ListEvaluationFormVersions,
connect:ActivateEvaluationForm,
connect:DeactivateEvaluationForm,
connect:TagResource,
connect:UntagResource

Delete

connect:DeleteEvaluationForm,
connect:UntagResource