Skip to content

update_agent_runtime_endpoint

update_agent_runtime_endpoint(
    agent_runtime_id: AgentRuntimeId,
    endpoint_name: EndpointName,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    agent_runtime_version: Optional[AgentRuntimeVersion] = None,
    description: Optional[AgentEndpointDescription] = None,
    client_token: Optional[ClientToken] = None,
) -> UpdateAgentRuntimeEndpointResponse

Updates an existing Amazon Bedrock AgentCore Runtime endpoint.

Parameters:

  • agent_runtime_id (AgentRuntimeId) –

    The unique identifier of the AgentCore Runtime associated with the endpoint.

  • endpoint_name (EndpointName) –

    The name of the AgentCore Runtime endpoint to update.

  • agent_runtime_version (Optional[AgentRuntimeVersion], default: None ) –

    The updated version of the AgentCore Runtime for the endpoint.

  • description (Optional[AgentEndpointDescription], default: None ) –

    The updated description of the AgentCore Runtime endpoint.

  • client_token (Optional[ClientToken], default: None ) –

    A unique, case-sensitive identifier to ensure idempotency of the request.

Raises:

Source code in docs_src/capo_bedrock_agentcore_control/_services/bedrock_agent_core_control.py
def update_agent_runtime_endpoint(
    self,
    agent_runtime_id: "capo_bedrock_agentcore_control.types.agent_runtime_id.AgentRuntimeId",
    endpoint_name: "capo_bedrock_agentcore_control.types.endpoint_name.EndpointName",
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    agent_runtime_version: Optional[
        "capo_bedrock_agentcore_control.types.agent_runtime_version.AgentRuntimeVersion"
    ] = None,
    description: Optional[
        "capo_bedrock_agentcore_control.types.agent_endpoint_description.AgentEndpointDescription"
    ] = None,
    client_token: Optional[
        "capo_bedrock_agentcore_control.types.client_token.ClientToken"
    ] = None,
) -> "capo_bedrock_agentcore_control.types.update_agent_runtime_endpoint_response.UpdateAgentRuntimeEndpointResponse":
    """<p>Updates an existing Amazon Bedrock AgentCore Runtime endpoint.</p>

    Args:
        agent_runtime_id: <p>The unique identifier of the AgentCore Runtime associated with the endpoint.</p>
        endpoint_name: <p>The name of the AgentCore Runtime endpoint to update.</p>
        agent_runtime_version: <p>The updated version of the AgentCore Runtime for the endpoint.</p>
        description: <p>The updated description of the AgentCore Runtime endpoint.</p>
        client_token: <p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>

    Raises:
        capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
        capo_bedrock_agentcore_control.errors.conflict_exception.ConflictException: <p>This exception is thrown when there is a conflict performing an operation</p>
        capo_bedrock_agentcore_control.errors.internal_server_exception.InternalServerException: <p>This exception is thrown if there was an unexpected error during processing of request</p>
        capo_bedrock_agentcore_control.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource referenced by the operation does not exist</p>
        capo_bedrock_agentcore_control.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>This exception is thrown when a request is made beyond the service quota</p>
        capo_bedrock_agentcore_control.errors.throttling_exception.ThrottlingException: <p>This exception is thrown when the number of requests exceeds the limit</p>
        capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore_control.types.update_agent_runtime_endpoint_request.UpdateAgentRuntimeEndpointRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.update_agent_runtime_endpoint_response.UpdateAgentRuntimeEndpointResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.update_agent_runtime_endpoint

        output, http_response = (
            capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.update_agent_runtime_endpoint.update_agent_runtime_endpoint(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_bedrock_agentcore_control.types.update_agent_runtime_endpoint_request.UpdateAgentRuntimeEndpointRequest",
    ) -> dict[str, Any]:
        import capo_bedrock_agentcore_control.types.update_agent_runtime_endpoint_request

        return capo_bedrock_agentcore_control.types.update_agent_runtime_endpoint_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateAgentRuntimeEndpoint", redact_input=_redact_input),
    )
    input_: capo_bedrock_agentcore_control.types.update_agent_runtime_endpoint_request.UpdateAgentRuntimeEndpointRequest = {
        "agent_runtime_id": agent_runtime_id,
        "endpoint_name": endpoint_name,
    }
    if agent_runtime_version is not None:
        input_["agent_runtime_version"] = agent_runtime_version
    if description is not None:
        input_["description"] = description
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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