medias

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

Overview

Name	medias
Type	Resource
Id	aws.qbusiness.medias

Fields

The following fields are returned by SELECT queries:

get_media

Name	Datatype	Description
media_bytes	string (byte)	The base64-encoded bytes of the media object.
media_mime_type	string	The MIME type of the media object (image/png).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_media	select	application_id, conversation_id, message_id, media_id, region		Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses. For more information, see Extracting semantic meaning from images and visuals.

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 which contains the media object.
conversation_id	string	The identifier of the Amazon Q Business conversation.
media_id	string	The identifier of the media object. You can find this in the sourceAttributions returned by the Chat, ChatSync, and ListMessages API responses.
message_id	string	The identifier of the Amazon Q Business message.
region	string	AWS region (default: us-east-1)

SELECT examples

get_media

Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses. For more information, see Extracting semantic meaning from images and visuals.

SELECT
media_bytes,
media_mime_type
FROM aws.qbusiness.medias
WHERE application_id = '{{ application_id }}' -- required
AND conversation_id = '{{ conversation_id }}' -- required
AND message_id = '{{ message_id }}' -- required
AND media_id = '{{ media_id }}' -- required
AND region = '{{ region }}' -- required
;