SearchEvaluationForms
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.
Request Syntax
POST /search-evaluation-forms HTTP/1.1
Content-type: application/json
{
"InstanceId": "string",
"MaxResults": number,
"NextToken": "string",
"SearchCriteria": {
"AndConditions": [
"EvaluationFormSearchCriteria"
],
"BooleanCondition": {
"ComparisonType": "string",
"FieldName": "string"
},
"DateTimeCondition": {
"ComparisonType": "string",
"FieldName": "string",
"MaxValue": "string",
"MinValue": "string"
},
"NumberCondition": {
"ComparisonType": "string",
"FieldName": "string",
"MaxValue": number,
"MinValue": number
},
"OrConditions": [
"EvaluationFormSearchCriteria"
],
"StringCondition": {
"ComparisonType": "string",
"FieldName": "string",
"Value": "string"
}
},
"SearchFilter": {
"AttributeFilter": {
"AndCondition": {
"TagConditions": [
{
"TagKey": "string",
"TagValue": "string"
}
]
},
"OrConditions": [
{
"TagConditions": [
{
"TagKey": "string",
"TagValue": "string"
}
]
}
],
"TagCondition": {
"TagKey": "string",
"TagValue": "string"
}
}
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- MaxResults
-
The maximum number of results to return per page.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
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.
Type: String
Required: No
- SearchCriteria
-
The search criteria to be used to return evaluation forms.
Type: EvaluationFormSearchCriteria object
Required: No
- SearchFilter
-
Filters to be applied to search results.
Type: EvaluationFormSearchFilter object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ApproximateTotalCount": number,
"EvaluationFormSearchSummaryList": [
{
"ActiveVersion": number,
"AutoEvaluationEnabled": boolean,
"CreatedBy": "string",
"CreatedTime": number,
"Description": "string",
"EvaluationFormArn": "string",
"EvaluationFormId": "string",
"LastActivatedBy": "string",
"LastActivatedTime": number,
"LastModifiedBy": "string",
"LastModifiedTime": number,
"LatestVersion": number,
"Status": "string",
"Tags": {
"string" : "string"
},
"Title": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ApproximateTotalCount
-
The total number of evaluation forms that matched your search query.
Type: Long
- EvaluationFormSearchSummaryList
-
Information about the returned evaluation forms.
Type: Array of EvaluationFormSearchSummary objects
- NextToken
-
If there are additional results, this is the token for the next set of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
- Message
-
The message.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
- Message
-
The message about the parameters.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
- Message
-
The message about the request.
- Reason
-
Reason why the request was invalid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
- Message
-
The message about the resource.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
Examples
Example request to retrieve all evaluation forms in an instance
This example illustrates one usage of SearchEvaluationForms.
{ "InstanceId": "12345678-1234-5678-aabb-123456abcdef" }
Example request to retrieve an evaluation form with a specific ID in an instance
This example illustrates one usage of SearchEvaluationForms.
{ "InstanceId": "12345678-1234-5678-aabb-123456abcdef", "SearchCriteria": { "StringCondition": { "ComparisonType": "EXACT", "FieldName": "EvaluationFormId", "Value": "87654321-4321-8765-bbaa-abcdef123456" } } }
Example request to retrieve evaluation forms by using multiple search criteria in an instance
This example illustrates one usage of SearchEvaluationForms.
{ "InstanceId": "12345678-1234-5678-aabb-123456abcdef", "SearchCriteria": { "OrConditions": [ { "AndConditions": [ { "DateTimeCondition": { "ComparisonType": "GREATER_THAN", "FieldName": "LastModifiedTime", "MinValue": "2020-01-01T00:00:00Z" } }, { "NumberCondition": { "ComparisonType": "EQUAL", "FieldName": "LatestVersion", "MinValue": 1 } }, { "BooleanCondition": { "ComparisonType": "IS_FALSE", "FieldName": "AutoEvaluationEnabled" } } ] } ] } }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
