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 ]

update-ab-test

Description

Updates an A/B test’s configuration, including variants, traffic allocation, evaluation settings, or execution status.

See also: AWS API Documentation

Synopsis

  update-ab-test
--ab-test-id <value>
[--client-token <value>]
[--name <value>]
[--description <value>]
[--variants <value>]
[--gateway-filter <value>]
[--evaluation-config <value>]
[--role-arn <value>]
[--execution-status <value>]
[--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

--ab-test-id (string)

The unique identifier of the A/B test to update.

--client-token (string)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

--name (string)

The updated name of the A/B test.

--description (string)

The updated description of the A/B test.

--variants (list)

The updated list of variants.

(structure)

A variant in an A/B test, representing either the control (C) or treatment (T1) configuration.

name -> (string)

The name of the variant. Must be C for control or T1 for treatment.

weight -> (integer)

The percentage of traffic to route to this variant. Weights across all variants must sum to 100.

variantConfiguration -> (structure)

The configuration for this variant, including the configuration bundle or target reference.

configurationBundle -> (structure)

A reference to a configuration bundle version to use for this variant.

bundleArn -> (string)

The Amazon Resource Name (ARN) of the configuration bundle.

bundleVersion -> (string)

The version of the configuration bundle.

target -> (structure)

A reference to a gateway target to route traffic to for this variant.

name -> (string)

The name of the gateway target.

Shorthand Syntax:

name=string,weight=integer,variantConfiguration={configurationBundle={bundleArn=string,bundleVersion=string},target={name=string}} ...

JSON Syntax:

[
  {
    "name": "string",
    "weight": integer,
    "variantConfiguration": {
      "configurationBundle": {
        "bundleArn": "string",
        "bundleVersion": "string"
      },
      "target": {
        "name": "string"
      }
    }
  }
  ...
]

--gateway-filter (structure)

The updated gateway filter.

targetPaths -> (list)

A list of target path patterns to include in the A/B test.

(string)

Shorthand Syntax:

targetPaths=string,string

JSON Syntax:

{
  "targetPaths": ["string", ...]
}

--evaluation-config (tagged union structure)

The updated evaluation configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: onlineEvaluationConfigArn, perVariantOnlineEvaluationConfig.

onlineEvaluationConfigArn -> (string)

The Amazon Resource Name (ARN) of a single online evaluation configuration to use for both variants.

perVariantOnlineEvaluationConfig -> (list)

Per-variant online evaluation configurations, allowing different evaluation settings for each variant.

(structure)

An online evaluation configuration associated with a specific A/B test variant.

name -> (string)

The name of the variant this evaluation configuration applies to.

onlineEvaluationConfigArn -> (string)

The Amazon Resource Name (ARN) of the online evaluation configuration for this variant.

Shorthand Syntax:

onlineEvaluationConfigArn=string,perVariantOnlineEvaluationConfig=[{name=string,onlineEvaluationConfigArn=string},{name=string,onlineEvaluationConfigArn=string}]

JSON Syntax:

{
  "onlineEvaluationConfigArn": "string",
  "perVariantOnlineEvaluationConfig": [
    {
      "name": "string",
      "onlineEvaluationConfigArn": "string"
    }
    ...
  ]
}

--role-arn (string)

The updated IAM role ARN.

--execution-status (string)

The updated execution status to enable or disable the A/B test.

Possible values:

  • PAUSED
  • RUNNING
  • STOPPED
  • NOT_STARTED

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

abTestId -> (string)

The unique identifier of the updated A/B test.

abTestArn -> (string)

The Amazon Resource Name (ARN) of the updated A/B test.

status -> (string)

The status of the A/B test.

executionStatus -> (string)

The execution status of the A/B test.

updatedAt -> (timestamp)

The timestamp when the A/B test was updated.