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

ListMessages

Gets a list of messages associated with an Amazon Q Business web experience.

Request Syntax


GET /applications/applicationId/conversations/conversationId?maxResults=maxResults&nextToken=nextToken&userId=userId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

The identifier for the Amazon Q Business application.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

conversationId

The identifier of the Amazon Q Business web experience conversation.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

maxResults

The maximum number of messages to return.

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

nextToken

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.

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

userId

The identifier of the user involved in the Amazon Q Business web experience conversation.

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

Pattern: \P{C}*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "messages": [ 
      { 
         "actionExecution": { 
            "payload": { 
               "string" : { 
                  "value": JSON value
               }
            },
            "payloadFieldNameSeparator": "string",
            "pluginId": "string"
         },
         "actionReview": { 
            "payload": { 
               "string" : { 
                  "allowedFormat": "string",
                  "allowedValues": [ 
                     { 
                        "displayValue": JSON value,
                        "value": JSON value
                     }
                  ],
                  "arrayItemJsonSchema": JSON value,
                  "displayDescription": "string",
                  "displayName": "string",
                  "displayOrder": number,
                  "required": boolean,
                  "type": "string",
                  "value": JSON value
               }
            },
            "payloadFieldNameSeparator": "string",
            "pluginId": "string",
            "pluginType": "string"
         },
         "attachments": [ 
            { 
               "error": { 
                  "errorCode": "string",
                  "errorMessage": "string"
               },
               "name": "string",
               "status": "string"
            }
         ],
         "body": "string",
         "messageId": "string",
         "sourceAttribution": [ 
            { 
               "citationNumber": number,
               "snippet": "string",
               "textMessageSegments": [ 
                  { 
                     "beginOffset": number,
                     "endOffset": number,
                     "snippetExcerpt": { 
                        "text": "string"
                     }
                  }
               ],
               "title": "string",
               "updatedAt": number,
               "url": "string"
            }
         ],
         "time": number,
         "type": "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.

messages

An array of information on one or more messages.

Type: Array of Message objects

nextToken

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

Type: String

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

Errors

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

AccessDeniedException

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

HTTP Status Code: 403

InternalServerException

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

HTTP Status Code: 500

LicenseNotFoundException

You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

HTTP Status Code: 400

ResourceNotFoundException

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

HTTP Status Code: 404

ThrottlingException

The request was denied due to throttling. Reduce the number of requests and try again.

HTTP Status Code: 429

ValidationException

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

HTTP Status Code: 400