Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateOnlineEvaluationConfig

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

Request Syntax


PUT /online-evaluation-configs/onlineEvaluationConfigId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "dataSourceConfig": { ... },
   "description": "string",
   "evaluationExecutionRoleArn": "string",
   "evaluators": [ 
      { ... }
   ],
   "executionStatus": "string",
   "rule": { 
      "filters": [ 
         { 
            "key": "string",
            "operator": "string",
            "value": { ... }
         }
      ],
      "samplingConfig": { 
         "samplingPercentage": number
      },
      "sessionConfig": { 
         "sessionTimeoutMinutes": number
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

onlineEvaluationConfigId

The unique identifier of the online evaluation configuration to update.

Pattern: [a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

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.

Type: String

Length Constraints: Minimum length of 33. Maximum length of 256.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

Required: No

dataSourceConfig

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

Type: DataSourceConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

description

The updated description of the online evaluation configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: .+

Required: No

evaluationExecutionRoleArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+

Required: No

evaluators

The updated list of evaluators to apply during online evaluation.

Type: Array of EvaluatorReference objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

executionStatus

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

Type: String

Valid Values: ENABLED | DISABLED

Required: No

rule

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

Type: Rule object

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "executionStatus": "string",
   "failureReason": "string",
   "onlineEvaluationConfigArn": "string",
   "onlineEvaluationConfigId": "string",
   "status": "string",
   "updatedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

executionStatus

The execution status indicating whether the online evaluation is currently running.

Type: String

Valid Values: ENABLED | DISABLED

failureReason

The reason for failure if the online evaluation configuration update or execution failed.

Type: String

onlineEvaluationConfigArn

The Amazon Resource Name (ARN) of the updated online evaluation configuration.

Type: String

Pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:online-evaluation-config\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

onlineEvaluationConfigId

The unique identifier of the updated online evaluation configuration.

Type: String

Pattern: [a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

status

The status of the online evaluation configuration.

Type: String

updatedAt

The timestamp when the online evaluation configuration was last updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

ConflictException

This exception is thrown when there is a conflict performing an operation

HTTP Status Code: 409

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

ServiceQuotaExceededException

This exception is thrown when a request is made beyond the service quota

HTTP Status Code: 402

ThrottlingException

This exception is thrown when the number of requests exceeds the limit

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400