Skip to content

list_conversations

Operation

list_conversations

list_conversations(request: ListConversationsInput | ListConversationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListConversationsInputDict]) -> ListConversationsOutput

Lists one or more Amazon Q Business conversations.

Parameters:

Name Type Description Default
request ListConversationsInput | ListConversationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListConversationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListConversationsOutput

An instance of ListConversationsOutput.

list_conversations async

list_conversations(request: ListConversationsInput | ListConversationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListConversationsInputDict]) -> ListConversationsOutput

Lists one or more Amazon Q Business conversations.

Parameters:

Name Type Description Default
request ListConversationsInput | ListConversationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListConversationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListConversationsOutput

An instance of ListConversationsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListConversationsInputDict

Bases: TypedDict

Dictionary form of ListConversationsInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the Amazon Q Business application.

max_results instance-attribute
max_results: int | None

The maximum number of Amazon Q Business conversations to return.

next_token instance-attribute
next_token: str | None

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.

user_id instance-attribute
user_id: str | None

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

ListConversationsInput dataclass

Bases: _SerdeShape

Dataclass for ListConversationsInput structure.

Attributes

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

The identifier of the Amazon Q Business application.

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

The maximum number of Amazon Q Business conversations to return.

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

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.

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

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

Output

ListConversationsOutput dataclass

Bases: _SerdeShape

Dataclass for ListConversationsOutput structure.

Attributes

conversations class-attribute instance-attribute
conversations: list[Conversation] | None = ...

An array of summary information on the configuration of one or more Amazon Q Business web experiences.

next_token class-attribute instance-attribute
next_token: str | 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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.