AgentsforBedrock / Client / delete_agent

delete_agent#

AgentsforBedrock.Client.delete_agent(**kwargs)#

Deletes an agent.

See also: AWS API Documentation

Request Syntax

response = client.delete_agent(
    agentId='string',
    skipResourceInUseCheck=True|False
)
Parameters:

  • agentId (string) –

    [REQUIRED]

    The unique identifier of the agent to delete.

  • skipResourceInUseCheck (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'agentId': 'string',
    'agentStatus': 'CREATING'|'PREPARING'|'PREPARED'|'NOT_PREPARED'|'DELETING'|'FAILED'|'VERSIONING'|'UPDATING'
}

Response Structure

  • (dict) –

    • agentId (string) –

      The unique identifier of the agent that was deleted.

    • agentStatus (string) –

      The status of the agent.

Exceptions

  • AgentsforBedrock.Client.exceptions.ThrottlingException

  • AgentsforBedrock.Client.exceptions.AccessDeniedException

  • AgentsforBedrock.Client.exceptions.ValidationException

  • AgentsforBedrock.Client.exceptions.InternalServerException

  • AgentsforBedrock.Client.exceptions.ResourceNotFoundException

  • AgentsforBedrock.Client.exceptions.ConflictException