Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SearchQuickResponses

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

Request Syntax


POST /knowledgeBases/knowledgeBaseId/search/quickResponses?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "attributes": { 
      "string" : "string" 
   },
   "searchExpression": { 
      "filters": [ 
         { 
            "includeNoExistence": boolean,
            "name": "string",
            "operator": "string",
            "values": [ "string" ]
         }
      ],
      "orderOnField": { 
         "name": "string",
         "order": "string"
      },
      "queries": [ 
         { 
            "allowFuzziness": boolean,
            "name": "string",
            "operator": "string",
            "priority": "string",
            "values": [ "string" ]
         }
      ]
   }
}

URI Request Parameters

The request uses the following URI parameters.

knowledgeBaseId

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$

Required: Yes

maxResults

The maximum number of results to return per page.

Valid Range: Minimum value of 1. Maximum value of 100.

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.

Length Constraints: Minimum length of 1. Maximum length of 4096.

Request Body

The request accepts the following data in JSON format.

attributes

The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

Type: String to string map

Required: No

searchExpression

The search expression for querying the quick response.

Type: QuickResponseSearchExpression object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "results": [ 
      { 
         "attributesInterpolated": [ "string" ],
         "attributesNotInterpolated": [ "string" ],
         "channels": [ "string" ],
         "contents": { 
            "markdown": { ... },
            "plainText": { ... }
         },
         "contentType": "string",
         "createdTime": number,
         "description": "string",
         "groupingConfiguration": { 
            "criteria": "string",
            "values": [ "string" ]
         },
         "isActive": boolean,
         "knowledgeBaseArn": "string",
         "knowledgeBaseId": "string",
         "language": "string",
         "lastModifiedBy": "string",
         "lastModifiedTime": number,
         "name": "string",
         "quickResponseArn": "string",
         "quickResponseId": "string",
         "shortcutKey": "string",
         "status": "string",
         "tags": { 
            "string" : "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.

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

Length Constraints: Minimum length of 1. Maximum length of 4096.

results

The results of the quick response search.

Type: Array of QuickResponseSearchResultData objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

RequestTimeoutException

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

HTTP Status Code: 408

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ValidationException

The input fails to satisfy the constraints specified by a service.

HTTP Status Code: 400