next_messages

Creates, updates, deletes, gets or lists a next_messages resource.

Overview

Name	next_messages
Type	Resource
Id	aws.qconnect.next_messages

Fields

The following fields are returned by SELECT queries:

get_next_message

Name	Datatype	Description
chunked_response_terminated	boolean	Indicates whether the chunked response has been terminated.
conversation_session_data	array	The conversation data stored on an Amazon Q in Connect Session.
conversation_state	object	The state of current conversation.
next_message_token	string	The token for the next message.
request_message_id	string	The identifier of the submitted message. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
response	object	The message response to the requested message.
type_	string	The type of message response. (TEXT, TOOL_USE_RESULT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_next_message	select	assistant_id, session_id, nextMessageToken, region		Retrieves next message on an Amazon Q in Connect session.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
assistant_id	string	The identifier of the Amazon Q in Connect assistant.
nextMessageToken	string	The token for the next message. Use the value returned in the SendMessage or previous response in the next request to retrieve the next message.
region	string	AWS region (default: us-east-1)
session_id	string	The identifier of the Amazon Q in Connect session.

SELECT examples

get_next_message

Retrieves next message on an Amazon Q in Connect session.

SELECT
chunked_response_terminated,
conversation_session_data,
conversation_state,
next_message_token,
request_message_id,
response,
type_
FROM aws.qconnect.next_messages
WHERE assistant_id = '{{ assistant_id }}' -- required
AND session_id = '{{ session_id }}' -- required
AND nextMessageToken = '{{ nextMessageToken }}' -- required
AND region = '{{ region }}' -- required
;