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

GetOnlineEvaluationConfig

Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.

Request Syntax


GET /online-evaluation-configs/onlineEvaluationConfigId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

onlineEvaluationConfigId

The unique identifier of the online evaluation configuration to retrieve.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "dataSourceConfig": { ... },
   "description": "string",
   "evaluationExecutionRoleArn": "string",
   "evaluators": [ 
      { ... }
   ],
   "executionStatus": "string",
   "failureReason": "string",
   "onlineEvaluationConfigArn": "string",
   "onlineEvaluationConfigId": "string",
   "onlineEvaluationConfigName": "string",
   "outputConfig": { 
      "cloudWatchConfig": { 
         "logGroupName": "string"
      }
   },
   "rule": { 
      "filters": [ 
         { 
            "key": "string",
            "operator": "string",
            "value": { ... }
         }
      ],
      "samplingConfig": { 
         "samplingPercentage": number
      },
      "sessionConfig": { 
         "sessionTimeoutMinutes": number
      }
   },
   "status": "string",
   "updatedAt": number
}

Response Elements

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

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

createdAt

The timestamp when the online evaluation configuration was created.

Type: Timestamp

dataSourceConfig

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

description

The description of the online evaluation configuration.

Type: String

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

Pattern: .+

evaluationExecutionRoleArn

The 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/.+

evaluators

The list of evaluators applied during online evaluation.

Type: Array of EvaluatorReference objects

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

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

Type: String

onlineEvaluationConfigArn

The Amazon Resource Name (ARN) of the 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 online evaluation configuration.

Type: String

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

onlineEvaluationConfigName

The name of the online evaluation configuration.

Type: String

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

outputConfig

The output configuration specifying where evaluation results are written.

Type: OutputConfig object

rule

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

Type: Rule object

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

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

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