Use DeleteAgent
with an AWS SDK or CLI
The following code examples show how to use DeleteAgent
.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in
context in the following code example:
- JavaScript
-
- SDK for JavaScript (v3)
-
Delete an agent.
import { fileURLToPath } from "url";
import { checkForPlaceholders } from "../lib/utils.js";
import {
BedrockAgentClient,
DeleteAgentCommand,
} from "@aws-sdk/client-bedrock-agent";
/**
* Deletes an Amazon Bedrock Agent.
*
* @param {string} agentId - The unique identifier of the agent to delete.
* @param {string} [region='us-east-1'] - The AWS region in use.
* @returns {Promise<import("@aws-sdk/client-bedrock-agent").DeleteAgentCommandOutput>} An object containing the agent id, the status, and some additional metadata.
*/
export const deleteAgent = (agentId, region = "us-east-1") => {
const client = new BedrockAgentClient({ region });
const command = new DeleteAgentCommand({ agentId });
return client.send(command);
};
// Invoke main function if this file was run directly.
if (process.argv[1] === fileURLToPath(import.meta.url)) {
// Replace the placeholders for agentId with an existing agent's id.
// Ensure to remove the brackets (`[]`) before adding your data.
// The agentId must be an alphanumeric string with exactly 10 characters.
const agentId = "[ABC123DE45]";
// Check for unresolved placeholders in agentId.
checkForPlaceholders([agentId]);
console.log(`Deleting agent with ID ${agentId}...`);
const response = await deleteAgent(agentId);
console.log(response);
}
- Python
-
- SDK for Python (Boto3)
-
Delete an agent.
def delete_agent(self, agent_id):
"""
Deletes an Amazon Bedrock agent.
:param agent_id: The unique identifier of the agent to delete.
:return: The response from Amazon Bedrock Agents if successful, otherwise raises an exception.
"""
try:
response = self.client.delete_agent(
agentId=agent_id, skipResourceInUseCheck=False
)
except ClientError as e:
logger.error(f"Couldn't delete agent. {e}")
raise
else:
return response
For a complete list of AWS SDK developer guides and code examples, see
Using Amazon Bedrock with an AWS SDK.
This topic also includes information about getting started and details about previous SDK versions.