experiment_runs

Creates, updates, deletes, gets or lists an experiment_runs resource.

Overview

Name	experiment_runs
Type	Resource
Id	aws.appconfig.experiment_runs

Fields

The following fields are returned by SELECT queries:

get_experiment_run

Name	Datatype	Description
application_id	string	The application ID. (pattern: <code>[a-z0-9]{4,7}</code>)
description	string	A description of the experiment run.
ended_at	string (date-time)	The date and time the experiment run ended, in ISO 8601 format.
experiment_definition_id	string	The experiment definition ID. (pattern: <code>[a-z0-9]{4,7}</code>)
experiment_definition_snapshot	object	A snapshot of the experiment definition at the time the run was started.
exposure_percentage	number (float)	The percentage of the target audience exposed to treatments.
result	object	The result of the experiment run, including the executive summary and launch decision rationale.
run	integer	The experiment run number.
started_at	string (date-time)	The date and time the experiment run started, in ISO 8601 format.
status	string	The current status of the experiment run. Valid values: RUNNING, DONE. (RUNNING, DONE)
treatment_overrides	object	Treatment assignment overrides that assign specific entity IDs to treatments.
updated_at	string (date-time)	The date and time the experiment run was last updated, in ISO 8601 format.

list_experiment_runs

Name	Datatype	Description
description	string	A description of the experiment run.
ended_at	string (date-time)	The date and time the experiment run ended, in ISO 8601 format.
experiment_definition_id	string	The experiment definition ID. (pattern: <code>[a-z0-9]{4,7}</code>)
run	integer	The experiment run number.
started_at	string (date-time)	The date and time the experiment run started, in ISO 8601 format.
status	string	The current status of the experiment run. (RUNNING, DONE)
updated_at	string (date-time)	The date and time the experiment run was last updated, in ISO 8601 format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_experiment_run	select	application_identifier, experiment_definition_identifier, run, region		Retrieves information about an experiment run, including its status, start time, and exposure settings.
list_experiment_runs	select	application_identifier, experiment_definition_identifier, region	max_results, next_token, status	Lists the experiment runs for a specified experiment definition. You can filter by status.
update_experiment_run	update	application_identifier, experiment_definition_identifier, run, region		Updates a running experiment. Use this operation to increase audience exposure, modify treatment assignment overrides, or update the description of an active experiment run. Audience exposure can only be increased, not decreased.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application_identifier	string	The application ID or name.
experiment_definition_identifier	string	The experiment definition ID or name.
region	string	AWS region (default: us-east-1)
run	integer	The run number to update.
max_results	integer	The maximum number of items to return.
next_token	string	A token to start the list from a previously truncated response.
status	string	A filter for the experiment run status.

SELECT examples

get_experiment_run

Retrieves information about an experiment run, including its status, start time, and exposure settings.

SELECT
application_id,
description,
ended_at,
experiment_definition_id,
experiment_definition_snapshot,
exposure_percentage,
result,
run,
started_at,
status,
treatment_overrides,
updated_at
FROM aws.appconfig.experiment_runs
WHERE application_identifier = '{{ application_identifier }}' -- required
AND experiment_definition_identifier = '{{ experiment_definition_identifier }}' -- required
AND run = '{{ run }}' -- required
AND region = '{{ region }}' -- required
;

list_experiment_runs

Lists the experiment runs for a specified experiment definition. You can filter by status.

SELECT
description,
ended_at,
experiment_definition_id,
run,
started_at,
status,
updated_at
FROM aws.appconfig.experiment_runs
WHERE application_identifier = '{{ application_identifier }}' -- required
AND experiment_definition_identifier = '{{ experiment_definition_identifier }}' -- required
AND region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
AND status = '{{ status }}'
;

UPDATE examples

update_experiment_run

Updates a running experiment. Use this operation to increase audience exposure, modify treatment assignment overrides, or update the description of an active experiment run. Audience exposure can only be increased, not decreased.

UPDATE aws.appconfig.experiment_runs
SET 
Description = '{{ Description }}',
ExposurePercentage = {{ ExposurePercentage }},
TreatmentOverrides = '{{ TreatmentOverrides }}',
DeploymentParameters = '{{ DeploymentParameters }}'
WHERE 
application_identifier = '{{ application_identifier }}' --required
AND experiment_definition_identifier = '{{ experiment_definition_identifier }}' --required
AND run = '{{ run }}' --required
AND region = '{{ region }}' --required
RETURNING
application_id,
description,
ended_at,
experiment_definition_id,
experiment_definition_snapshot,
exposure_percentage,
result,
run,
started_at,
status,
treatment_overrides,
updated_at;