AgentsforBedrock / Client / delete_agent

delete_agent#

AgentsforBedrock.Client.delete_agent(**kwargs)#

Deletes an Agent for existing Amazon Bedrock Agent

See also: AWS API Documentation

Request Syntax

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

  • agentId (string) –

    [REQUIRED]

    Id generated at the server side when an Agent is created

  • skipResourceInUseCheck (boolean) – Skips checking if resource is in use when set to true. Defaults to false

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    Delete Agent Response

    • agentId (string) –

      Identifier for a resource.

    • agentStatus (string) –

      Schema Type for Action APIs.

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