Skip to content

QBusiness  >  Operations  >  list_messages

list_messages

Operation

list_messages async 

list_messages(input: ListMessagesInput, plugins: list[Plugin] | None = None) -> ListMessagesOutput

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

Parameters:

Name Type Description Default
input ListMessagesInput

An instance of ListMessagesInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ListMessagesOutput

An instance of ListMessagesOutput.

Input

ListMessagesInput dataclass

Dataclass for ListMessagesInput structure.

Attributes

application_id class-attribute instance-attribute 
application_id: str | None = None

The identifier for the Amazon Q Business application.

conversation_id class-attribute instance-attribute 
conversation_id: str | None = None

The identifier of the Amazon Q Business web experience conversation.

max_results class-attribute instance-attribute 
max_results: int | None = None

The maximum number of messages to return.

next_token class-attribute instance-attribute 
next_token: str | None = None

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.

user_id class-attribute instance-attribute 
user_id: str | None = None

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

Output

ListMessagesOutput dataclass

Dataclass for ListMessagesOutput structure.

Attributes

messages class-attribute instance-attribute 
messages: list[Message] | None = None

An array of information on one or more messages.

next_token class-attribute instance-attribute 
next_token: str | None = None

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.