AWS Native v0.64.0, Jun 2 23

aws-native.connect.getEvaluationForm

Explore with Pulumi AI

Resource Type definition for AWS::Connect::EvaluationForm

Using getEvaluationForm

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEvaluationForm(args: GetEvaluationFormArgs, opts?: InvokeOptions): Promise<GetEvaluationFormResult>
function getEvaluationFormOutput(args: GetEvaluationFormOutputArgs, opts?: InvokeOptions): Output<GetEvaluationFormResult>

def get_evaluation_form(evaluation_form_arn: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetEvaluationFormResult
def get_evaluation_form_output(evaluation_form_arn: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetEvaluationFormResult]

func LookupEvaluationForm(ctx *Context, args *LookupEvaluationFormArgs, opts ...InvokeOption) (*LookupEvaluationFormResult, error)
func LookupEvaluationFormOutput(ctx *Context, args *LookupEvaluationFormOutputArgs, opts ...InvokeOption) LookupEvaluationFormResultOutput

> Note: This function is named LookupEvaluationForm in the Go SDK.

public static class GetEvaluationForm 
{
    public static Task<GetEvaluationFormResult> InvokeAsync(GetEvaluationFormArgs args, InvokeOptions? opts = null)
    public static Output<GetEvaluationFormResult> Invoke(GetEvaluationFormInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEvaluationFormResult> getEvaluationForm(GetEvaluationFormArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:connect:getEvaluationForm
  arguments:
    # arguments dictionary

The following arguments are supported:

EvaluationFormArn string: The Amazon Resource Name (ARN) for the evaluation form.

EvaluationFormArn string: The Amazon Resource Name (ARN) for the evaluation form.

evaluationFormArn String: The Amazon Resource Name (ARN) for the evaluation form.

evaluationFormArn string: The Amazon Resource Name (ARN) for the evaluation form.

evaluation_form_arn str: The Amazon Resource Name (ARN) for the evaluation form.

evaluationFormArn String: The Amazon Resource Name (ARN) for the evaluation form.

getEvaluationForm Result

The following output properties are available:

Description string: The description of the evaluation form.
EvaluationFormArn string: The Amazon Resource Name (ARN) for the evaluation form.
InstanceArn string: The Amazon Resource Name (ARN) of the instance.
Items List<Pulumi.AwsNative.Connect.Outputs.EvaluationFormBaseItem>: The list of evaluation form items.
ScoringStrategy Pulumi.AwsNative.Connect.Outputs.EvaluationFormScoringStrategy: The scoring strategy.
Status Pulumi.AwsNative.Connect.EvaluationFormStatus: The status of the evaluation form.
Tags List<Pulumi.AwsNative.Connect.Outputs.EvaluationFormTag>: One or more tags.
Title string: The title of the evaluation form.

Description string: The description of the evaluation form.
EvaluationFormArn string: The Amazon Resource Name (ARN) for the evaluation form.
InstanceArn string: The Amazon Resource Name (ARN) of the instance.
Items []EvaluationFormBaseItem: The list of evaluation form items.
ScoringStrategy EvaluationFormScoringStrategy: The scoring strategy.
Status EvaluationFormStatus: The status of the evaluation form.
Tags []EvaluationFormTag: One or more tags.
Title string: The title of the evaluation form.

description String: The description of the evaluation form.
evaluationFormArn String: The Amazon Resource Name (ARN) for the evaluation form.
instanceArn String: The Amazon Resource Name (ARN) of the instance.
items List<EvaluationFormBaseItem>: The list of evaluation form items.
scoringStrategy EvaluationFormScoringStrategy: The scoring strategy.
status EvaluationFormStatus: The status of the evaluation form.
tags List<EvaluationFormTag>: One or more tags.
title String: The title of the evaluation form.

description string: The description of the evaluation form.
evaluationFormArn string: The Amazon Resource Name (ARN) for the evaluation form.
instanceArn string: The Amazon Resource Name (ARN) of the instance.
items EvaluationFormBaseItem[]: The list of evaluation form items.
scoringStrategy EvaluationFormScoringStrategy: The scoring strategy.
status EvaluationFormStatus: The status of the evaluation form.
tags EvaluationFormTag[]: One or more tags.
title string: The title of the evaluation form.

description str: The description of the evaluation form.
evaluation_form_arn str: The Amazon Resource Name (ARN) for the evaluation form.
instance_arn str: The Amazon Resource Name (ARN) of the instance.
items Sequence[EvaluationFormBaseItem]: The list of evaluation form items.
scoring_strategy EvaluationFormScoringStrategy: The scoring strategy.
status EvaluationFormStatus: The status of the evaluation form.
tags Sequence[EvaluationFormTag]: One or more tags.
title str: The title of the evaluation form.

description String: The description of the evaluation form.
evaluationFormArn String: The Amazon Resource Name (ARN) for the evaluation form.
instanceArn String: The Amazon Resource Name (ARN) of the instance.
items List<Property Map>: The list of evaluation form items.
scoringStrategy Property Map: The scoring strategy.
status "DRAFT" | "ACTIVE": The status of the evaluation form.
tags List<Property Map>: One or more tags.
title String: The title of the evaluation form.

Supporting Types

EvaluationFormBaseItem

Section Pulumi.AwsNative.Connect.Inputs.EvaluationFormSection: The evaluation form section item

Section EvaluationFormSection: The evaluation form section item

section EvaluationFormSection: The evaluation form section item

section EvaluationFormSection: The evaluation form section item

section EvaluationFormSection: The evaluation form section item

section Property Map: The evaluation form section item

EvaluationFormItem

Question Pulumi.AwsNative.Connect.Inputs.EvaluationFormQuestion: The evaluation form question item
Section Pulumi.AwsNative.Connect.Inputs.EvaluationFormSection: The evaluation form section item

Question EvaluationFormQuestion: The evaluation form question item
Section EvaluationFormSection: The evaluation form section item

question EvaluationFormQuestion: The evaluation form question item
section EvaluationFormSection: The evaluation form section item

question EvaluationFormQuestion: The evaluation form question item
section EvaluationFormSection: The evaluation form section item

question EvaluationFormQuestion: The evaluation form question item
section EvaluationFormSection: The evaluation form section item

question Property Map: The evaluation form question item
section Property Map: The evaluation form section item

EvaluationFormNumericQuestionAutomation

PropertyValue Pulumi.AwsNative.Connect.Inputs.EvaluationFormNumericQuestionPropertyValueAutomation: The automation property name of the question.

PropertyValue EvaluationFormNumericQuestionPropertyValueAutomation: The automation property name of the question.

propertyValue EvaluationFormNumericQuestionPropertyValueAutomation: The automation property name of the question.

propertyValue EvaluationFormNumericQuestionPropertyValueAutomation: The automation property name of the question.

property_value EvaluationFormNumericQuestionPropertyValueAutomation: The automation property name of the question.

propertyValue Property Map: The automation property name of the question.

EvaluationFormNumericQuestionOption

MaxValue int: The maximum value of the option range.
MinValue int: The minimum value of the option range.
AutomaticFail bool: The flag to mark the option as automatic fail.
Score int: The score of the option range.

MaxValue int: The maximum value of the option range.
MinValue int: The minimum value of the option range.
AutomaticFail bool: The flag to mark the option as automatic fail.
Score int: The score of the option range.

maxValue Integer: The maximum value of the option range.
minValue Integer: The minimum value of the option range.
automaticFail Boolean: The flag to mark the option as automatic fail.
score Integer: The score of the option range.

maxValue number: The maximum value of the option range.
minValue number: The minimum value of the option range.
automaticFail boolean: The flag to mark the option as automatic fail.
score number: The score of the option range.

max_value int: The maximum value of the option range.
min_value int: The minimum value of the option range.
automatic_fail bool: The flag to mark the option as automatic fail.
score int: The score of the option range.

maxValue Number: The maximum value of the option range.
minValue Number: The minimum value of the option range.
automaticFail Boolean: The flag to mark the option as automatic fail.
score Number: The score of the option range.

EvaluationFormNumericQuestionProperties

MaxValue int: The maximum value for answers of the question.
MinValue int: The minimum value for answers of the question.
Automation Pulumi.AwsNative.Connect.Inputs.EvaluationFormNumericQuestionAutomation: The automation properties for the numeric question.
Options List<Pulumi.AwsNative.Connect.Inputs.EvaluationFormNumericQuestionOption>: The list of option ranges used for scoring.

MaxValue int: The maximum value for answers of the question.
MinValue int: The minimum value for answers of the question.
Automation EvaluationFormNumericQuestionAutomation: The automation properties for the numeric question.
Options []EvaluationFormNumericQuestionOption: The list of option ranges used for scoring.

maxValue Integer: The maximum value for answers of the question.
minValue Integer: The minimum value for answers of the question.
automation EvaluationFormNumericQuestionAutomation: The automation properties for the numeric question.
options List<EvaluationFormNumericQuestionOption>: The list of option ranges used for scoring.

maxValue number: The maximum value for answers of the question.
minValue number: The minimum value for answers of the question.
automation EvaluationFormNumericQuestionAutomation: The automation properties for the numeric question.
options EvaluationFormNumericQuestionOption[]: The list of option ranges used for scoring.

max_value int: The maximum value for answers of the question.
min_value int: The minimum value for answers of the question.
automation EvaluationFormNumericQuestionAutomation: The automation properties for the numeric question.
options Sequence[EvaluationFormNumericQuestionOption]: The list of option ranges used for scoring.

maxValue Number: The maximum value for answers of the question.
minValue Number: The minimum value for answers of the question.
automation Property Map: The automation properties for the numeric question.
options List<Property Map>: The list of option ranges used for scoring.

EvaluationFormNumericQuestionPropertyValueAutomation

Label Pulumi.AwsNative.Connect.EvaluationFormNumericQuestionPropertyValueAutomationLabel: The automation property label.

Label EvaluationFormNumericQuestionPropertyValueAutomationLabel: The automation property label.

label EvaluationFormNumericQuestionPropertyValueAutomationLabel: The automation property label.

label EvaluationFormNumericQuestionPropertyValueAutomationLabel: The automation property label.

label EvaluationFormNumericQuestionPropertyValueAutomationLabel: The automation property label.

label "OVERALL_CUSTOMER_SENTIMENT_SCORE" | "OVERALL_AGENT_SENTIMENT_SCORE" | "NON_TALK_TIME" | "NON_TALK_TIME_PERCENTAGE" | "NUMBER_OF_INTERRUPTIONS" | "CONTACT_DURATION" | "AGENT_INTERACTION_DURATION" | "CUSTOMER_HOLD_TIME": The automation property label.

EvaluationFormNumericQuestionPropertyValueAutomationLabel

EvaluationFormQuestion

QuestionType Pulumi.AwsNative.Connect.EvaluationFormQuestionQuestionType: The type of the question.
RefId string: The identifier used to reference the question.
Title string: The title of the question.
Instructions string: The instructions for the question.
NotApplicableEnabled bool: The flag to enable not applicable answers to the question.
QuestionTypeProperties Pulumi.AwsNative.Connect.Inputs.EvaluationFormQuestionTypeProperties: The properties of the question
Weight double: The question weight used for scoring.

QuestionType EvaluationFormQuestionQuestionType: The type of the question.
RefId string: The identifier used to reference the question.
Title string: The title of the question.
Instructions string: The instructions for the question.
NotApplicableEnabled bool: The flag to enable not applicable answers to the question.
QuestionTypeProperties EvaluationFormQuestionTypeProperties: The properties of the question
Weight float64: The question weight used for scoring.

questionType EvaluationFormQuestionQuestionType: The type of the question.
refId String: The identifier used to reference the question.
title String: The title of the question.
instructions String: The instructions for the question.
notApplicableEnabled Boolean: The flag to enable not applicable answers to the question.
questionTypeProperties EvaluationFormQuestionTypeProperties: The properties of the question
weight Double: The question weight used for scoring.

questionType EvaluationFormQuestionQuestionType: The type of the question.
refId string: The identifier used to reference the question.
title string: The title of the question.
instructions string: The instructions for the question.
notApplicableEnabled boolean: The flag to enable not applicable answers to the question.
questionTypeProperties EvaluationFormQuestionTypeProperties: The properties of the question
weight number: The question weight used for scoring.

question_type EvaluationFormQuestionQuestionType: The type of the question.
ref_id str: The identifier used to reference the question.
title str: The title of the question.
instructions str: The instructions for the question.
not_applicable_enabled bool: The flag to enable not applicable answers to the question.
question_type_properties EvaluationFormQuestionTypeProperties: The properties of the question
weight float: The question weight used for scoring.

questionType "NUMERIC" | "SINGLESELECT" | "TEXT": The type of the question.
refId String: The identifier used to reference the question.
title String: The title of the question.
instructions String: The instructions for the question.
notApplicableEnabled Boolean: The flag to enable not applicable answers to the question.
questionTypeProperties Property Map: The properties of the question
weight Number: The question weight used for scoring.

EvaluationFormQuestionQuestionType

EvaluationFormQuestionTypeProperties

Numeric Pulumi.AwsNative.Connect.Inputs.EvaluationFormNumericQuestionProperties: The properties of the numeric question.
SingleSelect Pulumi.AwsNative.Connect.Inputs.EvaluationFormSingleSelectQuestionProperties: The properties of the single-select question.

Numeric EvaluationFormNumericQuestionProperties: The properties of the numeric question.
SingleSelect EvaluationFormSingleSelectQuestionProperties: The properties of the single-select question.

numeric EvaluationFormNumericQuestionProperties: The properties of the numeric question.
singleSelect EvaluationFormSingleSelectQuestionProperties: The properties of the single-select question.

numeric EvaluationFormNumericQuestionProperties: The properties of the numeric question.
singleSelect EvaluationFormSingleSelectQuestionProperties: The properties of the single-select question.

numeric EvaluationFormNumericQuestionProperties: The properties of the numeric question.
single_select EvaluationFormSingleSelectQuestionProperties: The properties of the single-select question.

numeric Property Map: The properties of the numeric question.
singleSelect Property Map: The properties of the single-select question.

EvaluationFormScoringStrategy

Mode Pulumi.AwsNative.Connect.EvaluationFormScoringStrategyMode: The scoring mode.
Status Pulumi.AwsNative.Connect.EvaluationFormScoringStrategyStatus: The scoring status.

Mode EvaluationFormScoringStrategyMode: The scoring mode.
Status EvaluationFormScoringStrategyStatus: The scoring status.

mode EvaluationFormScoringStrategyMode: The scoring mode.
status EvaluationFormScoringStrategyStatus: The scoring status.

mode EvaluationFormScoringStrategyMode: The scoring mode.
status EvaluationFormScoringStrategyStatus: The scoring status.

mode EvaluationFormScoringStrategyMode: The scoring mode.
status EvaluationFormScoringStrategyStatus: The scoring status.

mode "QUESTION_ONLY" | "SECTION_ONLY": The scoring mode.
status "ENABLED" | "DISABLED": The scoring status.

EvaluationFormScoringStrategyMode

EvaluationFormScoringStrategyStatus

EvaluationFormSection

RefId string: The identifier to reference the section.
Title string: The title of the section.
Instructions string: The instructions for the section.
Items List<Pulumi.AwsNative.Connect.Inputs.EvaluationFormItem>: The list of section items.
Weight double: The item weight used for scoring.

RefId string: The identifier to reference the section.
Title string: The title of the section.
Instructions string: The instructions for the section.
Items []EvaluationFormItem: The list of section items.
Weight float64: The item weight used for scoring.

refId String: The identifier to reference the section.
title String: The title of the section.
instructions String: The instructions for the section.
items List<EvaluationFormItem>: The list of section items.
weight Double: The item weight used for scoring.

refId string: The identifier to reference the section.
title string: The title of the section.
instructions string: The instructions for the section.
items EvaluationFormItem[]: The list of section items.
weight number: The item weight used for scoring.

ref_id str: The identifier to reference the section.
title str: The title of the section.
instructions str: The instructions for the section.
items Sequence[EvaluationFormItem]: The list of section items.
weight float: The item weight used for scoring.

refId String: The identifier to reference the section.
title String: The title of the section.
instructions String: The instructions for the section.
items List<Property Map>: The list of section items.
weight Number: The item weight used for scoring.

EvaluationFormSingleSelectQuestionAutomation

Options List<Pulumi.AwsNative.Connect.Inputs.EvaluationFormSingleSelectQuestionAutomationOption>: The answer options for the automation.
DefaultOptionRefId string: The option reference identifier of the default answer.

Options []EvaluationFormSingleSelectQuestionAutomationOption: The answer options for the automation.
DefaultOptionRefId string: The option reference identifier of the default answer.

options List<EvaluationFormSingleSelectQuestionAutomationOption>: The answer options for the automation.
defaultOptionRefId String: The option reference identifier of the default answer.

options EvaluationFormSingleSelectQuestionAutomationOption[]: The answer options for the automation.
defaultOptionRefId string: The option reference identifier of the default answer.

options Sequence[EvaluationFormSingleSelectQuestionAutomationOption]: The answer options for the automation.
default_option_ref_id str: The option reference identifier of the default answer.

options List<Property Map>: The answer options for the automation.
defaultOptionRefId String: The option reference identifier of the default answer.

EvaluationFormSingleSelectQuestionAutomationOption

RuleCategory Pulumi.AwsNative.Connect.Inputs.EvaluationFormSingleSelectQuestionRuleCategoryAutomation: The automation option based on Rules categories.

RuleCategory EvaluationFormSingleSelectQuestionRuleCategoryAutomation: The automation option based on Rules categories.

ruleCategory EvaluationFormSingleSelectQuestionRuleCategoryAutomation: The automation option based on Rules categories.

ruleCategory EvaluationFormSingleSelectQuestionRuleCategoryAutomation: The automation option based on Rules categories.

rule_category EvaluationFormSingleSelectQuestionRuleCategoryAutomation: The automation option based on Rules categories.

ruleCategory Property Map: The automation option based on Rules categories.

EvaluationFormSingleSelectQuestionOption

RefId string: The identifier used to reference the option.
Text string: The title of the option.
AutomaticFail bool: The flag to mark the option as automatic fail.
Score int: The score of the option.

RefId string: The identifier used to reference the option.
Text string: The title of the option.
AutomaticFail bool: The flag to mark the option as automatic fail.
Score int: The score of the option.

refId String: The identifier used to reference the option.
text String: The title of the option.
automaticFail Boolean: The flag to mark the option as automatic fail.
score Integer: The score of the option.

refId string: The identifier used to reference the option.
text string: The title of the option.
automaticFail boolean: The flag to mark the option as automatic fail.
score number: The score of the option.

ref_id str: The identifier used to reference the option.
text str: The title of the option.
automatic_fail bool: The flag to mark the option as automatic fail.
score int: The score of the option.

refId String: The identifier used to reference the option.
text String: The title of the option.
automaticFail Boolean: The flag to mark the option as automatic fail.
score Number: The score of the option.

EvaluationFormSingleSelectQuestionProperties

Options List<Pulumi.AwsNative.Connect.Inputs.EvaluationFormSingleSelectQuestionOption>: The list of options for the question.
Automation Pulumi.AwsNative.Connect.Inputs.EvaluationFormSingleSelectQuestionAutomation: The automation properties for the single-select question.
DisplayAs Pulumi.AwsNative.Connect.EvaluationFormSingleSelectQuestionPropertiesDisplayAs: The display mode of the single-select question.

Options []EvaluationFormSingleSelectQuestionOption: The list of options for the question.
Automation EvaluationFormSingleSelectQuestionAutomation: The automation properties for the single-select question.
DisplayAs EvaluationFormSingleSelectQuestionPropertiesDisplayAs: The display mode of the single-select question.

options List<EvaluationFormSingleSelectQuestionOption>: The list of options for the question.
automation EvaluationFormSingleSelectQuestionAutomation: The automation properties for the single-select question.
displayAs EvaluationFormSingleSelectQuestionPropertiesDisplayAs: The display mode of the single-select question.

options EvaluationFormSingleSelectQuestionOption[]: The list of options for the question.
automation EvaluationFormSingleSelectQuestionAutomation: The automation properties for the single-select question.
displayAs EvaluationFormSingleSelectQuestionPropertiesDisplayAs: The display mode of the single-select question.

options Sequence[EvaluationFormSingleSelectQuestionOption]: The list of options for the question.
automation EvaluationFormSingleSelectQuestionAutomation: The automation properties for the single-select question.
display_as EvaluationFormSingleSelectQuestionPropertiesDisplayAs: The display mode of the single-select question.

options List<Property Map>: The list of options for the question.
automation Property Map: The automation properties for the single-select question.
displayAs "DROPDOWN" | "RADIO": The display mode of the single-select question.

EvaluationFormSingleSelectQuestionPropertiesDisplayAs

EvaluationFormSingleSelectQuestionRuleCategoryAutomation

Category string: The category name as defined in Rules.
Condition Pulumi.AwsNative.Connect.EvaluationFormSingleSelectQuestionRuleCategoryAutomationCondition: The automation condition applied on contact categories.
OptionRefId string: The option identifier referencing the option to be selected when the automation option is triggered.

Category string: The category name as defined in Rules.
Condition EvaluationFormSingleSelectQuestionRuleCategoryAutomationCondition: The automation condition applied on contact categories.
OptionRefId string: The option identifier referencing the option to be selected when the automation option is triggered.

category String: The category name as defined in Rules.
condition EvaluationFormSingleSelectQuestionRuleCategoryAutomationCondition: The automation condition applied on contact categories.
optionRefId String: The option identifier referencing the option to be selected when the automation option is triggered.

category string: The category name as defined in Rules.
condition EvaluationFormSingleSelectQuestionRuleCategoryAutomationCondition: The automation condition applied on contact categories.
optionRefId string: The option identifier referencing the option to be selected when the automation option is triggered.

category str: The category name as defined in Rules.
condition EvaluationFormSingleSelectQuestionRuleCategoryAutomationCondition: The automation condition applied on contact categories.
option_ref_id str: The option identifier referencing the option to be selected when the automation option is triggered.

category String: The category name as defined in Rules.
condition "PRESENT" | "NOT_PRESENT": The automation condition applied on contact categories.
optionRefId String: The option identifier referencing the option to be selected when the automation option is triggered.

EvaluationFormSingleSelectQuestionRuleCategoryAutomationCondition

EvaluationFormStatus

EvaluationFormTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that's 1 to 256 characters in length.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that's 1 to 256 characters in length.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that's 1 to 256 characters in length.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that's 1 to 256 characters in length.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that's 1 to 256 characters in length.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that's 1 to 256 characters in length.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0