update-online-evaluation-config¶

Description¶

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

Synopsis¶

  update-online-evaluation-config
[--client-token <value>]
--online-evaluation-config-id <value>
[--description <value>]
[--rule <value>]
[--data-source-config <value>]
[--evaluators <value>]
[--evaluation-execution-role-arn <value>]
[--execution-status <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--client-token (string)

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 .

Constraints:

min: 33

max: 256

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

--online-evaluation-config-id (string) [required]

The unique identifier of the online evaluation configuration to update.

Constraints:

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

--description (string)

The updated description of the online evaluation configuration.

Constraints:

min: 1

max: 200

pattern: .+

--rule (structure)

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

samplingConfig -> (structure) [required]

The sampling configuration that determines what percentage of agent traces to evaluate.

samplingPercentage -> (double) [required]

The percentage of agent traces to sample for evaluation, ranging from 0.01% to 100%.

Constraints:

min: 0.01

max: 100.0

filters -> (list)

The list of filters that determine which agent traces should be included in the evaluation based on trace properties.

Constraints:

min: 0

max: 5

(structure)

The filter that applies conditions to agent traces during online evaluation to determine which traces should be evaluated.

key -> (string) [required]

The key or field name to filter on within the agent trace data.

Constraints:

min: 1

max: 256

pattern: [a-zA-Z0-9._-]+

operator -> (string) [required]

The comparison operator to use for filtering.

Possible values:

Equals

NotEquals

GreaterThan

LessThan

GreaterThanOrEqual

LessThanOrEqual

Contains

NotContains

value -> (tagged union structure) [required]

The value to compare against using the specified operator.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: stringValue, doubleValue, booleanValue.

stringValue -> (string)

The string value for text-based filtering.

Constraints:

min: 1

max: 1024

doubleValue -> (double)

The numeric value for numerical filtering and comparisons.

booleanValue -> (boolean)

The boolean value for true/false filtering conditions.

sessionConfig -> (structure)

The session configuration that defines timeout settings for detecting when agent sessions are complete and ready for evaluation.

sessionTimeoutMinutes -> (integer) [required]

The number of minutes of inactivity after which an agent session is considered complete and ready for evaluation. Default is 15 minutes.

Constraints:

min: 1

max: 1440

JSON Syntax:

{
  "samplingConfig": {
    "samplingPercentage": double
  },
  "filters": [
    {
      "key": "string",
      "operator": "Equals"|"NotEquals"|"GreaterThan"|"LessThan"|"GreaterThanOrEqual"|"LessThanOrEqual"|"Contains"|"NotContains",
      "value": {
        "stringValue": "string",
        "doubleValue": double,
        "booleanValue": true|false
      }
    }
    ...
  ],
  "sessionConfig": {
    "sessionTimeoutMinutes": integer
  }
}

--data-source-config (tagged union structure)

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

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: cloudWatchLogs.

cloudWatchLogs -> (structure)

The CloudWatch logs configuration for reading agent traces from log groups.

logGroupNames -> (list) [required]

The list of CloudWatch log group names to monitor for agent traces.

Constraints:

min: 1

max: 5

(string)

Constraints:

min: 1

max: 512

pattern: [.\-_/#A-Za-z0-9]+

serviceNames -> (list) [required]

The list of service names to filter traces within the specified log groups. Used to identify relevant agent sessions.

Constraints:

min: 1

max: 1

(string)

Constraints:

min: 1

max: 256

pattern: [a-zA-Z0-9._-]+

Shorthand Syntax:

cloudWatchLogs={logGroupNames=[string,string],serviceNames=[string,string]}

JSON Syntax:

{
  "cloudWatchLogs": {
    "logGroupNames": ["string", ...],
    "serviceNames": ["string", ...]
  }
}

--evaluators (list)

The updated list of evaluators to apply during online evaluation.

Constraints:

min: 1

max: 10

(tagged union structure)

The reference to an evaluator used in online evaluation configurations, containing the evaluator identifier.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: evaluatorId.

evaluatorId -> (string)

The unique identifier of the evaluator. Can reference builtin evaluators (e.g., Builtin.Helpfulness) or custom evaluators.

Constraints:

pattern: (Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})

Shorthand Syntax:

evaluatorId=string ...

JSON Syntax:

[
  {
    "evaluatorId": "string"
  }
  ...
]

--evaluation-execution-role-arn (string)

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

Constraints:

min: 1

max: 2048

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

--execution-status (string)

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

Possible values:

ENABLED

DISABLED

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

onlineEvaluationConfigArn -> (string)

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

Constraints:

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 -> (string)

The unique identifier of the updated online evaluation configuration.

Constraints:

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

updatedAt -> (timestamp)

The timestamp when the online evaluation configuration was last updated.

status -> (string)

The status of the online evaluation configuration.

Possible values:

ACTIVE

CREATING

CREATE_FAILED

UPDATING

UPDATE_FAILED

DELETING

executionStatus -> (string)

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

Possible values:

ENABLED

DISABLED

failureReason -> (string)

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

Table of Contents

Feedback

User Guide

update-online-evaluation-config¶

Description¶

Synopsis¶

Options¶

Note

Note

Note

Global Options¶

Output¶