DeleteConversationCommand

Suggest an Edit

Deletes an Amazon Q Business web experience conversation.

Example Syntax

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

import { QBusinessClient, DeleteConversationCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, DeleteConversationCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // DeleteConversationRequest
  conversationId: "STRING_VALUE", // required
  applicationId: "STRING_VALUE", // required
  userId: "STRING_VALUE",
};
const command = new DeleteConversationCommand(input);
const response = await client.send(command);
// {};

DeleteConversationCommand Input

See DeleteConversationCommandInput for more details

Parameter
Type
Description
applicationId
Required
string | undefined

The identifier of the Amazon Q Business application associated with the conversation.

conversationId
Required
string | undefined

The identifier of the Amazon Q Business web experience conversation being deleted.

userId
string | undefined

The identifier of the user who is deleting the conversation.

DeleteConversationCommand Output

See DeleteConversationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

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.

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.