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

SearchMessageTemplates

Searches for Amazon Q in Connect message templates in the specified knowledge base.

Request Syntax


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

{
   "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. 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}){0,2}$

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 2048.

Request Body

The request accepts the following data in JSON format.

searchExpression

The search expression for querying the message template.

Type: MessageTemplateSearchExpression object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "results": [ 
      { 
         "channelSubtype": "string",
         "createdTime": "string",
         "description": "string",
         "groupingConfiguration": { 
            "criteria": "string",
            "values": [ "string" ]
         },
         "isActive": boolean,
         "knowledgeBaseArn": "string",
         "knowledgeBaseId": "string",
         "language": "string",
         "lastModifiedBy": "string",
         "lastModifiedTime": "string",
         "messageTemplateArn": "string",
         "messageTemplateId": "string",
         "name": "string",
         "tags": { 
            "string" : "string" 
         },
         "versionNumber": number
      }
   ]
}

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

If there are additional results, this is the token for the next set of results.

Type: String

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

results

The results of the message template search.

Type: Array of MessageTemplateSearchResultData 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

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 400

ValidationException

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

HTTP Status Code: 400