GetQuickResponse
Retrieves the quick response.
Request Syntax
GET /knowledgeBases/knowledgeBaseId/quickResponses/quickResponseId HTTP/1.1
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.
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
- quickResponseId
-
The identifier of the quick response.
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
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"quickResponse": {
"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.
- quickResponse
-
The quick response.
Type: QuickResponseData object
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
- ValidationException
-
The input fails to satisfy the constraints specified by a service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
