Skip to content
AWS for Query.Farm

aws.connect.describe_evaluation_form

Example SQL Queries

SELECT * FROM
aws.connect.describe_evaluation_form
WHERE
"instance_id" = 'VALUE'
AND "evaluation_form_id" = 'VALUE';

Description

Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.

Table Definition

Column NameColumn Data Type
evaluation_form_id Required Input Column

A unique identifier for the contact evaluation.

VARCHAR
instance_id Required Input Column

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

VARCHAR
evaluation_form_version Input Column

A version of the evaluation form.

BIGINT
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
evaluation_form

Information about the evaluation form.

STRUCT(
    "evaluation_form_id" VARCHAR,
    "evaluation_form_version" BIGINT,
    "locked" BOOLEAN,
    "evaluation_form_arn" VARCHAR,
    "title" VARCHAR,
    "description" VARCHAR,
    "status" VARCHAR,
    "items" STRUCT(
        "section" STRUCT(
            "title" VARCHAR,
            "ref_id" VARCHAR,
            "instructions" VARCHAR,
            "weight" DOUBLE
        ),
        "question" STRUCT(
            "title" VARCHAR,
            "instructions" VARCHAR,
            "ref_id" VARCHAR,
            "not_applicable_enabled" BOOLEAN,
            "question_type" VARCHAR,
            "question_type_properties" STRUCT(
                "numeric" STRUCT(
                    "min_value" BIGINT,
                    "max_value" BIGINT,
                    "options" STRUCT(
                        "min_value" BIGINT,
                        "max_value" BIGINT,
                        "score" BIGINT,
                        "automatic_fail" BOOLEAN
                    )[],
                    "automation" STRUCT(
                        "property_value" STRUCT(
                            "label" VARCHAR
                        )
                    )
                ),
                "single_select" STRUCT(
                    "options" STRUCT(
                        "ref_id" VARCHAR,
                        "text" VARCHAR,
                        "score" BIGINT,
                        "automatic_fail" BOOLEAN
                    )[],
                    "display_as" VARCHAR,
                    "automation" STRUCT(
                        "options" STRUCT(
                            "rule_category" STRUCT(
                                "category" VARCHAR,
                                "condition" VARCHAR,
                                "option_ref_id" VARCHAR
                            )
                        )[],
                        "default_option_ref_id" VARCHAR
                    )
                )
            ),
            "weight" DOUBLE
        )
    )[],
    "scoring_strategy" STRUCT(
        "mode" VARCHAR,
        "status" VARCHAR
    ),
    "created_time" TIMESTAMP_S,
    "created_by" VARCHAR,
    "last_modified_time" TIMESTAMP_S,
    "last_modified_by" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
evaluation_form.created_by

The Amazon Resource Name (ARN) of the user who created the evaluation form.

evaluation_form.created_time

The timestamp for when the evaluation form was created.

evaluation_form.description

The description of the evaluation form.

evaluation_form.evaluation_form_arn

The Amazon Resource Name (ARN) for the evaluation form resource.

evaluation_form.evaluation_form_id

The unique identifier for the evaluation form.

evaluation_form.evaluation_form_version

A version of the evaluation form.

evaluation_form.items[]
Show child fields
evaluation_form.items[].question

The information of the question.

Show child fields
evaluation_form.items[].question.instructions

The instructions of the section.

evaluation_form.items[].question.not_applicable_enabled

The flag to enable not applicable answers to the question.

evaluation_form.items[].question.question_type

The type of the question.

evaluation_form.items[].question.question_type_properties

The properties of the type of question. Text questions do not have to define question type properties.

Show child fields
evaluation_form.items[].question.question_type_properties.numeric

The properties of the numeric question.

Show child fields
evaluation_form.items[].question.question_type_properties.numeric.automation

The automation properties of the numeric question.

Show child fields
evaluation_form.items[].question.question_type_properties.numeric.automation.property_value

The property value of the automation.

Show child fields
evaluation_form.items[].question.question_type_properties.numeric.automation.property_value.label

The property label of the automation.

evaluation_form.items[].question.question_type_properties.numeric.max_value

The maximum answer value.

evaluation_form.items[].question.question_type_properties.numeric.min_value

The minimum answer value.

evaluation_form.items[].question.question_type_properties.numeric.options[]
Show child fields
evaluation_form.items[].question.question_type_properties.numeric.options[].automatic_fail

The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

evaluation_form.items[].question.question_type_properties.numeric.options[].max_value

The maximum answer value of the range option.

evaluation_form.items[].question.question_type_properties.numeric.options[].min_value

The minimum answer value of the range option.

evaluation_form.items[].question.question_type_properties.numeric.options[].score

The score assigned to answer values within the range option.

evaluation_form.items[].question.question_type_properties.single_select

The properties of the numeric question.

Show child fields
evaluation_form.items[].question.question_type_properties.single_select.automation

The display mode of the single select question.

Show child fields
evaluation_form.items[].question.question_type_properties.single_select.automation.default_option_ref_id

The identifier of the default answer option, when none of the automation options match the criteria.

evaluation_form.items[].question.question_type_properties.single_select.automation.options[]
Show child fields
evaluation_form.items[].question.question_type_properties.single_select.automation.options[].rule_category

The automation option based on a rule category for the single select question.

Show child fields
evaluation_form.items[].question.question_type_properties.single_select.automation.options[].rule_category.category

The category name, as defined in Rules.

evaluation_form.items[].question.question_type_properties.single_select.automation.options[].rule_category.condition

The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.

evaluation_form.items[].question.question_type_properties.single_select.automation.options[].rule_category.option_ref_id

The identifier of the answer option.

evaluation_form.items[].question.question_type_properties.single_select.display_as

The display mode of the single select question.

evaluation_form.items[].question.question_type_properties.single_select.options[]
Show child fields
evaluation_form.items[].question.question_type_properties.single_select.options[].automatic_fail

The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

evaluation_form.items[].question.question_type_properties.single_select.options[].ref_id

The identifier of the answer option. An identifier must be unique within the question.

evaluation_form.items[].question.question_type_properties.single_select.options[].score

The score assigned to the answer option.

evaluation_form.items[].question.question_type_properties.single_select.options[].text

The title of the answer option.

evaluation_form.items[].question.ref_id

The identifier of the question. An identifier must be unique within the evaluation form.

evaluation_form.items[].question.title

The title of the question.

evaluation_form.items[].question.weight

The scoring weight of the section.

evaluation_form.items[].section

The information of the section.

Show child fields
evaluation_form.items[].section.instructions

The instructions of the section.

evaluation_form.items[].section.ref_id

The identifier of the section. An identifier must be unique within the evaluation form.

evaluation_form.items[].section.title

The title of the section.

evaluation_form.items[].section.weight

The scoring weight of the section.

evaluation_form.last_modified_by

The Amazon Resource Name (ARN) of the user who last updated the evaluation form.

evaluation_form.last_modified_time

The timestamp for when the evaluation form was last updated.

evaluation_form.locked

The flag indicating whether the evaluation form is locked for changes.

evaluation_form.scoring_strategy

A scoring strategy of the evaluation form.

Show child fields
evaluation_form.scoring_strategy.mode

The scoring mode of the evaluation form.

evaluation_form.scoring_strategy.status

The scoring status of the evaluation form.

evaluation_form.status

The status of the evaluation form.

evaluation_form.tags

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

evaluation_form.title

A title of the evaluation form.