Skip to content

get_agent

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

Gets information about an agent.

Parameters:

  • agent_id (Id) –

    The unique identifier of the agent.

Raises:

Source code in docs_src/capo_bedrock_agent/_services/bedrock_agent.py
def get_agent(
    self,
    agent_id: "capo_bedrock_agent.types.id.Id",
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
) -> "capo_bedrock_agent.types.get_agent_response.GetAgentResponse":
    """<p>Gets information about an agent.</p>

    Args:
        agent_id: <p>The unique identifier of the agent.</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.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.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agent.types.get_agent_request.GetAgentRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent.types.get_agent_response.GetAgentResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.get_agent

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

    def _redact_output(
        output: "capo_bedrock_agent.types.get_agent_response.GetAgentResponse",
    ) -> dict[str, Any]:
        import capo_bedrock_agent.types.get_agent_response

        return capo_bedrock_agent.types.get_agent_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAgent", redact_output=_redact_output)
    )
    input_: capo_bedrock_agent.types.get_agent_request.GetAgentRequest = {
        "agent_id": agent_id
    }

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