2026/06/19 - Amazon Connect Service - 2 new6 updated api methods
Changes This is the release for point based scoring system and the evaluation form validation project
Starts an asynchronous validation process for an evaluation form version in the specified Connect Customer instance. The validation first performs structural checks on the form content (such as verifying required fields, valid scoring configuration, and correct conditional logic), then asynchronously analyzes questions configured for generative AI evaluation against a set of best practices. Use GetEvaluationFormValidation to retrieve the status and results once the validation completes.
See also: AWS API Documentation
Request Syntax
client.start_evaluation_form_validation(
InstanceId='string',
EvaluationFormId='string',
EvaluationFormVersion=123
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The unique identifier for the evaluation form.
integer
[REQUIRED]
The version of the evaluation form to validate.
dict
Response Syntax
{
'EvaluationFormId': 'string',
'EvaluationFormArn': 'string',
'EvaluationFormVersion': 123
}
Response Structure
(dict) --
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the evaluation form resource.
EvaluationFormVersion (integer) --
A version of the evaluation form.
Retrieves the status and results of a validation process started by StartEvaluationFormValidation. Returns the current execution status ( IN_PROGRESS, COMPLETED, or FAILED), the validated form version, and when completed, a list of findings that identify structural issues and quality improvements for the evaluation form, and may include suggested fixes. If the validation failed, a reason is provided indicating the cause of the failure.
See also: AWS API Documentation
Request Syntax
client.get_evaluation_form_validation(
InstanceId='string',
EvaluationFormId='string',
EvaluationFormVersion=123
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The unique identifier for the evaluation form.
integer
The version of the evaluation form to retrieve validation results for.
dict
Response Syntax
{
'Status': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
'FailureReason': 'string',
'EvaluationFormId': 'string',
'EvaluationFormVersion': 123,
'StartedTime': datetime(2015, 1, 1),
'Findings': [
{
'IssueCode': 'string',
'Items': [
{
'RefId': 'string',
'Property': 'string'
},
],
'Description': 'string',
'Suggestion': 'string',
'Severity': 'WARNING'|'ERROR'
},
]
}
Response Structure
(dict) --
Status (string) --
The current status of the validation process. Valid values: IN_PROGRESS, COMPLETED, FAILED.
FailureReason (string) --
The reason the validation failed. This field is populated only when the status is FAILED.
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormVersion (integer) --
A version of the evaluation form.
StartedTime (datetime) --
The timestamp when the validation process was started.
Findings (list) --
A list of findings from the validation process. Each finding identifies a structural issue or quality improvement for the evaluation form, and may include a suggested fix. This field is populated when the status is COMPLETED.
(dict) --
Information about a finding from the evaluation form validation process. Each finding identifies a structural issue or quality improvement opportunity for the evaluation form.
IssueCode (string) --
A code that identifies the type of validation issue found.
Items (list) --
A list of evaluation form items affected by this finding.
(dict) --
Information about an evaluation form item affected by a validation finding.
RefId (string) --
The identifier of the evaluation form item (question or section) affected by the finding.
Property (string) --
The specific property of the evaluation form item that the finding relates to.
Description (string) --
A description of the validation issue.
Suggestion (string) --
A suggested fix for the validation issue.
Severity (string) --
The severity of the finding. Valid values: WARNING, ERROR.
{'Items': {'Question': {'QuestionTypeProperties': {'MultiSelect': {'Options': {'AutomaticFail': 'boolean',
'AutomaticFailConfiguration': {'TargetSection': 'string'},
'PointsConfiguration': {'IsBonus': 'boolean',
'PointValue': 'integer'},
'Score': 'integer'}},
'Numeric': {'Options': {'PointsConfiguration': {'IsBonus': 'boolean',
'PointValue': 'integer'}}},
'SingleSelect': {'Options': {'PointsConfiguration': {'IsBonus': 'boolean',
'PointValue': 'integer'}}}},
'ScoringConfiguration': {'IsExcludedFromScoring': 'boolean',
'PointsConfiguration': {'IsBonus': 'boolean',
'MaxPointValue': 'integer',
'MinPointValue': 'integer'},
'ScoreThresholds': [{'MaxScorePercentage': 'double',
'MinScorePercentage': 'double',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}]}},
'Section': {'IsExcludedFromScoring': 'boolean',
'ScoreThresholds': [{'MaxScorePercentage': 'double',
'MinScorePercentage': 'double',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}]}},
'ScoringStrategy': {'Mode': {'POINTS_BASED'},
'ScoreThresholds': [{'MaxScorePercentage': 'double',
'MinScorePercentage': 'double',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}]}}
Creates an evaluation form in the specified Connect Customer instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
See also: AWS API Documentation
Request Syntax
client.create_evaluation_form(
InstanceId='string',
Title='string',
Description='string',
Items=[
{
'Section': {
'Title': 'string',
'RefId': 'string',
'Instructions': 'string',
'Items': {'... recursive ...'},
'Weight': 123.0,
'IsExcludedFromScoring': True|False,
'ScoreThresholds': [
{
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
'MinScorePercentage': 123.0,
'MaxScorePercentage': 123.0
},
]
},
'Question': {
'Title': 'string',
'Instructions': 'string',
'RefId': 'string',
'NotApplicableEnabled': True|False,
'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
'QuestionTypeProperties': {
'Numeric': {
'MinValue': 123,
'MaxValue': 123,
'Options': [
{
'MinValue': 123,
'MaxValue': 123,
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
},
'PointsConfiguration': {
'PointValue': 123,
'IsBonus': True|False
}
},
],
'Automation': {
'PropertyValue': {
'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': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'SingleSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string',
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
},
'PointsConfiguration': {
'PointValue': 123,
'IsBonus': True|False
}
},
],
'DisplayAs': 'DROPDOWN'|'RADIO',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefId': 'string'
}
},
],
'DefaultOptionRefId': 'string',
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'Text': {
'Automation': {
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'MultiSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string',
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
},
'PointsConfiguration': {
'PointValue': 123,
'IsBonus': True|False
}
},
],
'DisplayAs': 'DROPDOWN'|'CHECKBOX',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefIds': [
'string',
]
}
},
],
'DefaultOptionRefIds': [
'string',
],
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
}
},
'Enablement': {
'Condition': {
'Operands': [
{
'Expression': {
'Source': {
'Type': 'QUESTION_REF_ID',
'RefId': 'string'
},
'Values': [
{
'Type': 'OPTION_REF_ID',
'RefId': 'string'
},
],
'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'
},
'Condition': {'... recursive ...'}
},
],
'Operator': 'OR'|'AND'
},
'Action': 'DISABLE'|'ENABLE',
'DefaultAction': 'DISABLE'|'ENABLE'
},
'Weight': 123.0,
'ScoringConfiguration': {
'PointsConfiguration': {
'MaxPointValue': 123,
'MinPointValue': 123,
'IsBonus': True|False
},
'IsExcludedFromScoring': True|False,
'ScoreThresholds': [
{
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
'MinScorePercentage': 123.0,
'MaxScorePercentage': 123.0
},
]
}
}
},
],
ScoringStrategy={
'Mode': 'QUESTION_ONLY'|'SECTION_ONLY'|'POINTS_BASED',
'Status': 'ENABLED'|'DISABLED',
'ScoreThresholds': [
{
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
'MinScorePercentage': 123.0,
'MaxScorePercentage': 123.0
},
]
},
AutoEvaluationConfiguration={
'Enabled': True|False
},
ClientToken='string',
AsDraft=True|False,
Tags={
'string': 'string'
},
ReviewConfiguration={
'ReviewNotificationRecipients': [
{
'Type': 'USER_ID',
'Value': {
'UserId': 'string'
}
},
],
'EligibilityDays': 123
},
TargetConfiguration={
'ContactInteractionType': 'AGENT'|'AUTOMATED'|'CUSTOMER'
},
LanguageConfiguration={
'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'
}
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
A title of the evaluation form.
string
The description of the evaluation form.
list
[REQUIRED]
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.
(dict) --
Information about an item from an evaluation form. The item must be either a section or a question.
Section (dict) --
The information of the section.
Title (string) -- [REQUIRED]
The title of the section.
RefId (string) -- [REQUIRED]
The identifier of the section. An identifier must be unique within the evaluation form.
Instructions (string) --
The instructions of the section.
Items (list) --
The items of the section.
Weight (float) --
The scoring weight of the section.
IsExcludedFromScoring (boolean) --
The flag to exclude the section from scoring.
ScoreThresholds (list) --
The score thresholds for performance categories.
(dict) --
Information about a score threshold for a performance category.
PerformanceCategory (string) -- [REQUIRED]
The performance category name.
MinScorePercentage (float) --
The minimum score percentage for the performance category.
MaxScorePercentage (float) --
The maximum score percentage for the performance category.
Question (dict) --
The information of the question.
Title (string) -- [REQUIRED]
The title of the question.
Instructions (string) --
The instructions of the section.
RefId (string) -- [REQUIRED]
The identifier of the question. An identifier must be unique within the evaluation form.
NotApplicableEnabled (boolean) --
The flag to enable not applicable answers to the question.
QuestionType (string) -- [REQUIRED]
The type of the question.
QuestionTypeProperties (dict) --
The properties of the type of question. Text questions do not have to define question type properties.
Numeric (dict) --
The properties of the numeric question.
MinValue (integer) -- [REQUIRED]
The minimum answer value.
MaxValue (integer) -- [REQUIRED]
The maximum answer value.
Options (list) --
The scoring options of the numeric question.
(dict) --
Information about the option range used for scoring in numeric questions.
MinValue (integer) -- [REQUIRED]
The minimum answer value of the range option.
MaxValue (integer) -- [REQUIRED]
The maximum answer value of the range option.
Score (integer) --
The score assigned to answer values within the range option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
A configuration for automatic fail.
TargetSection (string) --
The referenceId of the target section for auto failure.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
PointValue (integer) -- [REQUIRED]
The point value assigned to the answer option.
IsBonus (boolean) --
The flag to mark the option as a bonus option.
Automation (dict) --
The automation properties of the numeric question.
PropertyValue (dict) --
The property value of the automation.
Label (string) -- [REQUIRED]
The property label of the automation.
AnswerSource (dict) --
A source of automation answer for numeric question.
SourceType (string) -- [REQUIRED]
The automation answer source type.
SingleSelect (dict) --
The properties of the numeric question.
Options (list) -- [REQUIRED]
The answer options of the single select question.
(dict) --
Information about the automation configuration in single select questions.
RefId (string) -- [REQUIRED]
The identifier of the answer option. An identifier must be unique within the question.
Text (string) -- [REQUIRED]
The title of the answer option.
Score (integer) --
The score assigned to the answer option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
Whether automatic fail is configured on a single select question.
TargetSection (string) --
The referenceId of the target section for auto failure.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
PointValue (integer) -- [REQUIRED]
The point value assigned to the answer option.
IsBonus (boolean) --
The flag to mark the option as a bonus option.
DisplayAs (string) --
The display mode of the single select question.
Automation (dict) --
The display mode of the single select question.
Options (list) --
The automation options of the single select question.
(dict) --
Information about the automation option of a single select question.
RuleCategory (dict) --
The automation option based on a rule category for the single select question.
Category (string) -- [REQUIRED]
The category name, as defined in Rules.
Condition (string) -- [REQUIRED]
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.
OptionRefId (string) -- [REQUIRED]
The identifier of the answer option.
DefaultOptionRefId (string) --
The identifier of the default answer option, when none of the automation options match the criteria.
AnswerSource (dict) --
Automation answer source.
SourceType (string) -- [REQUIRED]
The automation answer source type.
Text (dict) --
The properties of the text question.
Automation (dict) --
The automation properties of the text question.
AnswerSource (dict) --
Automation answer source.
SourceType (string) -- [REQUIRED]
The automation answer source type.
MultiSelect (dict) --
Properties for multi-select question types.
Options (list) -- [REQUIRED]
Options available for this multi-select question.
(dict) --
An option for a multi-select question in an evaluation form.
RefId (string) -- [REQUIRED]
Reference identifier for this option.
Text (string) -- [REQUIRED]
Display text for this option.
Score (integer) --
The score assigned to the answer option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
Information about automatic fail configuration for an evaluation form.
TargetSection (string) --
The referenceId of the target section for auto failure.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
PointValue (integer) -- [REQUIRED]
The point value assigned to the answer option.
IsBonus (boolean) --
The flag to mark the option as a bonus option.
DisplayAs (string) --
Display format for the multi-select question.
Automation (dict) --
Automation configuration for this multi-select question.
Options (list) --
Automation options for the multi-select question.
(dict) --
An automation option for a multi-select question.
RuleCategory (dict) --
Rule category configuration for this automation option.
Category (string) -- [REQUIRED]
The category name for this automation rule.
Condition (string) -- [REQUIRED]
The condition for this automation rule.
OptionRefIds (list) -- [REQUIRED]
Reference IDs of options for this automation rule.
(string) --
DefaultOptionRefIds (list) --
Reference IDs of default options.
(string) --
AnswerSource (dict) --
A question automation answer.
SourceType (string) -- [REQUIRED]
The automation answer source type.
Enablement (dict) --
A question conditional enablement.
Condition (dict) -- [REQUIRED]
A condition for item enablement configuration.
Operands (list) -- [REQUIRED]
Operands of the enablement condition.
(dict) --
An operand of the enablement condition.
Expression (dict) --
An expression of the enablement condition.
Source (dict) -- [REQUIRED]
A source item of enablement expression.
Type (string) -- [REQUIRED]
A type of source item.
RefId (string) --
A referenceId of the source item.
Values (list) -- [REQUIRED]
A list of values from source item.
(dict) --
An enablement expression source value.
Type (string) -- [REQUIRED]
A type of source item value.
RefId (string) --
A referenceId of the source value.
Comparator (string) -- [REQUIRED]
A comparator to be used against list of values.
Condition (dict) --
A condition for item enablement.
Operator (string) --
The operator to be used to be applied to operands if more than one provided.
Action (string) -- [REQUIRED]
An enablement action that if condition is satisfied.
DefaultAction (string) --
An enablement action that if condition is not satisfied.
Weight (float) --
The scoring weight of the section.
ScoringConfiguration (dict) --
The scoring configuration of the question.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
MaxPointValue (integer) --
The maximum point value.
MinPointValue (integer) --
The minimum point value.
IsBonus (boolean) --
The flag to mark the question as a bonus question.
IsExcludedFromScoring (boolean) --
The flag to exclude the question from scoring.
ScoreThresholds (list) --
The score thresholds for performance categories.
(dict) --
Information about a score threshold for a performance category.
PerformanceCategory (string) -- [REQUIRED]
The performance category name.
MinScorePercentage (float) --
The minimum score percentage for the performance category.
MaxScorePercentage (float) --
The maximum score percentage for the performance category.
dict
A scoring strategy of the evaluation form.
Mode (string) -- [REQUIRED]
The scoring mode of the evaluation form.
Status (string) -- [REQUIRED]
The scoring status of the evaluation form.
ScoreThresholds (list) --
The score thresholds for performance categories.
(dict) --
Information about a score threshold for a performance category.
PerformanceCategory (string) -- [REQUIRED]
The performance category name.
MinScorePercentage (float) --
The minimum score percentage for the performance category.
MaxScorePercentage (float) --
The maximum score percentage for the performance category.
dict
Configuration information about automated evaluations.
Enabled (boolean) -- [REQUIRED]
When automated evaluation is enabled.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
boolean
A boolean flag indicating whether to create evaluation form in draft state.
dict
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
dict
Configuration information about evaluation reviews.
ReviewNotificationRecipients (list) -- [REQUIRED]
List of recipients who should be notified when a review is requested.
(dict) --
Information about a recipient who should be notified when an evaluation review is requested.
Type (string) -- [REQUIRED]
The type of notification recipient.
Value (dict) -- [REQUIRED]
The value associated with the notification recipient type.
UserId (string) --
The user identifier for the notification recipient.
EligibilityDays (integer) --
Number of days during which a request for review can be submitted for evaluations created from this form.
dict
Configuration that specifies the target for the evaluation form.
ContactInteractionType (string) -- [REQUIRED]
The contact interaction type for this evaluation form.
dict
Configuration for language settings of the evaluation form.
FormLanguage (string) --
The language for the evaluation form.
dict
Response Syntax
{
'EvaluationFormId': 'string',
'EvaluationFormArn': 'string'
}
Response Structure
(dict) --
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the evaluation form resource.
{'Evaluation': {'Metadata': {'Score': {'EarnedPoints': 'integer',
'MaxBasePoint': 'integer',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}},
'Scores': {'EarnedPoints': 'integer',
'MaxBasePoint': 'integer',
'PerformanceCategory': 'NEEDS_IMPROVEMENT | '
'EXCEEDS_EXPECTATIONS'}},
'EvaluationForm': {'Items': {'Question': {'QuestionTypeProperties': {'MultiSelect': {'Options': {'AutomaticFail': 'boolean',
'AutomaticFailConfiguration': {'TargetSection': 'string'},
'PointsConfiguration': {'IsBonus': 'boolean',
'PointValue': 'integer'},
'Score': 'integer'}},
'Numeric': {'Options': {'PointsConfiguration': {'IsBonus': 'boolean',
'PointValue': 'integer'}}},
'SingleSelect': {'Options': {'PointsConfiguration': {'IsBonus': 'boolean',
'PointValue': 'integer'}}}},
'ScoringConfiguration': {'IsExcludedFromScoring': 'boolean',
'PointsConfiguration': {'IsBonus': 'boolean',
'MaxPointValue': 'integer',
'MinPointValue': 'integer'},
'ScoreThresholds': [{'MaxScorePercentage': 'double',
'MinScorePercentage': 'double',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}]}},
'Section': {'IsExcludedFromScoring': 'boolean',
'ScoreThresholds': [{'MaxScorePercentage': 'double',
'MinScorePercentage': 'double',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}]}},
'ScoringStrategy': {'Mode': {'POINTS_BASED'},
'ScoreThresholds': [{'MaxScorePercentage': 'double',
'MinScorePercentage': 'double',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}]}}}
Describes a contact evaluation in the specified Connect Customer instance.
See also: AWS API Documentation
Request Syntax
client.describe_contact_evaluation(
InstanceId='string',
EvaluationId='string'
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
A unique identifier for the contact evaluation.
dict
Response Syntax
{
'Evaluation': {
'EvaluationId': 'string',
'EvaluationArn': 'string',
'Metadata': {
'ContactId': 'string',
'EvaluatorArn': 'string',
'ContactAgentId': 'string',
'CalibrationSessionId': 'string',
'Score': {
'Percentage': 123.0,
'NotApplicable': True|False,
'AutomaticFail': True|False,
'AppliedWeight': 123.0,
'EarnedPoints': 123,
'MaxBasePoint': 123,
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS'
},
'AutoEvaluation': {
'AutoEvaluationEnabled': True|False,
'AutoEvaluationStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
},
'Acknowledgement': {
'AcknowledgedTime': datetime(2015, 1, 1),
'AcknowledgedBy': 'string',
'AcknowledgerComment': 'string'
},
'Review': {
'ReviewId': 'string',
'RequestedTime': datetime(2015, 1, 1),
'RequestedBy': 'string',
'CreatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'ReviewRequestComments': [
{
'Comment': 'string',
'CreatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string'
},
]
},
'ContactParticipant': {
'ContactParticipantRole': 'AGENT'|'SYSTEM'|'CUSTOM_BOT'|'CUSTOMER',
'ContactParticipantId': 'string'
},
'SamplingJobId': 'string'
},
'Answers': {
'string': {
'Value': {
'StringValue': 'string',
'NumericValue': 123.0,
'StringValues': [
'string',
],
'DateTimeValue': 'string',
'NotApplicable': True|False
},
'SystemSuggestedValue': {
'StringValue': 'string',
'NumericValue': 123.0,
'StringValues': [
'string',
],
'DateTimeValue': 'string',
'NotApplicable': True|False
},
'SuggestedAnswers': [
{
'Value': {
'StringValue': 'string',
'NumericValue': 123.0,
'StringValues': [
'string',
],
'DateTimeValue': 'string',
'NotApplicable': True|False
},
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'Input': {
'TranscriptType': 'RAW'|'REDACTED'
},
'AnalysisType': 'CONTACT_LENS_DATA'|'GEN_AI',
'AnalysisDetails': {
'GenAI': {
'Justification': 'string',
'PointsOfInterest': [
{
'MillisecondOffsets': {
'BeginOffsetMillis': 123
},
'TranscriptSegment': 'string'
},
]
},
'ContactLens': {
'MatchedRuleCategories': [
{
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'PointsOfInterest': [
{
'MillisecondOffsets': {
'BeginOffsetMillis': 123
},
'TranscriptSegment': 'string'
},
]
},
]
}
}
},
]
}
},
'Notes': {
'string': {
'Value': 'string'
}
},
'Status': 'DRAFT'|'SUBMITTED'|'REVIEW_REQUESTED'|'UNDER_REVIEW',
'Scores': {
'string': {
'Percentage': 123.0,
'NotApplicable': True|False,
'AutomaticFail': True|False,
'AppliedWeight': 123.0,
'EarnedPoints': 123,
'MaxBasePoint': 123,
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS'
}
},
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'EvaluationType': 'STANDARD'|'CALIBRATION',
'Tags': {
'string': 'string'
}
},
'EvaluationForm': {
'EvaluationFormVersion': 123,
'EvaluationFormId': 'string',
'EvaluationFormArn': 'string',
'Title': 'string',
'Description': 'string',
'Items': [
{
'Section': {
'Title': 'string',
'RefId': 'string',
'Instructions': 'string',
'Items': {'... recursive ...'},
'Weight': 123.0,
'IsExcludedFromScoring': True|False,
'ScoreThresholds': [
{
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
'MinScorePercentage': 123.0,
'MaxScorePercentage': 123.0
},
]
},
'Question': {
'Title': 'string',
'Instructions': 'string',
'RefId': 'string',
'NotApplicableEnabled': True|False,
'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
'QuestionTypeProperties': {
'Numeric': {
'MinValue': 123,
'MaxValue': 123,
'Options': [
{
'MinValue': 123,
'MaxValue': 123,
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
},
'PointsConfiguration': {
'PointValue': 123,
'IsBonus': True|False
}
},
],
'Automation': {
'PropertyValue': {
'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': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'SingleSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string',
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
},
'PointsConfiguration': {
'PointValue': 123,
'IsBonus': True|False
}
},
],
'DisplayAs': 'DROPDOWN'|'RADIO',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefId': 'string'
}
},
],
'DefaultOptionRefId': 'string',
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'Text': {
'Automation': {
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'MultiSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string',
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
},
'PointsConfiguration': {
'PointValue': 123,
'IsBonus': True|False
}
},
],
'DisplayAs': 'DROPDOWN'|'CHECKBOX',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefIds': [
'string',
]
}
},
],
'DefaultOptionRefIds': [
'string',
],
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
}
},
'Enablement': {
'Condition': {
'Operands': [
{
'Expression': {
'Source': {
'Type': 'QUESTION_REF_ID',
'RefId': 'string'
},
'Values': [
{
'Type': 'OPTION_REF_ID',
'RefId': 'string'
},
],
'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'
},
'Condition': {'... recursive ...'}
},
],
'Operator': 'OR'|'AND'
},
'Action': 'DISABLE'|'ENABLE',
'DefaultAction': 'DISABLE'|'ENABLE'
},
'Weight': 123.0,
'ScoringConfiguration': {
'PointsConfiguration': {
'MaxPointValue': 123,
'MinPointValue': 123,
'IsBonus': True|False
},
'IsExcludedFromScoring': True|False,
'ScoreThresholds': [
{
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
'MinScorePercentage': 123.0,
'MaxScorePercentage': 123.0
},
]
}
}
},
],
'ScoringStrategy': {
'Mode': 'QUESTION_ONLY'|'SECTION_ONLY'|'POINTS_BASED',
'Status': 'ENABLED'|'DISABLED',
'ScoreThresholds': [
{
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
'MinScorePercentage': 123.0,
'MaxScorePercentage': 123.0
},
]
},
'AutoEvaluationConfiguration': {
'Enabled': True|False
},
'TargetConfiguration': {
'ContactInteractionType': 'AGENT'|'AUTOMATED'|'CUSTOMER'
},
'LanguageConfiguration': {
'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'
},
'ReviewConfiguration': {
'ReviewNotificationRecipients': [
{
'Type': 'USER_ID',
'Value': {
'UserId': 'string'
}
},
],
'EligibilityDays': 123
}
}
}
Response Structure
(dict) --
Evaluation (dict) --
Information about the evaluation form completed for a specific contact.
EvaluationId (string) --
A unique identifier for the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
Metadata (dict) --
Metadata about the contact evaluation.
ContactId (string) --
The identifier of the contact in this instance of Connect Customer.
EvaluatorArn (string) --
The Amazon Resource Name (ARN) of the user who last updated the evaluation.
ContactAgentId (string) --
The identifier of the agent who performed the contact.
CalibrationSessionId (string) --
The calibration session ID that this evaluation belongs to.
Score (dict) --
The overall score of the contact evaluation.
Percentage (float) --
The score percentage for an item in a contact evaluation.
NotApplicable (boolean) --
The flag to mark the item as not applicable for scoring.
AutomaticFail (boolean) --
The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.
AppliedWeight (float) --
Weight applied to this evaluation score.
EarnedPoints (integer) --
The points earned for the item.
MaxBasePoint (integer) --
The maximum base points possible for the item.
PerformanceCategory (string) --
The performance category for the score.
AutoEvaluation (dict) --
Information related to automated evaluation.
AutoEvaluationEnabled (boolean) --
Whether automated evaluation is enabled.
AutoEvaluationStatus (string) --
The status of the contact auto-evaluation.
Acknowledgement (dict) --
Information related to evaluation acknowledgement.
AcknowledgedTime (datetime) --
When the agent acknowledged the evaluation.
AcknowledgedBy (string) --
The agent who acknowledged the evaluation.
AcknowledgerComment (string) --
A comment from the agent when they confirmed they acknowledged the evaluation.
Review (dict) --
Information about reviews of this evaluation.
ReviewId (string) --
The unique identifier for the evaluation review.
RequestedTime (datetime) --
The timestamp when the evaluation review was requested.
RequestedBy (string) --
The user who requested the evaluation review.
CreatedTime (datetime) --
The timestamp when the evaluation review was created.
CreatedBy (string) --
The user who created the evaluation review.
ReviewRequestComments (list) --
Comments provided when requesting the evaluation review.
(dict) --
A comment provided when requesting an evaluation review.
Comment (string) --
The text content of the review request comment.
CreatedTime (datetime) --
The timestamp when the evaluation review request comment was created.
CreatedBy (string) --
The user who created the evaluation review request comment.
ContactParticipant (dict) --
Information about a contact participant in this evaluation.
ContactParticipantRole (string) --
The role of the contact participant.
ContactParticipantId (string) --
The identifier for the contact participant.
SamplingJobId (string) --
Identifier of the sampling job.
Answers (dict) --
A map of question identifiers to answer value.
(string) --
(dict) --
Information about output answers for a contact evaluation.
Value (dict) --
The value for an answer in a contact evaluation.
StringValue (string) --
The string value for an answer in a contact evaluation.
NumericValue (float) --
The numeric value for an answer in a contact evaluation.
StringValues (list) --
String values provided as answers to evaluation questions.
(string) --
DateTimeValue (string) --
Date and time value provided as an answer to an evaluation question.
NotApplicable (boolean) --
The flag to mark the question as not applicable.
SystemSuggestedValue (dict) --
The system suggested value for an answer in a contact evaluation.
StringValue (string) --
The string value for an answer in a contact evaluation.
NumericValue (float) --
The numeric value for an answer in a contact evaluation.
StringValues (list) --
String values provided as answers to evaluation questions.
(string) --
DateTimeValue (string) --
Date and time value provided as an answer to an evaluation question.
NotApplicable (boolean) --
The flag to mark the question as not applicable.
SuggestedAnswers (list) --
Automation suggested answers for the questions.
(dict) --
The information about the suggested answer for the question.
Value (dict) --
Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.
StringValue (string) --
The string value for an answer in a contact evaluation.
NumericValue (float) --
The numeric value for an answer in a contact evaluation.
StringValues (list) --
String values provided as answers to evaluation questions.
(string) --
DateTimeValue (string) --
Date and time value provided as an answer to an evaluation question.
NotApplicable (boolean) --
The flag to mark the question as not applicable.
Status (string) --
The status of the suggested answer. D
Input (dict) --
Details about the input used to question automation.
TranscriptType (string) --
Transcript type.
AnalysisType (string) --
Type of analysis used to provide suggested answer.
AnalysisDetails (dict) --
Detailed analysis results.
GenAI (dict) --
Analysis results from the generative AI automation for the question.
Justification (string) --
Generative AI automation answer justification.
PointsOfInterest (list) --
Generative AI automation answer analysis points of interest.
(dict) --
Information about the point of interest in transcript provided to evaluation.
MillisecondOffsets (dict) --
Offset in milliseconds from the beginning of transcript.
BeginOffsetMillis (integer) --
Offset in milliseconds from the beginning of the transcript.
TranscriptSegment (string) --
Segment of transcript.
ContactLens (dict) --
Analysis results from the Contact Lens automation for the question.
MatchedRuleCategories (list) --
A list of match rule categories.
(dict) --
The Contact Lens category used by evaluation automation.
Category (string) --
A category label.
Condition (string) --
An automation condition for a Contact Lens category.
PointsOfInterest (list) --
A point of interest in a contact transcript that indicates match of condition.
(dict) --
Information about the point of interest in transcript provided to evaluation.
MillisecondOffsets (dict) --
Offset in milliseconds from the beginning of transcript.
BeginOffsetMillis (integer) --
Offset in milliseconds from the beginning of the transcript.
TranscriptSegment (string) --
Segment of transcript.
Notes (dict) --
A map of question identifiers to note value.
(string) --
(dict) --
Information about notes for a contact evaluation.
Value (string) --
The note for an item (section or question) in a contact evaluation.
Status (string) --
The status of the contact evaluation.
Scores (dict) --
A map of item (section or question) identifiers to score value.
(string) --
(dict) --
Information about scores of a contact evaluation item (section or question).
Percentage (float) --
The score percentage for an item in a contact evaluation.
NotApplicable (boolean) --
The flag to mark the item as not applicable for scoring.
AutomaticFail (boolean) --
The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.
AppliedWeight (float) --
Weight applied to this evaluation score.
EarnedPoints (integer) --
The points earned for the item.
MaxBasePoint (integer) --
The maximum base points possible for the item.
PerformanceCategory (string) --
The performance category for the score.
CreatedTime (datetime) --
The timestamp for when the evaluation was created.
LastModifiedTime (datetime) --
The timestamp for when the evaluation was last updated.
EvaluationType (string) --
Type of the evaluation.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
EvaluationForm (dict) --
Information about the evaluation form.
EvaluationFormVersion (integer) --
A version of the evaluation form.
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the evaluation form resource.
Title (string) --
A title of the evaluation form.
Description (string) --
The description of the evaluation form.
Items (list) --
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.
(dict) --
Information about an item from an evaluation form. The item must be either a section or a question.
Section (dict) --
The information of the section.
Title (string) --
The title of the section.
RefId (string) --
The identifier of the section. An identifier must be unique within the evaluation form.
Instructions (string) --
The instructions of the section.
Items (list) --
The items of the section.
Weight (float) --
The scoring weight of the section.
IsExcludedFromScoring (boolean) --
The flag to exclude the section from scoring.
ScoreThresholds (list) --
The score thresholds for performance categories.
(dict) --
Information about a score threshold for a performance category.
PerformanceCategory (string) --
The performance category name.
MinScorePercentage (float) --
The minimum score percentage for the performance category.
MaxScorePercentage (float) --
The maximum score percentage for the performance category.
Question (dict) --
The information of the question.
Title (string) --
The title of the question.
Instructions (string) --
The instructions of the section.
RefId (string) --
The identifier of the question. An identifier must be unique within the evaluation form.
NotApplicableEnabled (boolean) --
The flag to enable not applicable answers to the question.
QuestionType (string) --
The type of the question.
QuestionTypeProperties (dict) --
The properties of the type of question. Text questions do not have to define question type properties.
Numeric (dict) --
The properties of the numeric question.
MinValue (integer) --
The minimum answer value.
MaxValue (integer) --
The maximum answer value.
Options (list) --
The scoring options of the numeric question.
(dict) --
Information about the option range used for scoring in numeric questions.
MinValue (integer) --
The minimum answer value of the range option.
MaxValue (integer) --
The maximum answer value of the range option.
Score (integer) --
The score assigned to answer values within the range option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
A configuration for automatic fail.
TargetSection (string) --
The referenceId of the target section for auto failure.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
PointValue (integer) --
The point value assigned to the answer option.
IsBonus (boolean) --
The flag to mark the option as a bonus option.
Automation (dict) --
The automation properties of the numeric question.
PropertyValue (dict) --
The property value of the automation.
Label (string) --
The property label of the automation.
AnswerSource (dict) --
A source of automation answer for numeric question.
SourceType (string) --
The automation answer source type.
SingleSelect (dict) --
The properties of the numeric question.
Options (list) --
The answer options of the single select question.
(dict) --
Information about the automation configuration in single select questions.
RefId (string) --
The identifier of the answer option. An identifier must be unique within the question.
Text (string) --
The title of the answer option.
Score (integer) --
The score assigned to the answer option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
Whether automatic fail is configured on a single select question.
TargetSection (string) --
The referenceId of the target section for auto failure.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
PointValue (integer) --
The point value assigned to the answer option.
IsBonus (boolean) --
The flag to mark the option as a bonus option.
DisplayAs (string) --
The display mode of the single select question.
Automation (dict) --
The display mode of the single select question.
Options (list) --
The automation options of the single select question.
(dict) --
Information about the automation option of a single select question.
RuleCategory (dict) --
The automation option based on a rule category for the single select question.
Category (string) --
The category name, as defined in Rules.
Condition (string) --
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.
OptionRefId (string) --
The identifier of the answer option.
DefaultOptionRefId (string) --
The identifier of the default answer option, when none of the automation options match the criteria.
AnswerSource (dict) --
Automation answer source.
SourceType (string) --
The automation answer source type.
Text (dict) --
The properties of the text question.
Automation (dict) --
The automation properties of the text question.
AnswerSource (dict) --
Automation answer source.
SourceType (string) --
The automation answer source type.
MultiSelect (dict) --
Properties for multi-select question types.
Options (list) --
Options available for this multi-select question.
(dict) --
An option for a multi-select question in an evaluation form.
RefId (string) --
Reference identifier for this option.
Text (string) --
Display text for this option.
Score (integer) --
The score assigned to the answer option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
Information about automatic fail configuration for an evaluation form.
TargetSection (string) --
The referenceId of the target section for auto failure.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
PointValue (integer) --
The point value assigned to the answer option.
IsBonus (boolean) --
The flag to mark the option as a bonus option.
DisplayAs (string) --
Display format for the multi-select question.
Automation (dict) --
Automation configuration for this multi-select question.
Options (list) --
Automation options for the multi-select question.
(dict) --
An automation option for a multi-select question.
RuleCategory (dict) --
Rule category configuration for this automation option.
Category (string) --
The category name for this automation rule.
Condition (string) --
The condition for this automation rule.
OptionRefIds (list) --
Reference IDs of options for this automation rule.
(string) --
DefaultOptionRefIds (list) --
Reference IDs of default options.
(string) --
AnswerSource (dict) --
A question automation answer.
SourceType (string) --
The automation answer source type.
Enablement (dict) --
A question conditional enablement.
Condition (dict) --
A condition for item enablement configuration.
Operands (list) --
Operands of the enablement condition.
(dict) --
An operand of the enablement condition.
Expression (dict) --
An expression of the enablement condition.
Source (dict) --
A source item of enablement expression.
Type (string) --
A type of source item.
RefId (string) --
A referenceId of the source item.
Values (list) --
A list of values from source item.
(dict) --
An enablement expression source value.
Type (string) --
A type of source item value.
RefId (string) --
A referenceId of the source value.
Comparator (string) --
A comparator to be used against list of values.
Condition (dict) --
A condition for item enablement.
Operator (string) --
The operator to be used to be applied to operands if more than one provided.
Action (string) --
An enablement action that if condition is satisfied.
DefaultAction (string) --
An enablement action that if condition is not satisfied.
Weight (float) --
The scoring weight of the section.
ScoringConfiguration (dict) --
The scoring configuration of the question.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
MaxPointValue (integer) --
The maximum point value.
MinPointValue (integer) --
The minimum point value.
IsBonus (boolean) --
The flag to mark the question as a bonus question.
IsExcludedFromScoring (boolean) --
The flag to exclude the question from scoring.
ScoreThresholds (list) --
The score thresholds for performance categories.
(dict) --
Information about a score threshold for a performance category.
PerformanceCategory (string) --
The performance category name.
MinScorePercentage (float) --
The minimum score percentage for the performance category.
MaxScorePercentage (float) --
The maximum score percentage for the performance category.
ScoringStrategy (dict) --
A scoring strategy of the evaluation form.
Mode (string) --
The scoring mode of the evaluation form.
Status (string) --
The scoring status of the evaluation form.
ScoreThresholds (list) --
The score thresholds for performance categories.
(dict) --
Information about a score threshold for a performance category.
PerformanceCategory (string) --
The performance category name.
MinScorePercentage (float) --
The minimum score percentage for the performance category.
MaxScorePercentage (float) --
The maximum score percentage for the performance category.
AutoEvaluationConfiguration (dict) --
The configuration of the automated evaluation.
Enabled (boolean) --
When automated evaluation is enabled.
TargetConfiguration (dict) --
Configuration that specifies the target for this evaluation form content.
ContactInteractionType (string) --
The contact interaction type for this evaluation form.
LanguageConfiguration (dict) --
Configuration for language settings of this evaluation form content.
FormLanguage (string) --
The language for the evaluation form.
ReviewConfiguration (dict) --
Configuration for evaluation review settings of this evaluation form content.
ReviewNotificationRecipients (list) --
List of recipients who should be notified when a review is requested.
(dict) --
Information about a recipient who should be notified when an evaluation review is requested.
Type (string) --
The type of notification recipient.
Value (dict) --
The value associated with the notification recipient type.
UserId (string) --
The user identifier for the notification recipient.
EligibilityDays (integer) --
Number of days during which a request for review can be submitted for evaluations created from this form.
{'EvaluationForm': {'Items': {'Question': {'QuestionTypeProperties': {'MultiSelect': {'Options': {'AutomaticFail': 'boolean',
'AutomaticFailConfiguration': {'TargetSection': 'string'},
'PointsConfiguration': {'IsBonus': 'boolean',
'PointValue': 'integer'},
'Score': 'integer'}},
'Numeric': {'Options': {'PointsConfiguration': {'IsBonus': 'boolean',
'PointValue': 'integer'}}},
'SingleSelect': {'Options': {'PointsConfiguration': {'IsBonus': 'boolean',
'PointValue': 'integer'}}}},
'ScoringConfiguration': {'IsExcludedFromScoring': 'boolean',
'PointsConfiguration': {'IsBonus': 'boolean',
'MaxPointValue': 'integer',
'MinPointValue': 'integer'},
'ScoreThresholds': [{'MaxScorePercentage': 'double',
'MinScorePercentage': 'double',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}]}},
'Section': {'IsExcludedFromScoring': 'boolean',
'ScoreThresholds': [{'MaxScorePercentage': 'double',
'MinScorePercentage': 'double',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}]}},
'LastValidationTime': 'timestamp',
'LatestValidationStatus': 'IN_PROGRESS | COMPLETED | '
'FAILED',
'ScoringStrategy': {'Mode': {'POINTS_BASED'},
'ScoreThresholds': [{'MaxScorePercentage': 'double',
'MinScorePercentage': 'double',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}]}}}
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.
See also: AWS API Documentation
Request Syntax
client.describe_evaluation_form(
InstanceId='string',
EvaluationFormId='string',
EvaluationFormVersion=123
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
A unique identifier for the contact evaluation.
integer
A version of the evaluation form.
dict
Response Syntax
{
'EvaluationForm': {
'EvaluationFormId': 'string',
'EvaluationFormVersion': 123,
'Locked': True|False,
'EvaluationFormArn': 'string',
'Title': 'string',
'Description': 'string',
'Status': 'DRAFT'|'ACTIVE',
'Items': [
{
'Section': {
'Title': 'string',
'RefId': 'string',
'Instructions': 'string',
'Items': {'... recursive ...'},
'Weight': 123.0,
'IsExcludedFromScoring': True|False,
'ScoreThresholds': [
{
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
'MinScorePercentage': 123.0,
'MaxScorePercentage': 123.0
},
]
},
'Question': {
'Title': 'string',
'Instructions': 'string',
'RefId': 'string',
'NotApplicableEnabled': True|False,
'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
'QuestionTypeProperties': {
'Numeric': {
'MinValue': 123,
'MaxValue': 123,
'Options': [
{
'MinValue': 123,
'MaxValue': 123,
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
},
'PointsConfiguration': {
'PointValue': 123,
'IsBonus': True|False
}
},
],
'Automation': {
'PropertyValue': {
'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': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'SingleSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string',
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
},
'PointsConfiguration': {
'PointValue': 123,
'IsBonus': True|False
}
},
],
'DisplayAs': 'DROPDOWN'|'RADIO',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefId': 'string'
}
},
],
'DefaultOptionRefId': 'string',
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'Text': {
'Automation': {
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'MultiSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string',
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
},
'PointsConfiguration': {
'PointValue': 123,
'IsBonus': True|False
}
},
],
'DisplayAs': 'DROPDOWN'|'CHECKBOX',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefIds': [
'string',
]
}
},
],
'DefaultOptionRefIds': [
'string',
],
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
}
},
'Enablement': {
'Condition': {
'Operands': [
{
'Expression': {
'Source': {
'Type': 'QUESTION_REF_ID',
'RefId': 'string'
},
'Values': [
{
'Type': 'OPTION_REF_ID',
'RefId': 'string'
},
],
'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'
},
'Condition': {'... recursive ...'}
},
],
'Operator': 'OR'|'AND'
},
'Action': 'DISABLE'|'ENABLE',
'DefaultAction': 'DISABLE'|'ENABLE'
},
'Weight': 123.0,
'ScoringConfiguration': {
'PointsConfiguration': {
'MaxPointValue': 123,
'MinPointValue': 123,
'IsBonus': True|False
},
'IsExcludedFromScoring': True|False,
'ScoreThresholds': [
{
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
'MinScorePercentage': 123.0,
'MaxScorePercentage': 123.0
},
]
}
}
},
],
'ScoringStrategy': {
'Mode': 'QUESTION_ONLY'|'SECTION_ONLY'|'POINTS_BASED',
'Status': 'ENABLED'|'DISABLED',
'ScoreThresholds': [
{
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
'MinScorePercentage': 123.0,
'MaxScorePercentage': 123.0
},
]
},
'CreatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedBy': 'string',
'AutoEvaluationConfiguration': {
'Enabled': True|False
},
'ReviewConfiguration': {
'ReviewNotificationRecipients': [
{
'Type': 'USER_ID',
'Value': {
'UserId': 'string'
}
},
],
'EligibilityDays': 123
},
'Tags': {
'string': 'string'
},
'TargetConfiguration': {
'ContactInteractionType': 'AGENT'|'AUTOMATED'|'CUSTOMER'
},
'LanguageConfiguration': {
'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'
},
'LatestValidationStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
'LastValidationTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
EvaluationForm (dict) --
Information about the evaluation form.
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormVersion (integer) --
A version of the evaluation form.
Locked (boolean) --
The flag indicating whether the evaluation form is locked for changes.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the evaluation form resource.
Title (string) --
A title of the evaluation form.
Description (string) --
The description of the evaluation form.
Status (string) --
The status of the evaluation form.
Items (list) --
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.
(dict) --
Information about an item from an evaluation form. The item must be either a section or a question.
Section (dict) --
The information of the section.
Title (string) --
The title of the section.
RefId (string) --
The identifier of the section. An identifier must be unique within the evaluation form.
Instructions (string) --
The instructions of the section.
Items (list) --
The items of the section.
Weight (float) --
The scoring weight of the section.
IsExcludedFromScoring (boolean) --
The flag to exclude the section from scoring.
ScoreThresholds (list) --
The score thresholds for performance categories.
(dict) --
Information about a score threshold for a performance category.
PerformanceCategory (string) --
The performance category name.
MinScorePercentage (float) --
The minimum score percentage for the performance category.
MaxScorePercentage (float) --
The maximum score percentage for the performance category.
Question (dict) --
The information of the question.
Title (string) --
The title of the question.
Instructions (string) --
The instructions of the section.
RefId (string) --
The identifier of the question. An identifier must be unique within the evaluation form.
NotApplicableEnabled (boolean) --
The flag to enable not applicable answers to the question.
QuestionType (string) --
The type of the question.
QuestionTypeProperties (dict) --
The properties of the type of question. Text questions do not have to define question type properties.
Numeric (dict) --
The properties of the numeric question.
MinValue (integer) --
The minimum answer value.
MaxValue (integer) --
The maximum answer value.
Options (list) --
The scoring options of the numeric question.
(dict) --
Information about the option range used for scoring in numeric questions.
MinValue (integer) --
The minimum answer value of the range option.
MaxValue (integer) --
The maximum answer value of the range option.
Score (integer) --
The score assigned to answer values within the range option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
A configuration for automatic fail.
TargetSection (string) --
The referenceId of the target section for auto failure.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
PointValue (integer) --
The point value assigned to the answer option.
IsBonus (boolean) --
The flag to mark the option as a bonus option.
Automation (dict) --
The automation properties of the numeric question.
PropertyValue (dict) --
The property value of the automation.
Label (string) --
The property label of the automation.
AnswerSource (dict) --
A source of automation answer for numeric question.
SourceType (string) --
The automation answer source type.
SingleSelect (dict) --
The properties of the numeric question.
Options (list) --
The answer options of the single select question.
(dict) --
Information about the automation configuration in single select questions.
RefId (string) --
The identifier of the answer option. An identifier must be unique within the question.
Text (string) --
The title of the answer option.
Score (integer) --
The score assigned to the answer option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
Whether automatic fail is configured on a single select question.
TargetSection (string) --
The referenceId of the target section for auto failure.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
PointValue (integer) --
The point value assigned to the answer option.
IsBonus (boolean) --
The flag to mark the option as a bonus option.
DisplayAs (string) --
The display mode of the single select question.
Automation (dict) --
The display mode of the single select question.
Options (list) --
The automation options of the single select question.
(dict) --
Information about the automation option of a single select question.
RuleCategory (dict) --
The automation option based on a rule category for the single select question.
Category (string) --
The category name, as defined in Rules.
Condition (string) --
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.
OptionRefId (string) --
The identifier of the answer option.
DefaultOptionRefId (string) --
The identifier of the default answer option, when none of the automation options match the criteria.
AnswerSource (dict) --
Automation answer source.
SourceType (string) --
The automation answer source type.
Text (dict) --
The properties of the text question.
Automation (dict) --
The automation properties of the text question.
AnswerSource (dict) --
Automation answer source.
SourceType (string) --
The automation answer source type.
MultiSelect (dict) --
Properties for multi-select question types.
Options (list) --
Options available for this multi-select question.
(dict) --
An option for a multi-select question in an evaluation form.
RefId (string) --
Reference identifier for this option.
Text (string) --
Display text for this option.
Score (integer) --
The score assigned to the answer option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
Information about automatic fail configuration for an evaluation form.
TargetSection (string) --
The referenceId of the target section for auto failure.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
PointValue (integer) --
The point value assigned to the answer option.
IsBonus (boolean) --
The flag to mark the option as a bonus option.
DisplayAs (string) --
Display format for the multi-select question.
Automation (dict) --
Automation configuration for this multi-select question.
Options (list) --
Automation options for the multi-select question.
(dict) --
An automation option for a multi-select question.
RuleCategory (dict) --
Rule category configuration for this automation option.
Category (string) --
The category name for this automation rule.
Condition (string) --
The condition for this automation rule.
OptionRefIds (list) --
Reference IDs of options for this automation rule.
(string) --
DefaultOptionRefIds (list) --
Reference IDs of default options.
(string) --
AnswerSource (dict) --
A question automation answer.
SourceType (string) --
The automation answer source type.
Enablement (dict) --
A question conditional enablement.
Condition (dict) --
A condition for item enablement configuration.
Operands (list) --
Operands of the enablement condition.
(dict) --
An operand of the enablement condition.
Expression (dict) --
An expression of the enablement condition.
Source (dict) --
A source item of enablement expression.
Type (string) --
A type of source item.
RefId (string) --
A referenceId of the source item.
Values (list) --
A list of values from source item.
(dict) --
An enablement expression source value.
Type (string) --
A type of source item value.
RefId (string) --
A referenceId of the source value.
Comparator (string) --
A comparator to be used against list of values.
Condition (dict) --
A condition for item enablement.
Operator (string) --
The operator to be used to be applied to operands if more than one provided.
Action (string) --
An enablement action that if condition is satisfied.
DefaultAction (string) --
An enablement action that if condition is not satisfied.
Weight (float) --
The scoring weight of the section.
ScoringConfiguration (dict) --
The scoring configuration of the question.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
MaxPointValue (integer) --
The maximum point value.
MinPointValue (integer) --
The minimum point value.
IsBonus (boolean) --
The flag to mark the question as a bonus question.
IsExcludedFromScoring (boolean) --
The flag to exclude the question from scoring.
ScoreThresholds (list) --
The score thresholds for performance categories.
(dict) --
Information about a score threshold for a performance category.
PerformanceCategory (string) --
The performance category name.
MinScorePercentage (float) --
The minimum score percentage for the performance category.
MaxScorePercentage (float) --
The maximum score percentage for the performance category.
ScoringStrategy (dict) --
A scoring strategy of the evaluation form.
Mode (string) --
The scoring mode of the evaluation form.
Status (string) --
The scoring status of the evaluation form.
ScoreThresholds (list) --
The score thresholds for performance categories.
(dict) --
Information about a score threshold for a performance category.
PerformanceCategory (string) --
The performance category name.
MinScorePercentage (float) --
The minimum score percentage for the performance category.
MaxScorePercentage (float) --
The maximum score percentage for the performance category.
CreatedTime (datetime) --
The timestamp for when the evaluation form was created.
CreatedBy (string) --
The Amazon Resource Name (ARN) of the user who created the evaluation form.
LastModifiedTime (datetime) --
The timestamp for when the evaluation form was last updated.
LastModifiedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
AutoEvaluationConfiguration (dict) --
The automatic evaluation configuration of an evaluation form.
Enabled (boolean) --
When automated evaluation is enabled.
ReviewConfiguration (dict) --
Configuration for evaluation review settings of this evaluation form.
ReviewNotificationRecipients (list) --
List of recipients who should be notified when a review is requested.
(dict) --
Information about a recipient who should be notified when an evaluation review is requested.
Type (string) --
The type of notification recipient.
Value (dict) --
The value associated with the notification recipient type.
UserId (string) --
The user identifier for the notification recipient.
EligibilityDays (integer) --
Number of days during which a request for review can be submitted for evaluations created from this form.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
TargetConfiguration (dict) --
Configuration that specifies the target for this evaluation form.
ContactInteractionType (string) --
The contact interaction type for this evaluation form.
LanguageConfiguration (dict) --
Configuration for language settings of this evaluation form.
FormLanguage (string) --
The language for the evaluation form.
LatestValidationStatus (string) --
The status of the most recent validation run for this evaluation form. Valid values: IN_PROGRESS, COMPLETED, FAILED.
LastValidationTime (datetime) --
The timestamp when the most recent validation was started for this evaluation form.
{'EvaluationSummaryList': {'Score': {'EarnedPoints': 'integer',
'MaxBasePoint': 'integer',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}}}
Lists contact evaluations in the specified Connect Customer instance.
See also: AWS API Documentation
Request Syntax
client.list_contact_evaluations(
InstanceId='string',
ContactId='string',
NextToken='string'
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the contact in this instance of Connect Customer.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
dict
Response Syntax
{
'EvaluationSummaryList': [
{
'EvaluationId': 'string',
'EvaluationArn': 'string',
'EvaluationFormTitle': 'string',
'EvaluationFormId': 'string',
'CalibrationSessionId': 'string',
'Status': 'DRAFT'|'SUBMITTED'|'REVIEW_REQUESTED'|'UNDER_REVIEW',
'AutoEvaluationEnabled': True|False,
'AutoEvaluationStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'EvaluatorArn': 'string',
'Score': {
'Percentage': 123.0,
'NotApplicable': True|False,
'AutomaticFail': True|False,
'AppliedWeight': 123.0,
'EarnedPoints': 123,
'MaxBasePoint': 123,
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS'
},
'Acknowledgement': {
'AcknowledgedTime': datetime(2015, 1, 1),
'AcknowledgedBy': 'string',
'AcknowledgerComment': 'string'
},
'EvaluationType': 'STANDARD'|'CALIBRATION',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'ContactParticipant': {
'ContactParticipantRole': 'AGENT'|'SYSTEM'|'CUSTOM_BOT'|'CUSTOMER',
'ContactParticipantId': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EvaluationSummaryList (list) --
Provides details about a list of contact evaluations belonging to an instance.
(dict) --
Summary information about a contact evaluation.
EvaluationId (string) --
A unique identifier for the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
EvaluationFormTitle (string) --
A title of the evaluation form.
EvaluationFormId (string) --
The unique identifier for the evaluation form.
CalibrationSessionId (string) --
The calibration session ID that this evaluation belongs to.
Status (string) --
The status of the contact evaluation.
AutoEvaluationEnabled (boolean) --
Whether automated evaluation is enabled.
AutoEvaluationStatus (string) --
The status of the contact auto evaluation.
EvaluatorArn (string) --
The Amazon Resource Name (ARN) of the user who last updated the evaluation.
Score (dict) --
The overall score of the contact evaluation.
Percentage (float) --
The score percentage for an item in a contact evaluation.
NotApplicable (boolean) --
The flag to mark the item as not applicable for scoring.
AutomaticFail (boolean) --
The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.
AppliedWeight (float) --
Weight applied to this evaluation score.
EarnedPoints (integer) --
The points earned for the item.
MaxBasePoint (integer) --
The maximum base points possible for the item.
PerformanceCategory (string) --
The performance category for the score.
Acknowledgement (dict) --
Information related to evaluation acknowledgement.
AcknowledgedTime (datetime) --
The time when an agent acknowledged the evaluation.
AcknowledgedBy (string) --
The agent who acknowledged the evaluation.
AcknowledgerComment (string) --
A comment from the agent when they confirmed they acknowledged the evaluation.
EvaluationType (string) --
Type of the evaluation.
CreatedTime (datetime) --
The timestamp for when the evaluation was created.
LastModifiedTime (datetime) --
The timestamp for when the evaluation was last updated.
ContactParticipant (dict) --
Information about a contact participant in the evaluation.
ContactParticipantRole (string) --
The role of the contact participant.
ContactParticipantId (string) --
The identifier for the contact participant.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'SearchFilter': {'ContactEvaluationAttributeFilter': {'AndCondition': {'AttributeConditions': [{'AttributeKey': 'ContactAgentId',
'AttributeValue': {'StringValue': 'string'},
'ComparisonType': 'EXACT'}],
'TagConditions': [{'TagKey': 'string',
'TagValue': 'string'}]},
'ContactEvaluationAttributeCondition': {'AttributeKey': 'ContactAgentId',
'AttributeValue': {'StringValue': 'string'},
'ComparisonType': 'EXACT'},
'OrConditions': [{'AttributeConditions': [{'AttributeKey': 'ContactAgentId',
'AttributeValue': {'StringValue': 'string'},
'ComparisonType': 'EXACT'}],
'TagConditions': [{'TagKey': 'string',
'TagValue': 'string'}]}],
'TagCondition': {'TagKey': 'string',
'TagValue': 'string'}}}}
Response {'EvaluationSearchSummaryList': {'Metadata': {'EarnedPoints': 'integer',
'MaxBasePoint': 'integer',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}}}
Searches contact evaluations in an Connect Customer instance, with optional filtering.
Use cases
Following are common uses cases for this API:
Find contact evaluations by using specific search criteria.
Find contact evaluations that are tagged with a specific set of tags.
Important things to know
A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds.
Endpoints: See Connect Customer endpoints and quotas.
See also: AWS API Documentation
Request Syntax
client.search_contact_evaluations(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
},
'NumberCondition': {
'FieldName': 'string',
'MinValue': 123,
'MaxValue': 123,
'ComparisonType': 'GREATER_OR_EQUAL'|'GREATER'|'LESSER_OR_EQUAL'|'LESSER'|'EQUAL'|'NOT_EQUAL'|'RANGE'
},
'BooleanCondition': {
'FieldName': 'string',
'ComparisonType': 'IS_TRUE'|'IS_FALSE'
},
'DateTimeCondition': {
'FieldName': 'string',
'MinValue': 'string',
'MaxValue': 'string',
'ComparisonType': 'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'RANGE'
},
'DecimalCondition': {
'FieldName': 'string',
'MinValue': 123.0,
'MaxValue': 123.0,
'ComparisonType': 'GREATER_OR_EQUAL'|'GREATER'|'LESSER_OR_EQUAL'|'LESSER'|'EQUAL'|'NOT_EQUAL'|'RANGE'
}
},
SearchFilter={
'AttributeFilter': {
'OrConditions': [
{
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
],
'AndCondition': {
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
},
'ContactEvaluationAttributeFilter': {
'OrConditions': [
{
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'AttributeConditions': [
{
'AttributeKey': 'ContactAgentId',
'AttributeValue': {
'StringValue': 'string'
},
'ComparisonType': 'EXACT'
},
]
},
],
'AndCondition': {
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'AttributeConditions': [
{
'AttributeKey': 'ContactAgentId',
'AttributeValue': {
'StringValue': 'string'
},
'ComparisonType': 'EXACT'
},
]
},
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
},
'ContactEvaluationAttributeCondition': {
'AttributeKey': 'ContactAgentId',
'AttributeValue': {
'StringValue': 'string'
},
'ComparisonType': 'EXACT'
}
}
}
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
integer
The maximum number of results to return per page.
dict
The search criteria to be used to return contact evaluations.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return evaluations.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return evaluations.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
FieldName (string) --
The name of the field in the string condition.
Value (string) --
The value of the string.
ComparisonType (string) --
The type of comparison to be made when evaluating the string condition.
NumberCondition (dict) --
A leaf node condition which can be used to specify a numeric condition.
FieldName (string) --
The name of the field in the number condition.
MinValue (integer) --
The minValue to be used while evaluating the number condition.
MaxValue (integer) --
The maxValue to be used while evaluating the number condition.
ComparisonType (string) --
The type of comparison to be made when evaluating the number condition.
BooleanCondition (dict) --
The boolean condition search criteria for searching evaluations.
FieldName (string) --
A name of the property to be searched.
ComparisonType (string) --
Boolean property comparison type.
DateTimeCondition (dict) --
The datetime condition search criteria for searching evaluations.
FieldName (string) --
A name of the datetime property to be searched
MinValue (string) --
A minimum value of the property.
MaxValue (string) --
A maximum value of the property.
ComparisonType (string) --
Datetime property comparison type.
DecimalCondition (dict) --
The decimal condition search criteria for searching evaluations.
FieldName (string) --
A name of the decimal property to be searched.
MinValue (float) --
A minimum value of the decimal property.
MaxValue (float) --
A maximum value of the decimal property.
ComparisonType (string) --
The type of comparison to be made when evaluating the decimal condition.
dict
Filters to be applied to search results.
AttributeFilter (dict) --
An object that can be used to specify tag conditions.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AndCondition (dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
TagCondition (dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
ContactEvaluationAttributeFilter (dict) --
An object that can be used to specify tag conditions and attribute conditions for contact evaluations.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A list of tag conditions to apply.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AttributeConditions (list) --
A list of attribute conditions to apply.
(dict) --
An attribute condition for contact evaluation filtering.
AttributeKey (string) --
The key of the attribute.
AttributeValue (dict) --
The value of the attribute.
StringValue (string) --
A string value for the attribute.
ComparisonType (string) --
The comparison type for the condition.
AndCondition (dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A list of tag conditions to apply.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AttributeConditions (list) --
A list of attribute conditions to apply.
(dict) --
An attribute condition for contact evaluation filtering.
AttributeKey (string) --
The key of the attribute.
AttributeValue (dict) --
The value of the attribute.
StringValue (string) --
A string value for the attribute.
ComparisonType (string) --
The comparison type for the condition.
TagCondition (dict) --
A tag condition to apply.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
ContactEvaluationAttributeCondition (dict) --
An attribute condition to apply.
AttributeKey (string) --
The key of the attribute.
AttributeValue (dict) --
The value of the attribute.
StringValue (string) --
A string value for the attribute.
ComparisonType (string) --
The comparison type for the condition.
dict
Response Syntax
{
'EvaluationSearchSummaryList': [
{
'EvaluationId': 'string',
'EvaluationArn': 'string',
'EvaluationFormId': 'string',
'EvaluationFormVersion': 123,
'EvaluationFormTitle': 'string',
'Metadata': {
'ContactId': 'string',
'EvaluatorArn': 'string',
'ContactAgentId': 'string',
'CalibrationSessionId': 'string',
'ScorePercentage': 123.0,
'ScoreAutomaticFail': True|False,
'ScoreNotApplicable': True|False,
'AutoEvaluationEnabled': True|False,
'AutoEvaluationStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'AcknowledgedTime': datetime(2015, 1, 1),
'AcknowledgedBy': 'string',
'AcknowledgerComment': 'string',
'SamplingJobId': 'string',
'ReviewId': 'string',
'ContactParticipantRole': 'AGENT'|'SYSTEM'|'CUSTOM_BOT'|'CUSTOMER',
'ContactParticipantId': 'string',
'EarnedPoints': 123,
'MaxBasePoint': 123,
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS'
},
'Status': 'DRAFT'|'SUBMITTED'|'REVIEW_REQUESTED'|'UNDER_REVIEW',
'EvaluationType': 'STANDARD'|'CALIBRATION',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
EvaluationSearchSummaryList (list) --
Contains information about contact evaluations.
(dict) --
Summary of evaluation obtained from the search operation.
EvaluationId (string) --
A unique identifier for the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormVersion (integer) --
A version of the evaluation form.
EvaluationFormTitle (string) --
Title of the evaluation form.
Metadata (dict) --
Summary information about the evaluation search.
ContactId (string) --
The identifier of the contact in this instance of Connect Customer.
EvaluatorArn (string) --
The Amazon Resource Name (ARN) of the person who evaluated the contact.
ContactAgentId (string) --
The unique ID of the agent who handled the contact.
CalibrationSessionId (string) --
The calibration session ID that this evaluation belongs to.
ScorePercentage (float) --
The total evaluation score expressed as a percentage.
ScoreAutomaticFail (boolean) --
The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag is true.
ScoreNotApplicable (boolean) --
The flag to mark the item as not applicable for scoring.
AutoEvaluationEnabled (boolean) --
Whether auto-evaluation is enabled.
AutoEvaluationStatus (string) --
The status of the contact auto evaluation.
AcknowledgedTime (datetime) --
When the evaluation was acknowledged by the agent.
AcknowledgedBy (string) --
The agent who acknowledged the evaluation.
AcknowledgerComment (string) --
The comment from the agent when they acknowledged the evaluation.
SamplingJobId (string) --
Identifier of the sampling job.
ReviewId (string) --
Identifier for the review.
ContactParticipantRole (string) --
Role of a contact participant in the evaluation.
ContactParticipantId (string) --
Identifier for a contact participant in the evaluation.
EarnedPoints (integer) --
The points earned for the evaluation.
MaxBasePoint (integer) --
The maximum base points possible for the evaluation.
PerformanceCategory (string) --
The performance category for the evaluation score.
Status (string) --
The status of the evaluation.
EvaluationType (string) --
Type of the evaluation.
CreatedTime (datetime) --
The date and time when the evaluation was created, in UTC time.
LastModifiedTime (datetime) --
The date and time when the evaluation was modified last time, in UTC time.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of contact evaluations that matched your search query.
{'Items': {'Question': {'QuestionTypeProperties': {'MultiSelect': {'Options': {'AutomaticFail': 'boolean',
'AutomaticFailConfiguration': {'TargetSection': 'string'},
'PointsConfiguration': {'IsBonus': 'boolean',
'PointValue': 'integer'},
'Score': 'integer'}},
'Numeric': {'Options': {'PointsConfiguration': {'IsBonus': 'boolean',
'PointValue': 'integer'}}},
'SingleSelect': {'Options': {'PointsConfiguration': {'IsBonus': 'boolean',
'PointValue': 'integer'}}}},
'ScoringConfiguration': {'IsExcludedFromScoring': 'boolean',
'PointsConfiguration': {'IsBonus': 'boolean',
'MaxPointValue': 'integer',
'MinPointValue': 'integer'},
'ScoreThresholds': [{'MaxScorePercentage': 'double',
'MinScorePercentage': 'double',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}]}},
'Section': {'IsExcludedFromScoring': 'boolean',
'ScoreThresholds': [{'MaxScorePercentage': 'double',
'MinScorePercentage': 'double',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}]}},
'ScoringStrategy': {'Mode': {'POINTS_BASED'},
'ScoreThresholds': [{'MaxScorePercentage': 'double',
'MinScorePercentage': 'double',
'PerformanceCategory': 'NEEDS_IMPROVEMENT '
'| '
'EXCEEDS_EXPECTATIONS'}]}}
Updates details about a specific evaluation form version in the specified Connect Customer instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
See also: AWS API Documentation
Request Syntax
client.update_evaluation_form(
InstanceId='string',
EvaluationFormId='string',
EvaluationFormVersion=123,
CreateNewVersion=True|False,
Title='string',
Description='string',
Items=[
{
'Section': {
'Title': 'string',
'RefId': 'string',
'Instructions': 'string',
'Items': {'... recursive ...'},
'Weight': 123.0,
'IsExcludedFromScoring': True|False,
'ScoreThresholds': [
{
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
'MinScorePercentage': 123.0,
'MaxScorePercentage': 123.0
},
]
},
'Question': {
'Title': 'string',
'Instructions': 'string',
'RefId': 'string',
'NotApplicableEnabled': True|False,
'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
'QuestionTypeProperties': {
'Numeric': {
'MinValue': 123,
'MaxValue': 123,
'Options': [
{
'MinValue': 123,
'MaxValue': 123,
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
},
'PointsConfiguration': {
'PointValue': 123,
'IsBonus': True|False
}
},
],
'Automation': {
'PropertyValue': {
'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': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'SingleSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string',
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
},
'PointsConfiguration': {
'PointValue': 123,
'IsBonus': True|False
}
},
],
'DisplayAs': 'DROPDOWN'|'RADIO',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefId': 'string'
}
},
],
'DefaultOptionRefId': 'string',
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'Text': {
'Automation': {
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'MultiSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string',
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
},
'PointsConfiguration': {
'PointValue': 123,
'IsBonus': True|False
}
},
],
'DisplayAs': 'DROPDOWN'|'CHECKBOX',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefIds': [
'string',
]
}
},
],
'DefaultOptionRefIds': [
'string',
],
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
}
},
'Enablement': {
'Condition': {
'Operands': [
{
'Expression': {
'Source': {
'Type': 'QUESTION_REF_ID',
'RefId': 'string'
},
'Values': [
{
'Type': 'OPTION_REF_ID',
'RefId': 'string'
},
],
'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'
},
'Condition': {'... recursive ...'}
},
],
'Operator': 'OR'|'AND'
},
'Action': 'DISABLE'|'ENABLE',
'DefaultAction': 'DISABLE'|'ENABLE'
},
'Weight': 123.0,
'ScoringConfiguration': {
'PointsConfiguration': {
'MaxPointValue': 123,
'MinPointValue': 123,
'IsBonus': True|False
},
'IsExcludedFromScoring': True|False,
'ScoreThresholds': [
{
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
'MinScorePercentage': 123.0,
'MaxScorePercentage': 123.0
},
]
}
}
},
],
ScoringStrategy={
'Mode': 'QUESTION_ONLY'|'SECTION_ONLY'|'POINTS_BASED',
'Status': 'ENABLED'|'DISABLED',
'ScoreThresholds': [
{
'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
'MinScorePercentage': 123.0,
'MaxScorePercentage': 123.0
},
]
},
AutoEvaluationConfiguration={
'Enabled': True|False
},
ReviewConfiguration={
'ReviewNotificationRecipients': [
{
'Type': 'USER_ID',
'Value': {
'UserId': 'string'
}
},
],
'EligibilityDays': 123
},
AsDraft=True|False,
ClientToken='string',
TargetConfiguration={
'ContactInteractionType': 'AGENT'|'AUTOMATED'|'CUSTOMER'
},
LanguageConfiguration={
'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'
}
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The unique identifier for the evaluation form.
integer
[REQUIRED]
A version of the evaluation form to update.
boolean
A flag indicating whether the operation must create a new version.
string
[REQUIRED]
A title of the evaluation form.
string
The description of the evaluation form.
list
[REQUIRED]
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.
(dict) --
Information about an item from an evaluation form. The item must be either a section or a question.
Section (dict) --
The information of the section.
Title (string) -- [REQUIRED]
The title of the section.
RefId (string) -- [REQUIRED]
The identifier of the section. An identifier must be unique within the evaluation form.
Instructions (string) --
The instructions of the section.
Items (list) --
The items of the section.
Weight (float) --
The scoring weight of the section.
IsExcludedFromScoring (boolean) --
The flag to exclude the section from scoring.
ScoreThresholds (list) --
The score thresholds for performance categories.
(dict) --
Information about a score threshold for a performance category.
PerformanceCategory (string) -- [REQUIRED]
The performance category name.
MinScorePercentage (float) --
The minimum score percentage for the performance category.
MaxScorePercentage (float) --
The maximum score percentage for the performance category.
Question (dict) --
The information of the question.
Title (string) -- [REQUIRED]
The title of the question.
Instructions (string) --
The instructions of the section.
RefId (string) -- [REQUIRED]
The identifier of the question. An identifier must be unique within the evaluation form.
NotApplicableEnabled (boolean) --
The flag to enable not applicable answers to the question.
QuestionType (string) -- [REQUIRED]
The type of the question.
QuestionTypeProperties (dict) --
The properties of the type of question. Text questions do not have to define question type properties.
Numeric (dict) --
The properties of the numeric question.
MinValue (integer) -- [REQUIRED]
The minimum answer value.
MaxValue (integer) -- [REQUIRED]
The maximum answer value.
Options (list) --
The scoring options of the numeric question.
(dict) --
Information about the option range used for scoring in numeric questions.
MinValue (integer) -- [REQUIRED]
The minimum answer value of the range option.
MaxValue (integer) -- [REQUIRED]
The maximum answer value of the range option.
Score (integer) --
The score assigned to answer values within the range option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
A configuration for automatic fail.
TargetSection (string) --
The referenceId of the target section for auto failure.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
PointValue (integer) -- [REQUIRED]
The point value assigned to the answer option.
IsBonus (boolean) --
The flag to mark the option as a bonus option.
Automation (dict) --
The automation properties of the numeric question.
PropertyValue (dict) --
The property value of the automation.
Label (string) -- [REQUIRED]
The property label of the automation.
AnswerSource (dict) --
A source of automation answer for numeric question.
SourceType (string) -- [REQUIRED]
The automation answer source type.
SingleSelect (dict) --
The properties of the numeric question.
Options (list) -- [REQUIRED]
The answer options of the single select question.
(dict) --
Information about the automation configuration in single select questions.
RefId (string) -- [REQUIRED]
The identifier of the answer option. An identifier must be unique within the question.
Text (string) -- [REQUIRED]
The title of the answer option.
Score (integer) --
The score assigned to the answer option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
Whether automatic fail is configured on a single select question.
TargetSection (string) --
The referenceId of the target section for auto failure.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
PointValue (integer) -- [REQUIRED]
The point value assigned to the answer option.
IsBonus (boolean) --
The flag to mark the option as a bonus option.
DisplayAs (string) --
The display mode of the single select question.
Automation (dict) --
The display mode of the single select question.
Options (list) --
The automation options of the single select question.
(dict) --
Information about the automation option of a single select question.
RuleCategory (dict) --
The automation option based on a rule category for the single select question.
Category (string) -- [REQUIRED]
The category name, as defined in Rules.
Condition (string) -- [REQUIRED]
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.
OptionRefId (string) -- [REQUIRED]
The identifier of the answer option.
DefaultOptionRefId (string) --
The identifier of the default answer option, when none of the automation options match the criteria.
AnswerSource (dict) --
Automation answer source.
SourceType (string) -- [REQUIRED]
The automation answer source type.
Text (dict) --
The properties of the text question.
Automation (dict) --
The automation properties of the text question.
AnswerSource (dict) --
Automation answer source.
SourceType (string) -- [REQUIRED]
The automation answer source type.
MultiSelect (dict) --
Properties for multi-select question types.
Options (list) -- [REQUIRED]
Options available for this multi-select question.
(dict) --
An option for a multi-select question in an evaluation form.
RefId (string) -- [REQUIRED]
Reference identifier for this option.
Text (string) -- [REQUIRED]
Display text for this option.
Score (integer) --
The score assigned to the answer option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
Information about automatic fail configuration for an evaluation form.
TargetSection (string) --
The referenceId of the target section for auto failure.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
PointValue (integer) -- [REQUIRED]
The point value assigned to the answer option.
IsBonus (boolean) --
The flag to mark the option as a bonus option.
DisplayAs (string) --
Display format for the multi-select question.
Automation (dict) --
Automation configuration for this multi-select question.
Options (list) --
Automation options for the multi-select question.
(dict) --
An automation option for a multi-select question.
RuleCategory (dict) --
Rule category configuration for this automation option.
Category (string) -- [REQUIRED]
The category name for this automation rule.
Condition (string) -- [REQUIRED]
The condition for this automation rule.
OptionRefIds (list) -- [REQUIRED]
Reference IDs of options for this automation rule.
(string) --
DefaultOptionRefIds (list) --
Reference IDs of default options.
(string) --
AnswerSource (dict) --
A question automation answer.
SourceType (string) -- [REQUIRED]
The automation answer source type.
Enablement (dict) --
A question conditional enablement.
Condition (dict) -- [REQUIRED]
A condition for item enablement configuration.
Operands (list) -- [REQUIRED]
Operands of the enablement condition.
(dict) --
An operand of the enablement condition.
Expression (dict) --
An expression of the enablement condition.
Source (dict) -- [REQUIRED]
A source item of enablement expression.
Type (string) -- [REQUIRED]
A type of source item.
RefId (string) --
A referenceId of the source item.
Values (list) -- [REQUIRED]
A list of values from source item.
(dict) --
An enablement expression source value.
Type (string) -- [REQUIRED]
A type of source item value.
RefId (string) --
A referenceId of the source value.
Comparator (string) -- [REQUIRED]
A comparator to be used against list of values.
Condition (dict) --
A condition for item enablement.
Operator (string) --
The operator to be used to be applied to operands if more than one provided.
Action (string) -- [REQUIRED]
An enablement action that if condition is satisfied.
DefaultAction (string) --
An enablement action that if condition is not satisfied.
Weight (float) --
The scoring weight of the section.
ScoringConfiguration (dict) --
The scoring configuration of the question.
PointsConfiguration (dict) --
The points configuration for point-based scoring.
MaxPointValue (integer) --
The maximum point value.
MinPointValue (integer) --
The minimum point value.
IsBonus (boolean) --
The flag to mark the question as a bonus question.
IsExcludedFromScoring (boolean) --
The flag to exclude the question from scoring.
ScoreThresholds (list) --
The score thresholds for performance categories.
(dict) --
Information about a score threshold for a performance category.
PerformanceCategory (string) -- [REQUIRED]
The performance category name.
MinScorePercentage (float) --
The minimum score percentage for the performance category.
MaxScorePercentage (float) --
The maximum score percentage for the performance category.
dict
A scoring strategy of the evaluation form.
Mode (string) -- [REQUIRED]
The scoring mode of the evaluation form.
Status (string) -- [REQUIRED]
The scoring status of the evaluation form.
ScoreThresholds (list) --
The score thresholds for performance categories.
(dict) --
Information about a score threshold for a performance category.
PerformanceCategory (string) -- [REQUIRED]
The performance category name.
MinScorePercentage (float) --
The minimum score percentage for the performance category.
MaxScorePercentage (float) --
The maximum score percentage for the performance category.
dict
Whether automated evaluations are enabled.
Enabled (boolean) -- [REQUIRED]
When automated evaluation is enabled.
dict
Configuration for evaluation review settings of the evaluation form.
ReviewNotificationRecipients (list) -- [REQUIRED]
List of recipients who should be notified when a review is requested.
(dict) --
Information about a recipient who should be notified when an evaluation review is requested.
Type (string) -- [REQUIRED]
The type of notification recipient.
Value (dict) -- [REQUIRED]
The value associated with the notification recipient type.
UserId (string) --
The user identifier for the notification recipient.
EligibilityDays (integer) --
Number of days during which a request for review can be submitted for evaluations created from this form.
boolean
A boolean flag indicating whether to update evaluation form to draft state.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
dict
Configuration that specifies the target for the evaluation form.
ContactInteractionType (string) -- [REQUIRED]
The contact interaction type for this evaluation form.
dict
Configuration for language settings of the evaluation form.
FormLanguage (string) --
The language for the evaluation form.
dict
Response Syntax
{
'EvaluationFormId': 'string',
'EvaluationFormArn': 'string',
'EvaluationFormVersion': 123
}
Response Structure
(dict) --
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
EvaluationFormVersion (integer) --
The version of the updated evaluation form resource.