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

CreateABTest

Creates an A/B test for comparing agent configurations. A/B tests split traffic between a control variant and a treatment variant through a gateway, then evaluate performance using online evaluation configurations to determine which variant performs better.

Request Syntax


POST /ab-tests HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "enableOnCreate": boolean,
   "evaluationConfig": { ... },
   "gatewayArn": "string",
   "gatewayFilter": { 
      "targetPaths": [ "string" ]
   },
   "name": "string",
   "roleArn": "string",
   "variants": [ 
      { 
         "name": "string",
         "variantConfiguration": { 
            "configurationBundle": { 
               "bundleArn": "string",
               "bundleVersion": "string"
            },
            "target": { 
               "name": "string"
            }
         },
         "weight": number
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

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.

Type: String

Length Constraints: Minimum length of 33. Maximum length of 256.

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

Required: No

description

The description of the A/B test.

Type: String

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

Required: No

enableOnCreate

Whether to enable the A/B test immediately upon creation. If true, traffic splitting begins automatically.

Type: Boolean

Required: No

evaluationConfig

The evaluation configuration specifying which online evaluation configurations to use for measuring variant performance.

Type: ABTestEvaluationConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

gatewayArn

The Amazon Resource Name (ARN) of the gateway to use for traffic splitting.

Type: String

Pattern: arn:aws(|-cn|-us-gov):bedrock-agentcore:[a-z0-9-]{1,20}:[0-9]{12}:gateway/([0-9a-z][-]?){1,48}-[a-z0-9]{10}

Required: Yes

gatewayFilter

Optional filter to restrict which gateway target paths are included in the A/B test.

Type: GatewayFilter object

Required: No

name

The name of the A/B test. Must be unique within your account.

Type: String

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

Required: Yes

roleArn

The IAM role ARN that grants permissions for the A/B test to access gateway and evaluation resources.

Type: String

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

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

Required: Yes

variants

The list of variants for the A/B test. Must contain exactly two variants: a control (C) and a treatment (T1), each with a configuration bundle or target reference and a traffic weight.

Type: Array of Variant objects

Array Members: Fixed number of 2 items.

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "abTestArn": "string",
   "abTestId": "string",
   "createdAt": number,
   "executionStatus": "string",
   "name": "string",
   "status": "string"
}

Response Elements

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

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

abTestArn

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

Type: String

Pattern: arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:ab-test/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

abTestId

The unique identifier of the created A/B test.

Type: String

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

createdAt

The timestamp when the A/B test was created.

Type: Timestamp

executionStatus

The execution status indicating whether the A/B test is currently running.

Type: String

Valid Values: PAUSED | RUNNING | STOPPED | NOT_STARTED

name

The name of the A/B test.

Type: String

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

status

The status of the A/B test.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

HTTP Status Code: 403

ConflictException

The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

HTTP Status Code: 409

InternalServerException

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

HTTP Status Code: 500

ServiceQuotaExceededException

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

HTTP Status Code: 402

ThrottlingException

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

HTTP Status Code: 429

UnauthorizedException

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

HTTP Status Code: 401

ValidationException

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

HTTP Status Code: 400