AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock-agentcore-control ]

create-online-evaluation-config

Description

Creates an online evaluation configuration for continuous monitoring of agent performance. Online evaluation automatically samples live traffic from CloudWatch logs at specified rates and applies evaluators to assess agent quality in production.

See also: AWS API Documentation

Synopsis

  create-online-evaluation-config
[--client-token <value>]
--online-evaluation-config-name <value>
[--description <value>]
--rule <value>
--data-source-config <value>
--evaluators <value>
--evaluation-execution-role-arn <value>
--enable-on-create | --no-enable-on-create
[--cli-input-json <value>]
[--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>]
[--v2-debug]

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 .

--online-evaluation-config-name (string)

The name of the online evaluation configuration. Must be unique within your account.

--description (string)

The description of the online evaluation configuration that explains its monitoring purpose and scope.

--rule (structure)

The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.

samplingConfig -> (structure)

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

samplingPercentage -> (double)

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

filters -> (list)

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

(structure)

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

key -> (string)

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

operator -> (string)

The comparison operator to use for filtering.

value -> (tagged union structure)

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.

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)

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

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 data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.

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)

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

(string)

serviceNames -> (list)

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

(string)

Shorthand Syntax:

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

JSON Syntax:

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

--evaluators (list)

The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator .

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

Shorthand Syntax:

evaluatorId=string ...

JSON Syntax:

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

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

The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation.

--enable-on-create | --no-enable-on-create (boolean)

Whether to enable the online evaluation configuration immediately upon creation. If true, evaluation begins automatically.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

onlineEvaluationConfigArn -> (string)

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

onlineEvaluationConfigId -> (string)

The unique identifier of the created online evaluation configuration.

createdAt -> (timestamp)

The timestamp when the online evaluation configuration was created.

outputConfig -> (structure)

The configuration that specifies where evaluation results should be written for monitoring and analysis.

cloudWatchConfig -> (structure)

The CloudWatch configuration for writing evaluation results to CloudWatch logs with embedded metric format.

logGroupName -> (string)

The name of the CloudWatch log group where evaluation results will be written. The log group will be created if it doesn’t exist.

status -> (string)

The status of the online evaluation configuration.

executionStatus -> (string)

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

failureReason -> (string)

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