GetMediaCommand

Suggest an Edit

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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QBusinessClient, GetMediaCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, GetMediaCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // GetMediaRequest
  applicationId: "STRING_VALUE", // required
  conversationId: "STRING_VALUE", // required
  messageId: "STRING_VALUE", // required
  mediaId: "STRING_VALUE", // required
};
const command = new GetMediaCommand(input);
const response = await client.send(command);
// { // GetMediaResponse
//   mediaBytes: new Uint8Array(),
//   mediaMimeType: "STRING_VALUE",
// };

GetMediaCommand Input

See GetMediaCommandInput for more details

Parameter
Type
Description
applicationId
Required
string | undefined

The identifier of the Amazon Q Business which contains the media object.

conversationId
Required
string | undefined

The identifier of the Amazon Q Business conversation.

mediaId
Required
string | undefined

The identifier of the media object. You can find this in the sourceAttributions returned by the Chat, ChatSync, and ListMessages API responses.

messageId
Required
string | undefined

The identifier of the Amazon Q Business message.

GetMediaCommand Output

See GetMediaCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
mediaBytes
Uint8Array | undefined

The base64-encoded bytes of the media object.

mediaMimeType
string | undefined

The MIME type of the media object (image/png).

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support  for help.

LicenseNotFoundException
client

You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

MediaTooLargeException
client

The requested media object is too large to be returned.

ResourceNotFoundException
client

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException
client

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

QBusinessServiceException
Base exception class for all service exceptions from QBusiness service.