Describe Evaluation Form

connect_describe_evaluation_form

R Documentation

Describes an evaluation form in the specified Connect Customer instance

Description

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

Usage

connect_describe_evaluation_form(InstanceId, EvaluationFormId,
  EvaluationFormVersion)

Arguments

InstanceId	[required] The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
EvaluationFormId	[required] A unique identifier for the contact evaluation.
EvaluationFormVersion	A version of the evaluation form.

Value

A list with the following syntax:

list(
  EvaluationForm = list(
    EvaluationFormId = "string",
    EvaluationFormVersion = 123,
    Locked = TRUE|FALSE,
    EvaluationFormArn = "string",
    Title = "string",
    Description = "string",
    Status = "DRAFT"|"ACTIVE",
    Items = list(
      list(
        Section = list(
          Title = "string",
          RefId = "string",
          Instructions = "string",
          Items = list(),
          Weight = 123.0
        ),
        Question = list(
          Title = "string",
          Instructions = "string",
          RefId = "string",
          NotApplicableEnabled = TRUE|FALSE,
          QuestionType = "TEXT"|"SINGLESELECT"|"NUMERIC"|"MULTISELECT"|"DATETIME",
          QuestionTypeProperties = list(
            Numeric = list(
              MinValue = 123,
              MaxValue = 123,
              Options = list(
                list(
                  MinValue = 123,
                  MaxValue = 123,
                  Score = 123,
                  AutomaticFail = TRUE|FALSE,
                  AutomaticFailConfiguration = list(
                    TargetSection = "string"
                  )
                )
              ),
              Automation = list(
                PropertyValue = list(
                  Label = "OVERALL_CUSTOMER_SENTIMENT_SCORE"|"OVERALL_AGENT_SENTIMENT_SCORE"|"CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT"|"CUSTOMER_SENTIMENT_SCORE_WITH_AGENT"|"NON_TALK_TIME"|"NON_TALK_TIME_PERCENTAGE"|"NUMBER_OF_INTERRUPTIONS"|"CONTACT_DURATION"|"AGENT_INTERACTION_DURATION"|"CUSTOMER_HOLD_TIME"|"LONGEST_HOLD_DURATION"|"NUMBER_OF_HOLDS"|"AGENT_INTERACTION_AND_HOLD_DURATION"
                ),
                AnswerSource = list(
                  SourceType = "CONTACT_LENS_DATA"|"GEN_AI"
                )
              )
            ),
            SingleSelect = list(
              Options = list(
                list(
                  RefId = "string",
                  Text = "string",
                  Score = 123,
                  AutomaticFail = TRUE|FALSE,
                  AutomaticFailConfiguration = list(
                    TargetSection = "string"
                  )
                )
              ),
              DisplayAs = "DROPDOWN"|"RADIO",
              Automation = list(
                Options = list(
                  list(
                    RuleCategory = list(
                      Category = "string",
                      Condition = "PRESENT"|"NOT_PRESENT",
                      OptionRefId = "string"
                    )
                  )
                ),
                DefaultOptionRefId = "string",
                AnswerSource = list(
                  SourceType = "CONTACT_LENS_DATA"|"GEN_AI"
                )
              )
            ),
            Text = list(
              Automation = list(
                AnswerSource = list(
                  SourceType = "CONTACT_LENS_DATA"|"GEN_AI"
                )
              )
            ),
            MultiSelect = list(
              Options = list(
                list(
                  RefId = "string",
                  Text = "string"
                )
              ),
              DisplayAs = "DROPDOWN"|"CHECKBOX",
              Automation = list(
                Options = list(
                  list(
                    RuleCategory = list(
                      Category = "string",
                      Condition = "PRESENT"|"NOT_PRESENT",
                      OptionRefIds = list(
                        "string"
                      )
                    )
                  )
                ),
                DefaultOptionRefIds = list(
                  "string"
                ),
                AnswerSource = list(
                  SourceType = "CONTACT_LENS_DATA"|"GEN_AI"
                )
              )
            )
          ),
          Enablement = list(
            Condition = list(
              Operands = list(
                list(
                  Expression = list(
                    Source = list(
                      Type = "QUESTION_REF_ID",
                      RefId = "string"
                    ),
                    Values = list(
                      list(
                        Type = "OPTION_REF_ID",
                        RefId = "string"
                      )
                    ),
                    Comparator = "IN"|"NOT_IN"|"ALL_IN"|"EXACT"
                  ),
                  Condition = list()
                )
              ),
              Operator = "OR"|"AND"
            ),
            Action = "DISABLE"|"ENABLE",
            DefaultAction = "DISABLE"|"ENABLE"
          ),
          Weight = 123.0
        )
      )
    ),
    ScoringStrategy = list(
      Mode = "QUESTION_ONLY"|"SECTION_ONLY",
      Status = "ENABLED"|"DISABLED"
    ),
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    CreatedBy = "string",
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedBy = "string",
    AutoEvaluationConfiguration = list(
      Enabled = TRUE|FALSE
    ),
    ReviewConfiguration = list(
      ReviewNotificationRecipients = list(
        list(
          Type = "USER_ID",
          Value = list(
            UserId = "string"
          )
        )
      ),
      EligibilityDays = 123
    ),
    Tags = list(
      "string"
    ),
    TargetConfiguration = list(
      ContactInteractionType = "AGENT"|"AUTOMATED"|"CUSTOMER"
    ),
    LanguageConfiguration = list(
      FormLanguage = "de-DE"|"en-US"|"es-ES"|"fr-FR"|"it-IT"|"pt-BR"|"ja-JP"|"ko-KR"|"zh-CN"
    )
  )
)

Request syntax

svc$describe_evaluation_form(
  InstanceId = "string",
  EvaluationFormId = "string",
  EvaluationFormVersion = 123
)