update_ab_test¶
Operation¶
update_ab_test
async
¶
update_ab_test(input: UpdateABTestInput, plugins: list[Plugin] | None = None) -> UpdateABTestOutput
Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateABTestInput
|
An instance of |
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 |
|---|---|
UpdateABTestOutput
|
An instance of |
Input¶
UpdateABTestInput
dataclass
¶
Dataclass for UpdateABTestInput structure.
Attributes¶
ab_test_id
class-attribute
instance-attribute
¶
ab_test_id: str | None = None
The unique identifier of the A/B test to update.
client_token
class-attribute
instance-attribute
¶
client_token: str | None = None
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.
description
class-attribute
instance-attribute
¶
description: str | None = None
The updated description of the A/B test.
evaluation_config
class-attribute
instance-attribute
¶
evaluation_config: ABTestEvaluationConfig | None = None
The updated evaluation configuration.
execution_status
class-attribute
instance-attribute
¶
execution_status: ABTestExecutionStatus | None = None
The updated execution status to enable or disable the A/B test.
gateway_filter
class-attribute
instance-attribute
¶
gateway_filter: GatewayFilter | None = None
The updated gateway filter.
Output¶
UpdateABTestOutput
dataclass
¶
Dataclass for UpdateABTestOutput structure.
Attributes¶
ab_test_arn
instance-attribute
¶
ab_test_arn: str
The Amazon Resource Name (ARN) of the updated A/B test.
execution_status
instance-attribute
¶
execution_status: ABTestExecutionStatus
The execution status of the A/B test.