delete_agent `async` ¶

delete_agent(
    agent_id: Id,
    *,
    config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
    skip_resource_in_use_check: Optional[bool] = None,
) -> DeleteAgentResponse

Deletes an agent.

Parameters:

agent_id (Id) –

The unique identifier of the agent to delete.
skip_resource_in_use_check (Optional[bool], default: None ) –

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.

Raises:

AccessDeniedException –

The request is denied because of missing access permissions.
ConflictException –

There was a conflict performing an operation.
InternalServerException –

An internal server error occurred. Retry your request.
ResourceNotFoundException –

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ThrottlingException –

The number of requests exceeds the limit. Resubmit your request later.
ValidationException –

Input validation failed. Check your request parameters and retry the request.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_bedrock_agent/_services/async_bedrock_agent.py

async def delete_agent(
    self,
    agent_id: "capo_bedrock_agent.types.id.Id",
    *,
    config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
    skip_resource_in_use_check: Optional[bool] = None,
) -> "capo_bedrock_agent.types.delete_agent_response.DeleteAgentResponse":
    """<p>Deletes an agent.</p>

    Args:
        agent_id: <p>The unique identifier of the agent to delete.</p>
        skip_resource_in_use_check: <p>By default, this value is <code>false</code> and deletion is stopped if the resource is in use. If you set it to <code>true</code>, the resource will be deleted even if the resource is in use.</p>

    Raises:
        capo_bedrock_agent.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
        capo_bedrock_agent.errors.conflict_exception.ConflictException: <p>There was a conflict performing an operation.</p>
        capo_bedrock_agent.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
        capo_bedrock_agent.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock_agent.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bedrock_agent.types.delete_agent_request.DeleteAgentRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agent.types.delete_agent_response.DeleteAgentResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.delete_agent

        (
            output,
            http_response,
        ) = await capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.delete_agent.async_delete_agent(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteAgent")
    )
    input_: capo_bedrock_agent.types.delete_agent_request.DeleteAgentRequest = {
        "agent_id": agent_id
    }
    if skip_resource_in_use_check is not None:
        input_["skip_resource_in_use_check"] = skip_resource_in_use_check

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_agent async ¶

delete_agent `async` ¶