Connect / Client / describe_contact_evaluation
describe_contact_evaluation#
- Connect.Client.describe_contact_evaluation(**kwargs)#
Describes a contact evaluation in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.describe_contact_evaluation( InstanceId='string', EvaluationId='string' )
- Parameters:
InstanceId (string) –
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
EvaluationId (string) –
[REQUIRED]
A unique identifier for the contact evaluation.
- Return type:
dict
- Returns:
Response Syntax
{ 'Evaluation': { 'EvaluationId': 'string', 'EvaluationArn': 'string', 'Metadata': { 'ContactId': 'string', 'EvaluatorArn': 'string', 'ContactAgentId': 'string', 'Score': { 'Percentage': 123.0, 'NotApplicable': True|False, 'AutomaticFail': True|False } }, 'Answers': { 'string': { 'Value': { 'StringValue': 'string', 'NumericValue': 123.0, 'NotApplicable': True|False }, 'SystemSuggestedValue': { 'StringValue': 'string', 'NumericValue': 123.0, 'NotApplicable': True|False } } }, '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), '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 }, ], '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' } } }, 'SingleSelect': { 'Options': [ { 'RefId': 'string', 'Text': 'string', 'Score': 123, 'AutomaticFail': True|False }, ], 'DisplayAs': 'DROPDOWN'|'RADIO', 'Automation': { 'Options': [ { 'RuleCategory': { 'Category': 'string', 'Condition': 'PRESENT'|'NOT_PRESENT', 'OptionRefId': 'string' } }, ], 'DefaultOptionRefId': 'string' } } }, 'Weight': 123.0 } }, ], 'ScoringStrategy': { 'Mode': 'QUESTION_ONLY'|'SECTION_ONLY', 'Status': 'ENABLED'|'DISABLED' } } }
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.
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.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
StringValue
,NumericValue
,NotApplicable
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
StringValue
,NumericValue
,NotApplicable
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
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.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
Section
,Question
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
Numeric
,SingleSelect
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Automation (dict) –
The automation properties of the numeric question.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
PropertyValue
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
PropertyValue (dict) –
The property value of the automation.
Label (string) –
The property label of the automation.
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.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
RuleCategory
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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 isNOT_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.
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.
Exceptions
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InternalServiceException