contact_evaluations

Creates, updates, deletes, gets or lists a contact_evaluations resource.

Overview

Name	contact_evaluations
Type	Resource
Id	aws.connect.contact_evaluations

Fields

The following fields are returned by SELECT queries:

describe_contact_evaluation

Name	Datatype	Description
evaluation	object	Information about the evaluation form completed for a specific contact.
evaluation_form	object	Information about the evaluation form.

list_contact_evaluations

Name	Datatype	Description
acknowledgement	object	Information related to evaluation acknowledgement.
auto_evaluation_enabled	boolean	Whether automated evaluation is enabled.
auto_evaluation_status	string	The status of the contact auto evaluation. (IN_PROGRESS, FAILED, SUCCEEDED)
calibration_session_id	string	The calibration session ID that this evaluation belongs to.
contact_participant	object	Information about a contact participant in the evaluation.
created_time	string (date-time)	The timestamp for when the evaluation was created.
evaluation_arn	string	The Amazon Resource Name (ARN) for the contact evaluation resource.
evaluation_form_id	string	The unique identifier for the evaluation form.
evaluation_form_title	string	A title of the evaluation form.
evaluation_id	string	A unique identifier for the contact evaluation.
evaluation_type	string	Type of the evaluation. (STANDARD, CALIBRATION)
evaluator_arn	string	The Amazon Resource Name (ARN) of the user who last updated the evaluation.
last_modified_time	string (date-time)	The timestamp for when the evaluation was last updated.
score	object	The overall score of the contact evaluation.
status	string	The status of the contact evaluation. (DRAFT, SUBMITTED, REVIEW_REQUESTED, UNDER_REVIEW)

search_contact_evaluations

Name	Datatype	Description
approximate_total_count	integer (int64)	The total number of contact evaluations that matched your search query.
evaluation_search_summary_list	array	Contains information about contact evaluations.
next_token	string	If there are additional results, this is the token for the next set of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_contact_evaluation	select	instance_id, evaluation_id, region		Describes a contact evaluation in the specified Connect Customer instance.
list_contact_evaluations	select	instance_id, contactId, region	nextToken	Lists contact evaluations in the specified Connect Customer instance.
search_contact_evaluations	select	region		Searches contact evaluations in an Connect Customer instance, with optional filtering. Use cases Following are common uses cases for this API: Find contact evaluations by using specific search criteria. Find contact evaluations that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds. Endpoints: See Connect Customer endpoints and quotas.
update_contact_evaluation	update	instance_id, evaluation_id, region		Updates details about a contact evaluation in the specified Connect Customer 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.
delete_contact_evaluation	delete	instance_id, evaluation_id, region		Deletes a contact evaluation in the specified Connect Customer instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
contactId	string	The identifier of the contact in this instance of Connect Customer.
evaluation_id	string	A unique identifier for the contact evaluation.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)
nextToken	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. This is not expected to be set because the value returned in the previous response is always null.

SELECT examples

describe_contact_evaluation

Describes a contact evaluation in the specified Connect Customer instance.

SELECT
evaluation,
evaluation_form
FROM aws.connect.contact_evaluations
WHERE instance_id = '{{ instance_id }}' -- required
AND evaluation_id = '{{ evaluation_id }}' -- required
AND region = '{{ region }}' -- required
;

list_contact_evaluations

Lists contact evaluations in the specified Connect Customer instance.

SELECT
acknowledgement,
auto_evaluation_enabled,
auto_evaluation_status,
calibration_session_id,
contact_participant,
created_time,
evaluation_arn,
evaluation_form_id,
evaluation_form_title,
evaluation_id,
evaluation_type,
evaluator_arn,
last_modified_time,
score,
status
FROM aws.connect.contact_evaluations
WHERE instance_id = '{{ instance_id }}' -- required
AND contactId = '{{ contactId }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
;

search_contact_evaluations

Searches contact evaluations in an Connect Customer instance, with optional filtering. Use cases Following are common uses cases for this API: Find contact evaluations by using specific search criteria. Find contact evaluations that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds. Endpoints: See Connect Customer endpoints and quotas.

SELECT
approximate_total_count,
evaluation_search_summary_list,
next_token
FROM aws.connect.contact_evaluations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_contact_evaluation

Updates details about a contact evaluation in the specified Connect Customer 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.

UPDATE aws.connect.contact_evaluations
SET 
Answers = '{{ Answers }}',
Notes = '{{ Notes }}',
UpdatedBy = '{{ UpdatedBy }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND evaluation_id = '{{ evaluation_id }}' --required
AND region = '{{ region }}' --required
RETURNING
evaluation_arn,
evaluation_id;

DELETE examples

delete_contact_evaluation

Deletes a contact evaluation in the specified Connect Customer instance.

DELETE FROM aws.connect.contact_evaluations
WHERE instance_id = '{{ instance_id }}' --required
AND evaluation_id = '{{ evaluation_id }}' --required
AND region = '{{ region }}' --required
;