Skip to content

update_ab_test

Operation

update_ab_test

update_ab_test(request: UpdateABTestInput | UpdateABTestInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateABTestInputDict]) -> UpdateABTestOutput

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

Parameters:

Name Type Description Default
request UpdateABTestInput | UpdateABTestInputDict | 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[UpdateABTestInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateABTestOutput

An instance of UpdateABTestOutput.

update_ab_test async

update_ab_test(request: UpdateABTestInput | UpdateABTestInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateABTestInputDict]) -> UpdateABTestOutput

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

Parameters:

Name Type Description Default
request UpdateABTestInput | UpdateABTestInputDict | 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[UpdateABTestInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateABTestOutput

An instance of UpdateABTestOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateABTestInputDict

Bases: TypedDict

Dictionary form of UpdateABTestInput.

Attributes

ab_test_id instance-attribute
ab_test_id: Required[str]

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

client_token instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

description instance-attribute
description: str | None

The updated description of the A/B test.

evaluation_config instance-attribute

The updated evaluation configuration.

execution_status instance-attribute
execution_status: str | None

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

gateway_filter instance-attribute
gateway_filter: GatewayFilter | GatewayFilterDict | None

The updated gateway filter.

name instance-attribute
name: str | None

The updated name of the A/B test.

role_arn instance-attribute
role_arn: str | None

The updated IAM role ARN.

variants instance-attribute
variants: Sequence[Variant | VariantDict] | None

The updated list of variants.

UpdateABTestInput dataclass

Bases: _SerdeShape

Dataclass for UpdateABTestInput structure.

Attributes

ab_test_id class-attribute instance-attribute
ab_test_id: str | None = ...

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

client_token class-attribute instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

description class-attribute instance-attribute
description: str | None = ...

The updated description of the A/B test.

evaluation_config class-attribute instance-attribute
evaluation_config: ABTestEvaluationConfig | None = ...

The updated evaluation configuration.

execution_status class-attribute instance-attribute
execution_status: str | None = ...

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

gateway_filter class-attribute instance-attribute
gateway_filter: GatewayFilter | None = ...

The updated gateway filter.

name class-attribute instance-attribute
name: str | None = ...

The updated name of the A/B test.

role_arn class-attribute instance-attribute
role_arn: str | None = ...

The updated IAM role ARN.

variants class-attribute instance-attribute
variants: list[Variant] | None = ...

The updated list of variants.

Output

UpdateABTestOutput dataclass

Bases: _SerdeShape

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.

ab_test_id instance-attribute
ab_test_id: str

The unique identifier of the updated A/B test.

execution_status instance-attribute
execution_status: str

The execution status of the A/B test.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

status instance-attribute
status: str

The status of the A/B test.

updated_at instance-attribute
updated_at: datetime

The timestamp when the A/B test was updated.