Bedrock Agent  >  Operations  >  delete_agent

delete_agent

Operation

delete_agent async

delete_agent(input: DeleteAgentInput, plugins: list[Plugin] | None = None) -> DeleteAgentOutput

Deletes an agent.

Parameters:

Name	Type	Description	Default
input	DeleteAgentInput	An instance of DeleteAgentInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
DeleteAgentOutput	An instance of DeleteAgentOutput.

Input

DeleteAgentInput dataclass

Dataclass for DeleteAgentInput structure.

Attributes

agent_id class-attribute instance-attribute

agent_id: str | None = None

The unique identifier of the agent to delete.

skip_resource_in_use_check class-attribute instance-attribute

skip_resource_in_use_check: bool = False

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

Output

DeleteAgentOutput dataclass

Dataclass for DeleteAgentOutput structure.

Attributes

agent_id instance-attribute

agent_id: str

The unique identifier of the agent that was deleted.

agent_status instance-attribute

agent_status: AgentStatus

The status of the agent.