listMessages method

Future<ListMessagesResponse> listMessages({
  1. required String applicationId,
  2. required String conversationId,
  3. int? maxResults,
  4. String? nextToken,
  5. String? userId,
})

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

May throw AccessDeniedException. May throw InternalServerException. May throw LicenseNotFoundException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter applicationId : The identifier for the Amazon Q Business application.

Parameter conversationId : The identifier of the Amazon Q Business web experience conversation.

Parameter maxResults : The maximum number of messages to return.

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

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

Implementation

Future<ListMessagesResponse> listMessages({
  required String applicationId,
  required String conversationId,
  int? maxResults,
  String? nextToken,
  String? userId,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
    if (userId != null) 'userId': [userId],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/applications/${Uri.encodeComponent(applicationId)}/conversations/${Uri.encodeComponent(conversationId)}',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListMessagesResponse.fromJson(response);
}