2023/04/25 - Amazon Connect Service - 14 new api methods
Changes Amazon Connect, Contact Lens Evaluation API release including ability to manage forms and to submit contact evaluations.
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'
}
}
)
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: StringValue, NumericValue, NotApplicable.
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
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.
Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
See also: AWS API Documentation
Request Syntax
client.deactivate_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]
The unique identifier for the evaluation form.
integer
[REQUIRED]
A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.
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) --
The version of the deactivated evaluation form resource.
Lists evaluation forms in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_evaluation_forms(
InstanceId='string',
MaxResults=123,
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.
integer
The maximum number of results to return per page.
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
{
'EvaluationFormSummaryList': [
{
'EvaluationFormId': 'string',
'EvaluationFormArn': 'string',
'Title': '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
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EvaluationFormSummaryList (list) --
Provides details about a list of evaluation forms belonging to an instance.
(dict) --
Summary information about an 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 unique title 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.
LastActivatedTime (datetime) --
The timestamp for when the evaluation form was last activated.
LastActivatedBy (string) --
The Amazon Resource Name (ARN) of the user who last activated the evaluation form.
LatestVersion (integer) --
The version number of the latest evaluation form version.
ActiveVersion (integer) --
The version of the active evaluation form version.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Deletes a contact evaluation in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.delete_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.
None
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.
Warning
This is not expected to be set because the value returned in the previous response is always null.
dict
Response Syntax
{
'EvaluationSummaryList': [
{
'EvaluationId': 'string',
'EvaluationArn': 'string',
'EvaluationFormTitle': 'string',
'EvaluationFormId': 'string',
'Status': 'DRAFT'|'SUBMITTED',
'EvaluatorArn': 'string',
'Score': {
'Percentage': 123.0,
'NotApplicable': True|False,
'AutomaticFail': True|False
},
'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 unique title of the evaluation form.
EvaluationFormId (string) --
The unique identifier for the evaluation form.
Status (string) --
The status of the contact 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.
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.
Warning
This is always returned as null in the response.
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
},
],
'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'
},
'CreatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedBy': 'string',
'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 unique 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.
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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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 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 tha
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.
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.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(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'
}
}
)
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: StringValue, NumericValue, NotApplicable.
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
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.
Lists versions of an evaluation form in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_evaluation_form_versions(
InstanceId='string',
EvaluationFormId='string',
MaxResults=123,
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 unique identifier for the evaluation form.
integer
The maximum number of results to return per page.
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
{
'EvaluationFormVersionSummaryList': [
{
'EvaluationFormArn': 'string',
'EvaluationFormId': 'string',
'EvaluationFormVersion': 123,
'Locked': True|False,
'Status': 'DRAFT'|'ACTIVE',
'CreatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedBy': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EvaluationFormVersionSummaryList (list) --
Provides details about a list of evaluation forms belonging to an instance.
(dict) --
Summary information about an evaluation form.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the evaluation form resource.
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.
Status (string) --
The 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.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
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.
Note
Evaluations created through the public API do not contain answer values suggested from automation.
See also: AWS API Documentation
Request Syntax
client.start_contact_evaluation(
InstanceId='string',
ContactId='string',
EvaluationFormId='string',
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 identifier of the contact in this instance of Amazon Connect.
string
[REQUIRED]
The unique identifier for the evaluation form.
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
{
'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.
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',
'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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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 unique 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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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 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 tha
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.
Updates details about a specific evaluation form version in the specified Amazon Connect instance. An evaluation form must have a unique title within an 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
},
],
'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'
},
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 unique 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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Section, 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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Numeric, SingleSelect.
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.
Automation (dict) --
The automation properties of the numeric question.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: PropertyValue.
PropertyValue (dict) --
The property value of the automation.
Label (string) -- [REQUIRED]
The property label of the automation.
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.
DisplayAs (string) --
The display mode of the single select question.
Automation (dict) --
The display mode of the single select question.
Options (list) -- [REQUIRED]
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 can be set: RuleCategory.
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 tha
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.
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.
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.
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. An evaluation form must have a unique title within an instance. 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
},
],
'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'
},
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]
A unique 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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Section, 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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Numeric, SingleSelect.
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.
Automation (dict) --
The automation properties of the numeric question.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: PropertyValue.
PropertyValue (dict) --
The property value of the automation.
Label (string) -- [REQUIRED]
The property label of the automation.
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.
DisplayAs (string) --
The display mode of the single select question.
Automation (dict) --
The display mode of the single select question.
Options (list) -- [REQUIRED]
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 can be set: RuleCategory.
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 tha
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.
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.
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'
}
Response Structure
(dict) --
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the evaluation form resource.
Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
See also: AWS API Documentation
Request Syntax
client.activate_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]
The unique identifier for the evaluation form.
integer
[REQUIRED]
The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.
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.
Deletes an evaluation form in the specified Amazon Connect instance.
If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.
See also: AWS API Documentation
Request Syntax
client.delete_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]
The unique identifier for the evaluation form.
integer
The unique identifier for the evaluation form.
None