Skip to content

update_online_evaluation_config async

update_online_evaluation_config(
    online_evaluation_config_id: OnlineEvaluationConfigId,
    *,
    config_overrides: Optional[AsyncBedrockAgentCoreControlClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    description: Optional[EvaluationConfigDescription] = None,
    rule: Optional[Rule] = None,
    data_source_config: Optional[DataSourceConfig] = None,
    evaluators: Optional[EvaluatorList] = None,
    insights: Optional[InsightList] = None,
    clustering_config: Optional[ClusteringConfig] = None,
    output_config: Optional[OutputConfig] = None,
    evaluation_execution_role_arn: Optional[RoleArn] = None,
    execution_status: Optional[OnlineEvaluationExecutionStatus] = None,
) -> UpdateOnlineEvaluationConfigResponse

Updates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status. Changes take effect immediately for ongoing evaluations.

Parameters:

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

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

  • online_evaluation_config_id (OnlineEvaluationConfigId) –

    The unique identifier of the online evaluation configuration to update.

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

    The updated description of the online evaluation configuration.

  • rule (Optional[Rule], default: None ) –

    The updated evaluation rule containing sampling configuration, filters, and session settings.

  • data_source_config (Optional[DataSourceConfig], default: None ) –

    The updated data source configuration specifying CloudWatch log groups and service names to monitor.

  • evaluators (Optional[EvaluatorList], default: None ) –

    The updated list of evaluators to apply during online evaluation.

  • insights (Optional[InsightList], default: None ) –

    The updated list of insight types to run against agent sessions.

  • clustering_config (Optional[ClusteringConfig], default: None ) –

    The updated clustering configuration for periodic batch evaluation.

  • evaluation_execution_role_arn (Optional[RoleArn], default: None ) –

    The updated Amazon Resource Name (ARN) of the IAM role used for evaluation execution.

  • execution_status (Optional[OnlineEvaluationExecutionStatus], default: None ) –

    The updated execution status to enable or disable the online evaluation.

Raises:

Source code in docs_src/capo_bedrock_agentcore_control/_services/async_bedrock_agent_core_control.py
async def update_online_evaluation_config(
    self,
    online_evaluation_config_id: "capo_bedrock_agentcore_control.types.online_evaluation_config_id.OnlineEvaluationConfigId",
    *,
    config_overrides: Optional[AsyncBedrockAgentCoreControlClientConfig] = None,
    client_token: Optional[
        "capo_bedrock_agentcore_control.types.client_token.ClientToken"
    ] = None,
    description: Optional[
        "capo_bedrock_agentcore_control.types.evaluation_config_description.EvaluationConfigDescription"
    ] = None,
    rule: Optional["capo_bedrock_agentcore_control.types.rule.Rule"] = None,
    data_source_config: Optional[
        "capo_bedrock_agentcore_control.types.data_source_config.DataSourceConfig"
    ] = None,
    evaluators: Optional[
        "capo_bedrock_agentcore_control.types.evaluator_list.EvaluatorList"
    ] = None,
    insights: Optional[
        "capo_bedrock_agentcore_control.types.insight_list.InsightList"
    ] = None,
    clustering_config: Optional[
        "capo_bedrock_agentcore_control.types.clustering_config.ClusteringConfig"
    ] = None,
    output_config: Optional[
        "capo_bedrock_agentcore_control.types.output_config.OutputConfig"
    ] = None,
    evaluation_execution_role_arn: Optional[
        "capo_bedrock_agentcore_control.types.role_arn.RoleArn"
    ] = None,
    execution_status: Optional[
        "capo_bedrock_agentcore_control.types.online_evaluation_execution_status.OnlineEvaluationExecutionStatus"
    ] = None,
) -> "capo_bedrock_agentcore_control.types.update_online_evaluation_config_response.UpdateOnlineEvaluationConfigResponse":
    """<p> Updates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status. Changes take effect immediately for ongoing evaluations. </p>

    Args:
        client_token: <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
        online_evaluation_config_id: <p> The unique identifier of the online evaluation configuration to update. </p>
        description: <p> The updated description of the online evaluation configuration. </p>
        rule: <p> The updated evaluation rule containing sampling configuration, filters, and session settings. </p>
        data_source_config: <p> The updated data source configuration specifying CloudWatch log groups and service names to monitor. </p>
        evaluators: <p> The updated list of evaluators to apply during online evaluation. </p>
        insights: <p>The updated list of insight types to run against agent sessions.</p>
        clustering_config: <p>The updated clustering configuration for periodic batch evaluation.</p>
        evaluation_execution_role_arn: <p> The updated Amazon Resource Name (ARN) of the IAM role used for evaluation execution. </p>
        execution_status: <p> The updated execution status to enable or disable the online evaluation. </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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bedrock_agentcore_control.types.update_online_evaluation_config_request.UpdateOnlineEvaluationConfigRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agentcore_control.types.update_online_evaluation_config_response.UpdateOnlineEvaluationConfigResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.update_online_evaluation_config

        (
            output,
            http_response,
        ) = await capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.update_online_evaluation_config.async_update_online_evaluation_config(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

        return capo_bedrock_agentcore_control.types.update_online_evaluation_config_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateOnlineEvaluationConfig", redact_input=_redact_input
        ),
    )
    input_: capo_bedrock_agentcore_control.types.update_online_evaluation_config_request.UpdateOnlineEvaluationConfigRequest = {
        "online_evaluation_config_id": online_evaluation_config_id
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if description is not None:
        input_["description"] = description
    if rule is not None:
        input_["rule"] = rule
    if data_source_config is not None:
        input_["data_source_config"] = data_source_config
    if evaluators is not None:
        input_["evaluators"] = evaluators
    if insights is not None:
        input_["insights"] = insights
    if clustering_config is not None:
        input_["clustering_config"] = clustering_config
    if output_config is not None:
        input_["output_config"] = output_config
    if evaluation_execution_role_arn is not None:
        input_["evaluation_execution_role_arn"] = evaluation_execution_role_arn
    if execution_status is not None:
        input_["execution_status"] = execution_status

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