prepare_agent ¶

prepare_agent(
    agent_id: Id, *, config_overrides: Optional[BedrockAgentClientConfig] = None
) -> PrepareAgentResponse

Creates a DRAFT version of the agent that can be used for internal testing.

Parameters:

agent_id (Id) –

The unique identifier of the agent for which to create a DRAFT version.

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.
ServiceQuotaExceededException –

The number of requests exceeds the service quota. Resubmit your request later.
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/bedrock_agent.py

def prepare_agent(
    self,
    agent_id: "capo_bedrock_agent.types.id.Id",
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
) -> "capo_bedrock_agent.types.prepare_agent_response.PrepareAgentResponse":
    """<p>Creates a <code>DRAFT</code> version of the agent that can be used for internal testing.</p>

    Args:
        agent_id: <p>The unique identifier of the agent for which to create a <code>DRAFT</code> version.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The number of requests exceeds the service quota. Resubmit your request later.</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.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agent.types.prepare_agent_request.PrepareAgentRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent.types.prepare_agent_response.PrepareAgentResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.prepare_agent

        output, http_response = (
            capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.prepare_agent.prepare_agent(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PrepareAgent")
    )
    input_: capo_bedrock_agent.types.prepare_agent_request.PrepareAgentRequest = {
        "agent_id": agent_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output