Bedrock Agentcore  >  Operations  >  get_ab_test

get_ab_test

Operation

get_ab_test async

get_ab_test(input: GetABTestInput, plugins: list[Plugin] | None = None) -> GetABTestOutput

Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.

Parameters:

Name	Type	Description	Default
input	GetABTestInput	An instance of GetABTestInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
GetABTestOutput	An instance of GetABTestOutput.

Input

GetABTestInput dataclass

Dataclass for GetABTestInput structure.

Attributes

ab_test_id class-attribute instance-attribute

ab_test_id: str | None = None

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

Output

GetABTestOutput dataclass

Dataclass for GetABTestOutput structure.

Attributes

ab_test_arn instance-attribute

ab_test_arn: str

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

ab_test_id instance-attribute

ab_test_id: str

The unique identifier of the A/B test.

created_at instance-attribute

created_at: datetime

The timestamp when the A/B test was created.

current_run_id class-attribute instance-attribute

current_run_id: str | None = None

The identifier of the current run of the A/B test.

description class-attribute instance-attribute

description: str | None = None

The description of the A/B test.

error_details class-attribute instance-attribute

error_details: list[str] | None = None

The error details if the A/B test encountered failures.

evaluation_config instance-attribute

evaluation_config: ABTestEvaluationConfig

The evaluation configuration for measuring variant performance.

execution_status instance-attribute

execution_status: ABTestExecutionStatus

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

gateway_arn instance-attribute

gateway_arn: str

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

gateway_filter class-attribute instance-attribute

gateway_filter: GatewayFilter | None = None

The gateway filter restricting which target paths are included.

max_duration_expires_at class-attribute instance-attribute

max_duration_expires_at: datetime | None = None

The timestamp when the A/B test will automatically expire.

name instance-attribute

name: str

The name of the A/B test.

results class-attribute instance-attribute

results: ABTestResults | None = None

The statistical results of the A/B test, including per-evaluator metrics and significance analysis.

role_arn class-attribute instance-attribute

role_arn: str | None = None

The IAM role ARN used by the A/B test.

started_at class-attribute instance-attribute

started_at: datetime | None = None

The timestamp when the A/B test was started.

status instance-attribute

status: ABTestStatus

The current status of the A/B test.

stopped_at class-attribute instance-attribute

stopped_at: datetime | None = None

The timestamp when the A/B test was stopped.

updated_at instance-attribute

updated_at: datetime

The timestamp when the A/B test was last updated.

variants instance-attribute

variants: list[Variant]

The list of variants in the A/B test.