conversations

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

Overview

Name	conversations
Type	Resource
Id	aws.qbusiness.conversations

Fields

The following fields are returned by SELECT queries:

list_conversations

Name	Datatype	Description
conversation_id	string	The identifier of the Amazon Q Business conversation. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
start_time	string (date-time)	The start time of the conversation.
title_	string	The title of the conversation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_conversations	select	application_id, region	userId, nextToken, maxResults	Lists one or more Amazon Q Business conversations.
put_feedback	replace	application_id, conversation_id, message_id, region	userId	Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
delete_conversation	delete	conversation_id, application_id, region	userId	Deletes an Amazon Q Business web experience conversation.

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
application_id	string	The identifier of the Amazon Q Business application associated with the conversation.
conversation_id	string	The identifier of the Amazon Q Business web experience conversation being deleted.
message_id	string	The identifier of the chat message that the feedback was given for.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of Amazon Q Business conversations to return.
nextToken	string	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.
userId	string	The identifier of the user who is deleting the conversation.

SELECT examples

list_conversations

Lists one or more Amazon Q Business conversations.

SELECT
conversation_id,
start_time,
title_
FROM aws.qbusiness.conversations
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
AND userId = '{{ userId }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

REPLACE examples

put_feedback

Enables your end user to provide feedback on their Amazon Q Business generated chat responses.

REPLACE aws.qbusiness.conversations
SET 
messageCopiedAt = '{{ messageCopiedAt }}',
messageUsefulness = '{{ messageUsefulness }}'
WHERE 
application_id = '{{ application_id }}' --required
AND conversation_id = '{{ conversation_id }}' --required
AND message_id = '{{ message_id }}' --required
AND region = '{{ region }}' --required
AND userId = '{{ userId}}';

DELETE examples

delete_conversation

Deletes an Amazon Q Business web experience conversation.

DELETE FROM aws.qbusiness.conversations
WHERE conversation_id = '{{ conversation_id }}' --required
AND application_id = '{{ application_id }}' --required
AND region = '{{ region }}' --required
AND userId = '{{ userId }}'
;