2025/11/06 - Amazon Connect Service - 2 new8 updated api methods
Changes Added support for Conditional Questions in Evaluation Forms. Introduced Auto Evaluation capability for Evaluation Forms and Contact Evaluations. Added new API operations: SearchEvaluationForms and SearchContactEvaluations.
Searches evaluation forms in an Amazon Connect instance, with optional filtering.
Use cases
Following are common uses cases for this API:
List all evaluation forms in an instance.
Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more.
Find all evaluation forms 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 Amazon Connect endpoints and quotas.
See also: AWS API Documentation
Request Syntax
client.search_evaluation_forms(
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'
}
},
SearchFilter={
'AttributeFilter': {
'OrConditions': [
{
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
],
'AndCondition': {
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
}
)
string
[REQUIRED]
The identifier of the Amazon Connect 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 evaluation forms.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return evaluation forms.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return evaluation forms.
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) --
Boolean search condition.
FieldName (string) --
A name of the property to be searched.
ComparisonType (string) --
Boolean property comparison type.
DateTimeCondition (dict) --
Datetime search condition.
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.
dict
Filters to be applied to search results.
AttributeFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
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.
dict
Response Syntax
{
'EvaluationFormSearchSummaryList': [
{
'EvaluationFormId': 'string',
'EvaluationFormArn': 'string',
'Title': 'string',
'Status': 'DRAFT'|'ACTIVE',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedBy': 'string',
'LastActivatedTime': datetime(2015, 1, 1),
'LastActivatedBy': 'string',
'LatestVersion': 123,
'ActiveVersion': 123,
'AutoEvaluationEnabled': True|False,
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
EvaluationFormSearchSummaryList (list) --
Information about the returned evaluation forms.
(dict) --
Information about the returned evaluation forms.
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the evaluation form resource.
Title (string) --
The title of the evaluation form.
Status (string) --
The status of the evaluation form.
Description (string) --
The description of the evaluation form.
CreatedTime (datetime) --
When the evaluation form was created.
CreatedBy (string) --
Who created the evaluation form.
LastModifiedTime (datetime) --
When the evaluation form was last changed.
LastModifiedBy (string) --
Who changed the evaluation form.
LastActivatedTime (datetime) --
When the evaluation format was last activated.
LastActivatedBy (string) --
The ID of user who last activated evaluation form.
LatestVersion (integer) --
Latest version of the evaluation form.
ActiveVersion (integer) --
Active version of the evaluation form.
AutoEvaluationEnabled (boolean) --
Whether automated evaluation is enabled.
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 evaluation forms that matched your search query.
Searches contact evaluations in an Amazon Connect 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. Contact Evaluations may not be fully backfilled with historical data in all regions yet, however all recently created Contact Evaluations should be available for search.
Endpoints: See Amazon Connect 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'
}
}
}
)
string
[REQUIRED]
The identifier of the Amazon Connect 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 inside the SearchFilter. This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
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.
dict
Response Syntax
{
'EvaluationSearchSummaryList': [
{
'EvaluationId': 'string',
'EvaluationArn': 'string',
'EvaluationFormId': 'string',
'EvaluationFormVersion': 123,
'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'
},
'Status': 'DRAFT'|'SUBMITTED',
'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.
Metadata (dict) --
Summary information about the evaluation search.
ContactId (string) --
The identifier of the contact in this instance of Amazon Connect.
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.
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.
{'AutoEvaluationConfiguration': {'Enabled': 'boolean'},
'Items': {'Question': {'Enablement': {'Action': 'DISABLE | ENABLE',
'Condition': {'Operands': [{'Condition': (),
'Expression': {'Comparator': 'IN '
'| '
'NOT_IN',
'Source': {'RefId': 'string',
'Type': 'QUESTION_REF_ID'},
'Values': [{'RefId': 'string',
'Type': 'OPTION_REF_ID'}]}}],
'Operator': 'OR | AND'},
'DefaultAction': 'DISABLE | ENABLE'},
'QuestionTypeProperties': {'Numeric': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'},
'PropertyValue': {'Label': {'AGENT_INTERACTION_AND_HOLD_DURATION',
'LONGEST_HOLD_DURATION',
'NUMBER_OF_HOLDS'}}},
'Options': {'AutomaticFailConfiguration': {'TargetSection': 'string'}}},
'SingleSelect': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'}},
'Options': {'AutomaticFailConfiguration': {'TargetSection': 'string'}}},
'Text': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'}}}}}},
'Tags': {'string': 'string'}}
Creates an evaluation form in the specified Amazon Connect 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
},
'Question': {
'Title': 'string',
'Instructions': 'string',
'RefId': 'string',
'NotApplicableEnabled': True|False,
'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC',
'QuestionTypeProperties': {
'Numeric': {
'MinValue': 123,
'MaxValue': 123,
'Options': [
{
'MinValue': 123,
'MaxValue': 123,
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
}
},
],
'Automation': {
'PropertyValue': {
'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'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'
}
},
],
'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'
}
}
}
},
'Enablement': {
'Condition': {
'Operands': [
{
'Expression': {
'Source': {
'Type': 'QUESTION_REF_ID',
'RefId': 'string'
},
'Values': [
{
'Type': 'OPTION_REF_ID',
'RefId': 'string'
},
],
'Comparator': 'IN'|'NOT_IN'
},
'Condition': {'... recursive ...'}
},
],
'Operator': 'OR'|'AND'
},
'Action': 'DISABLE'|'ENABLE',
'DefaultAction': 'DISABLE'|'ENABLE'
},
'Weight': 123.0
}
},
],
ScoringStrategy={
'Mode': 'QUESTION_ONLY'|'SECTION_ONLY',
'Status': 'ENABLED'|'DISABLED'
},
AutoEvaluationConfiguration={
'Enabled': True|False
},
ClientToken='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The identifier of the Amazon Connect 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.
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.
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.
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.
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.
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.
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.
dict
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
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': {'Answers': {'SuggestedAnswers': [{'AnalysisDetails': {'ContactLens': {'MatchedRuleCategories': [{'Category': 'string',
'Condition': 'PRESENT '
'| '
'NOT_PRESENT',
'PointsOfInterest': [{'MillisecondOffsets': {'BeginOffsetMillis': 'integer'},
'TranscriptSegment': 'string'}]}]},
'GenAI': {'Justification': 'string',
'PointsOfInterest': [{'MillisecondOffsets': {'BeginOffsetMillis': 'integer'},
'TranscriptSegment': 'string'}]}},
'AnalysisType': 'CONTACT_LENS_DATA '
'| GEN_AI',
'Input': {'TranscriptType': 'RAW '
'| '
'REDACTED'},
'Status': 'IN_PROGRESS | '
'FAILED | '
'SUCCEEDED',
'Value': {'NotApplicable': 'boolean',
'NumericValue': 'double',
'StringValue': 'string'}}]},
'EvaluationType': 'STANDARD | CALIBRATION',
'Metadata': {'Acknowledgement': {'AcknowledgedBy': 'string',
'AcknowledgedTime': 'timestamp',
'AcknowledgerComment': 'string'},
'AutoEvaluation': {'AutoEvaluationEnabled': 'boolean',
'AutoEvaluationStatus': 'IN_PROGRESS '
'| '
'FAILED '
'| '
'SUCCEEDED'},
'CalibrationSessionId': 'string'}},
'EvaluationForm': {'AutoEvaluationConfiguration': {'Enabled': 'boolean'},
'Items': {'Question': {'Enablement': {'Action': 'DISABLE | '
'ENABLE',
'Condition': {'Operands': [{'Condition': (),
'Expression': {'Comparator': 'IN '
'| '
'NOT_IN',
'Source': {'RefId': 'string',
'Type': 'QUESTION_REF_ID'},
'Values': [{'RefId': 'string',
'Type': 'OPTION_REF_ID'}]}}],
'Operator': 'OR '
'| '
'AND'},
'DefaultAction': 'DISABLE '
'| '
'ENABLE'},
'QuestionTypeProperties': {'Numeric': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'},
'PropertyValue': {'Label': {'AGENT_INTERACTION_AND_HOLD_DURATION',
'LONGEST_HOLD_DURATION',
'NUMBER_OF_HOLDS'}}},
'Options': {'AutomaticFailConfiguration': {'TargetSection': 'string'}}},
'SingleSelect': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'}},
'Options': {'AutomaticFailConfiguration': {'TargetSection': 'string'}}},
'Text': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'}}}}}}}}
Describes a contact evaluation in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.describe_contact_evaluation(
InstanceId='string',
EvaluationId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect 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
},
'AutoEvaluation': {
'AutoEvaluationEnabled': True|False,
'AutoEvaluationStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
},
'Acknowledgement': {
'AcknowledgedTime': datetime(2015, 1, 1),
'AcknowledgedBy': 'string',
'AcknowledgerComment': 'string'
}
},
'Answers': {
'string': {
'Value': {
'StringValue': 'string',
'NumericValue': 123.0,
'NotApplicable': True|False
},
'SystemSuggestedValue': {
'StringValue': 'string',
'NumericValue': 123.0,
'NotApplicable': True|False
},
'SuggestedAnswers': [
{
'Value': {
'StringValue': 'string',
'NumericValue': 123.0,
'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',
'Scores': {
'string': {
'Percentage': 123.0,
'NotApplicable': True|False,
'AutomaticFail': True|False
}
},
'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
},
'Question': {
'Title': 'string',
'Instructions': 'string',
'RefId': 'string',
'NotApplicableEnabled': True|False,
'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC',
'QuestionTypeProperties': {
'Numeric': {
'MinValue': 123,
'MaxValue': 123,
'Options': [
{
'MinValue': 123,
'MaxValue': 123,
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
}
},
],
'Automation': {
'PropertyValue': {
'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'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'
}
},
],
'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'
}
}
}
},
'Enablement': {
'Condition': {
'Operands': [
{
'Expression': {
'Source': {
'Type': 'QUESTION_REF_ID',
'RefId': 'string'
},
'Values': [
{
'Type': 'OPTION_REF_ID',
'RefId': 'string'
},
],
'Comparator': 'IN'|'NOT_IN'
},
'Condition': {'... recursive ...'}
},
],
'Operator': 'OR'|'AND'
},
'Action': 'DISABLE'|'ENABLE',
'DefaultAction': 'DISABLE'|'ENABLE'
},
'Weight': 123.0
}
},
],
'ScoringStrategy': {
'Mode': 'QUESTION_ONLY'|'SECTION_ONLY',
'Status': 'ENABLED'|'DISABLED'
},
'AutoEvaluationConfiguration': {
'Enabled': True|False
}
}
}
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 Amazon Connect.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
AutoEvaluationConfiguration (dict) --
The configuration of the automated evaluation.
Enabled (boolean) --
When automated evaluation is enabled.
{'EvaluationForm': {'AutoEvaluationConfiguration': {'Enabled': 'boolean'},
'Items': {'Question': {'Enablement': {'Action': 'DISABLE | '
'ENABLE',
'Condition': {'Operands': [{'Condition': (),
'Expression': {'Comparator': 'IN '
'| '
'NOT_IN',
'Source': {'RefId': 'string',
'Type': 'QUESTION_REF_ID'},
'Values': [{'RefId': 'string',
'Type': 'OPTION_REF_ID'}]}}],
'Operator': 'OR '
'| '
'AND'},
'DefaultAction': 'DISABLE '
'| '
'ENABLE'},
'QuestionTypeProperties': {'Numeric': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'},
'PropertyValue': {'Label': {'AGENT_INTERACTION_AND_HOLD_DURATION',
'LONGEST_HOLD_DURATION',
'NUMBER_OF_HOLDS'}}},
'Options': {'AutomaticFailConfiguration': {'TargetSection': 'string'}}},
'SingleSelect': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'}},
'Options': {'AutomaticFailConfiguration': {'TargetSection': 'string'}}},
'Text': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'}}}}}}}}
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
See also: AWS API Documentation
Request Syntax
client.describe_evaluation_form(
InstanceId='string',
EvaluationFormId='string',
EvaluationFormVersion=123
)
string
[REQUIRED]
The identifier of the Amazon Connect 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
},
'Question': {
'Title': 'string',
'Instructions': 'string',
'RefId': 'string',
'NotApplicableEnabled': True|False,
'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC',
'QuestionTypeProperties': {
'Numeric': {
'MinValue': 123,
'MaxValue': 123,
'Options': [
{
'MinValue': 123,
'MaxValue': 123,
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
}
},
],
'Automation': {
'PropertyValue': {
'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'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'
}
},
],
'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'
}
}
}
},
'Enablement': {
'Condition': {
'Operands': [
{
'Expression': {
'Source': {
'Type': 'QUESTION_REF_ID',
'RefId': 'string'
},
'Values': [
{
'Type': 'OPTION_REF_ID',
'RefId': 'string'
},
],
'Comparator': 'IN'|'NOT_IN'
},
'Condition': {'... recursive ...'}
},
],
'Operator': 'OR'|'AND'
},
'Action': 'DISABLE'|'ENABLE',
'DefaultAction': 'DISABLE'|'ENABLE'
},
'Weight': 123.0
}
},
],
'ScoringStrategy': {
'Mode': 'QUESTION_ONLY'|'SECTION_ONLY',
'Status': 'ENABLED'|'DISABLED'
},
'CreatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedBy': 'string',
'AutoEvaluationConfiguration': {
'Enabled': True|False
},
'Tags': {
'string': 'string'
}
}
}
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.
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.
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.
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.
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.
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.
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.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
{'EvaluationSummaryList': {'Acknowledgement': {'AcknowledgedBy': 'string',
'AcknowledgedTime': 'timestamp',
'AcknowledgerComment': 'string'},
'AutoEvaluationEnabled': 'boolean',
'AutoEvaluationStatus': 'IN_PROGRESS | FAILED | '
'SUCCEEDED',
'CalibrationSessionId': 'string',
'EvaluationType': 'STANDARD | CALIBRATION'}}
Lists contact evaluations in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_contact_evaluations(
InstanceId='string',
ContactId='string',
NextToken='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect 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 Amazon Connect.
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',
'AutoEvaluationEnabled': True|False,
'AutoEvaluationStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'EvaluatorArn': 'string',
'Score': {
'Percentage': 123.0,
'NotApplicable': True|False,
'AutomaticFail': True|False
},
'Acknowledgement': {
'AcknowledgedTime': datetime(2015, 1, 1),
'AcknowledgedBy': 'string',
'AcknowledgerComment': 'string'
},
'EvaluationType': 'STANDARD'|'CALIBRATION',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
},
],
'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.
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.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'AutoEvaluationConfiguration': {'Enabled': 'boolean'},
'Tags': {'string': 'string'}}
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
See also: AWS API Documentation
Request Syntax
client.start_contact_evaluation(
InstanceId='string',
ContactId='string',
EvaluationFormId='string',
AutoEvaluationConfiguration={
'Enabled': True|False
},
ClientToken='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The identifier of the Amazon Connect 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 Amazon Connect.
string
[REQUIRED]
The unique identifier for the evaluation form.
dict
Whether automated evaluations are enabled.
Enabled (boolean) -- [REQUIRED]
Whether automated evaluations are 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.
dict
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
dict
Response Syntax
{
'EvaluationId': 'string',
'EvaluationArn': 'string'
}
Response Structure
(dict) --
EvaluationId (string) --
A unique identifier for the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
{'SubmittedBy': {'ConnectUserArn': 'string'}}
Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ( {}) to the question identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
See also: AWS API Documentation
Request Syntax
client.submit_contact_evaluation(
InstanceId='string',
EvaluationId='string',
Answers={
'string': {
'Value': {
'StringValue': 'string',
'NumericValue': 123.0,
'NotApplicable': True|False
}
}
},
Notes={
'string': {
'Value': 'string'
}
},
SubmittedBy={
'ConnectUserArn': 'string'
}
)
string
[REQUIRED]
The identifier of the Amazon Connect 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
A map of question identifiers to answer value.
(string) --
(dict) --
Information about input 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.
NotApplicable (boolean) --
The flag to mark the question as not applicable.
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.
dict
The ID of the user who submitted the contact evaluation.
ConnectUserArn (string) --
Represents the Amazon Connect ARN of the user.
dict
Response Syntax
{
'EvaluationId': 'string',
'EvaluationArn': 'string'
}
Response Structure
(dict) --
EvaluationId (string) --
A unique identifier for the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
{'UpdatedBy': {'ConnectUserArn': 'string'}}
Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ( {}) to the question identifier.
See also: AWS API Documentation
Request Syntax
client.update_contact_evaluation(
InstanceId='string',
EvaluationId='string',
Answers={
'string': {
'Value': {
'StringValue': 'string',
'NumericValue': 123.0,
'NotApplicable': True|False
}
}
},
Notes={
'string': {
'Value': 'string'
}
},
UpdatedBy={
'ConnectUserArn': 'string'
}
)
string
[REQUIRED]
The identifier of the Amazon Connect 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
A map of question identifiers to answer value.
(string) --
(dict) --
Information about input 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.
NotApplicable (boolean) --
The flag to mark the question as not applicable.
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.
dict
The ID of the user who updated the contact evaluation.
ConnectUserArn (string) --
Represents the Amazon Connect ARN of the user.
dict
Response Syntax
{
'EvaluationId': 'string',
'EvaluationArn': 'string'
}
Response Structure
(dict) --
EvaluationId (string) --
A unique identifier for the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
{'AutoEvaluationConfiguration': {'Enabled': 'boolean'},
'Items': {'Question': {'Enablement': {'Action': 'DISABLE | ENABLE',
'Condition': {'Operands': [{'Condition': (),
'Expression': {'Comparator': 'IN '
'| '
'NOT_IN',
'Source': {'RefId': 'string',
'Type': 'QUESTION_REF_ID'},
'Values': [{'RefId': 'string',
'Type': 'OPTION_REF_ID'}]}}],
'Operator': 'OR | AND'},
'DefaultAction': 'DISABLE | ENABLE'},
'QuestionTypeProperties': {'Numeric': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'},
'PropertyValue': {'Label': {'AGENT_INTERACTION_AND_HOLD_DURATION',
'LONGEST_HOLD_DURATION',
'NUMBER_OF_HOLDS'}}},
'Options': {'AutomaticFailConfiguration': {'TargetSection': 'string'}}},
'SingleSelect': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'}},
'Options': {'AutomaticFailConfiguration': {'TargetSection': 'string'}}},
'Text': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'}}}}}}}
Updates details about a specific evaluation form version in the specified Amazon Connect 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
},
'Question': {
'Title': 'string',
'Instructions': 'string',
'RefId': 'string',
'NotApplicableEnabled': True|False,
'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC',
'QuestionTypeProperties': {
'Numeric': {
'MinValue': 123,
'MaxValue': 123,
'Options': [
{
'MinValue': 123,
'MaxValue': 123,
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
}
},
],
'Automation': {
'PropertyValue': {
'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'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'
}
},
],
'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'
}
}
}
},
'Enablement': {
'Condition': {
'Operands': [
{
'Expression': {
'Source': {
'Type': 'QUESTION_REF_ID',
'RefId': 'string'
},
'Values': [
{
'Type': 'OPTION_REF_ID',
'RefId': 'string'
},
],
'Comparator': 'IN'|'NOT_IN'
},
'Condition': {'... recursive ...'}
},
],
'Operator': 'OR'|'AND'
},
'Action': 'DISABLE'|'ENABLE',
'DefaultAction': 'DISABLE'|'ENABLE'
},
'Weight': 123.0
}
},
],
ScoringStrategy={
'Mode': 'QUESTION_ONLY'|'SECTION_ONLY',
'Status': 'ENABLED'|'DISABLED'
},
AutoEvaluationConfiguration={
'Enabled': True|False
},
ClientToken='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect 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.
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.
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.
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.
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.
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.
dict
Whether automated evaluations are enabled.
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.
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.