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	awscc.connect.evaluation_forms

Fields

Name	Datatype	Description
▶scoring_strategy	object	A scoring strategy of the evaluation form.
status	string	The status of the evaluation form.<br />&#42;Allowed values&#42;: &#96;&#96;DRAFT&#96;&#96; &#124; &#96;&#96;ACTIVE&#96;&#96;
▶auto_evaluation_configuration	object
description	string	The description of the evaluation form.<br />&#42;Length Constraints&#42;: Minimum length of 0. Maximum length of 1024.
instance_arn	string	The identifier of the Amazon Connect instance.
title	string	A title of the evaluation form.
▶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.<br />&#42;Minimum size&#42;: 1<br />&#42;Maximum size&#42;: 100
evaluation_form_arn	string
▶tags	array	The tags used to organize, track, or control access for this resource. For example, &#123; "tags": &#123;"key1":"value1", "key2":"value2"&#125; &#125;.
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 properties from an individual evaluation_form.

SELECT
region,
scoring_strategy,
status,
auto_evaluation_configuration,
description,
instance_arn,
title,
items,
evaluation_form_arn,
tags
FROM awscc.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 awscc.connect.evaluation_forms (
 Status,
 InstanceArn,
 Title,
 Items,
 region
)
SELECT 
'{{ Status }}',
 '{{ InstanceArn }}',
 '{{ Title }}',
 '{{ Items }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.connect.evaluation_forms (
 ScoringStrategy,
 Status,
 AutoEvaluationConfiguration,
 Description,
 InstanceArn,
 Title,
 Items,
 Tags,
 region
)
SELECT 
 '{{ ScoringStrategy }}',
 '{{ Status }}',
 '{{ AutoEvaluationConfiguration }}',
 '{{ Description }}',
 '{{ InstanceArn }}',
 '{{ Title }}',
 '{{ Items }}',
 '{{ 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: ScoringStrategy
        value:
          Status: '{{ Status }}'
          Mode: '{{ Mode }}'
      - name: Status
        value: '{{ Status }}'
      - name: AutoEvaluationConfiguration
        value:
          Enabled: '{{ Enabled }}'
      - name: Description
        value: '{{ Description }}'
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Title
        value: '{{ Title }}'
      - name: Items
        value:
          - Section:
              Title: '{{ Title }}'
              Instructions: '{{ Instructions }}'
              Items:
                - Question:
                    NotApplicableEnabled: '{{ NotApplicableEnabled }}'
                    Title: '{{ Title }}'
                    QuestionType: '{{ QuestionType }}'
                    Instructions: '{{ Instructions }}'
                    RefId: '{{ RefId }}'
                    QuestionTypeProperties:
                      Numeric:
                        Options:
                          - Score: '{{ Score }}'
                            MinValue: '{{ MinValue }}'
                            MaxValue: '{{ MaxValue }}'
                            AutomaticFail: '{{ AutomaticFail }}'
                        Automation:
                          AnswerSource: null
                          PropertyValue:
                            Label: '{{ Label }}'
                        MinValue: '{{ MinValue }}'
                        MaxValue: '{{ MaxValue }}'
                      SingleSelect:
                        DisplayAs: '{{ DisplayAs }}'
                        Options:
                          - Score: null
                            Text: '{{ Text }}'
                            RefId: null
                            AutomaticFail: '{{ AutomaticFail }}'
                        Automation:
                          Options:
                            - RuleCategory:
                                Condition: '{{ Condition }}'
                                Category: '{{ Category }}'
                                OptionRefId: null
                          DefaultOptionRefId: null
                    Weight: null
                  Section: null
              RefId: null
              Weight: null
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.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:

Read

connect:DescribeEvaluationForm,
connect:ListEvaluationFormVersions

Create

connect:CreateEvaluationForm,
connect:ActivateEvaluationForm,
connect:TagResource

Update

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

List

connect:ListEvaluationForms

Delete

connect:DeleteEvaluationForm,
connect:UntagResource