BedrockAgentCoreControl / Client / delete_agent_runtime

delete_agent_runtime

BedrockAgentCoreControl.Client.delete_agent_runtime(**kwargs)

Deletes an Amazon Bedrock AgentCore Runtime, or a single version of an AgentCore Runtime when you provide the version qualifier.

See also: AWS API Documentation

Request Syntax

response = client.delete_agent_runtime(
    agentRuntimeId='string',
    agentRuntimeVersion='string',
    clientToken='string'
)

Parameters:

• agentRuntimeId (string) –

  [REQUIRED]

  The unique identifier of the AgentCore Runtime to delete.

• agentRuntimeVersion (string) – The version of the AgentCore Runtime to delete. When you provide this value, only that version is deleted. When you omit it, the entire AgentCore Runtime and all of its versions are deleted.

• clientToken (string) –

  A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING',
    'agentRuntimeId': 'string',
    'agentRuntimeVersion': 'string'
}

Response Structure

• (dict) –

  • status (string) –

    The current status of the AgentCore Runtime deletion.

  • agentRuntimeId (string) –

    The unique identifier of the AgentCore Runtime.

  • agentRuntimeVersion (string) –

    The version of the AgentCore Runtime that was deleted. This value is present only when you delete a single version.

Exceptions

• BedrockAgentCoreControl.Client.exceptions.AccessDeniedException

• BedrockAgentCoreControl.Client.exceptions.ConflictException

• BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException

• BedrockAgentCoreControl.Client.exceptions.ThrottlingException

• BedrockAgentCoreControl.Client.exceptions.InternalServerException