v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141531,219979.8 KB

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

put/online-evaluation-configs/{onlineEvaluationConfigId}

Path parameters

onlineEvaluationConfigIdstring required

The unique identifier of the online evaluation configuration to update.

Request body

clientTokenstring

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

descriptionstring password

The updated description of the online evaluation configuration.

evaluationExecutionRoleArnstring

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

executionStatus'ENABLED' | 'DISABLED'

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

Response

Success

onlineEvaluationConfigArnstring required

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

onlineEvaluationConfigIdstring required

The unique identifier of the updated online evaluation configuration.

updatedAtstring date-time required

The timestamp when the online evaluation configuration was last updated.

status'ACTIVE' | 'CREATING' | 'CREATE_FAILED' | 'UPDATING' | 'UPDATE_FAILED' | 'DELETING' | 'ERROR' required

The status of the online evaluation configuration.

executionStatus'ENABLED' | 'DISABLED' required

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

failureReasonstring

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