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

get (all properties)

Name	Datatype	Description
▶scoring_strategy	object	A scoring strategy of the evaluation form.
status	string	The status of the evaluation form. Allowed values: DRAFT | ACTIVE
▶auto_evaluation_configuration	object
description	string	The description of the evaluation form. Length Constraints: 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. Minimum size: 1 Maximum size: 100
evaluation_form_arn	string
▶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.

list (identifiers only)

Name	Datatype	Description
evaluation_form_arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	evaluation_forms	INSERT	Title, InstanceArn, Items, Status, region
delete_resource	evaluation_forms	DELETE	Identifier, region
update_resource	evaluation_forms	UPDATE	Identifier, PatchDocument, region
list_resources	evaluation_forms_list_only	SELECT	region
get_resource	evaluation_forms	SELECT	Identifier, region

SELECT examples

get (all properties)

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 = '{{ region }}' AND
  Identifier = '{{ evaluation_form_arn }}';

list (identifiers only)

Lists all evaluation_forms in a region.

SELECT
  region,
  evaluation_form_arn
FROM awscc.connect.evaluation_forms_list_only
WHERE
  region = '{{ region }}';

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 }}',
  '{{ instance_arn }}',
  '{{ title }}',
  '{{ items }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.connect.evaluation_forms (
  ScoringStrategy,
  Status,
  AutoEvaluationConfiguration,
  Description,
  InstanceArn,
  Title,
  Items,
  Tags,
  region
)
SELECT
  '{{ scoring_strategy }}',
  '{{ status }}',
  '{{ auto_evaluation_configuration }}',
  '{{ description }}',
  '{{ instance_arn }}',
  '{{ title }}',
  '{{ items }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: evaluation_form
  props:
    - name: scoring_strategy
      value:
        status: '{{ status }}'
        mode: '{{ mode }}'
    - name: status
      value: '{{ status }}'
    - name: auto_evaluation_configuration
      value:
        enabled: '{{ enabled }}'
    - name: description
      value: '{{ description }}'
    - name: instance_arn
      value: '{{ instance_arn }}'
    - name: title
      value: '{{ title }}'
    - name: items
      value:
        - section:
            title: '{{ title }}'
            instructions: '{{ instructions }}'
            items:
              - question:
                  not_applicable_enabled: '{{ not_applicable_enabled }}'
                  title: '{{ title }}'
                  question_type: '{{ question_type }}'
                  instructions: '{{ instructions }}'
                  ref_id: '{{ ref_id }}'
                  question_type_properties:
                    numeric:
                      options:
                        - score: '{{ score }}'
                          min_value: '{{ min_value }}'
                          max_value: '{{ max_value }}'
                          automatic_fail: '{{ automatic_fail }}'
                      automation:
                        answer_source: null
                        property_value:
                          label: '{{ label }}'
                      min_value: '{{ min_value }}'
                      max_value: '{{ max_value }}'
                    single_select:
                      display_as: '{{ display_as }}'
                      options:
                        - score: null
                          text: '{{ text }}'
                          ref_id: null
                          automatic_fail: '{{ automatic_fail }}'
                      automation:
                        options:
                          - rule_category:
                              condition: '{{ condition }}'
                              category: '{{ category }}'
                              option_ref_id: null
                        default_option_ref_id: null
                  weight: null
                section: null
            ref_id: null
            weight: null
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.connect.evaluation_forms
SET PatchDocument = string('{{ {
    "ScoringStrategy": scoring_strategy,
    "Status": status,
    "AutoEvaluationConfiguration": auto_evaluation_configuration,
    "Description": description,
    "InstanceArn": instance_arn,
    "Title": title,
    "Items": items,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ evaluation_form_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.connect.evaluation_forms
WHERE
  Identifier = '{{ evaluation_form_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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