get_ab_test¶
Operation¶
get_ab_test
¶
get_ab_test(request: GetABTestInput | GetABTestInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetABTestInputDict]) -> GetABTestOutput
Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetABTestInput | GetABTestInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetABTestInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetABTestOutput
|
An instance of |
get_ab_test
async
¶
get_ab_test(request: GetABTestInput | GetABTestInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetABTestInputDict]) -> GetABTestOutput
Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetABTestInput | GetABTestInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetABTestInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetABTestOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
GetABTestOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetABTestOutput structure.
Attributes¶
current_run_id
class-attribute
instance-attribute
¶
current_run_id: str | None = ...
The identifier of the current run of the A/B test.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the A/B test.
error_details
class-attribute
instance-attribute
¶
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: str
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 = ...
The gateway filter restricting which target paths are included.
max_duration_expires_at
class-attribute
instance-attribute
¶
max_duration_expires_at: datetime | None = ...
The timestamp when the A/B test will automatically expire.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
results
class-attribute
instance-attribute
¶
results: ABTestResults | 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 = ...
The IAM role ARN used by the A/B test.
started_at
class-attribute
instance-attribute
¶
started_at: datetime | None = ...
The timestamp when the A/B test was started.
stopped_at
class-attribute
instance-attribute
¶
stopped_at: datetime | None = ...
The timestamp when the A/B test was stopped.