experiment_run_events

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

Overview

Name	experiment_run_events
Type	Resource
Id	aws.appconfig.experiment_run_events

Fields

The following fields are returned by SELECT queries:

list_experiment_run_events

Name	Datatype	Description
associated_deployment	string	The Amazon Resource Name (ARN) of the deployment associated with this event. (pattern: <code>arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+</code>)
description	string	A description of the event.
event_type	string	The type of event. Valid values: RUN_STARTED, EXPOSURE_UPDATED, OVERRIDES_UPDATED, RUN_STOPPED. (RUN_STARTED, EXPOSURE_UPDATED, OVERRIDES_UPDATED, RUN_STOPPED)
exposure_percentage	number (float)	The exposure percentage at the time of the event.
occurred_at	string (date-time)	The date and time the event occurred, in ISO 8601 format.
treatment_overrides	object	The treatment overrides at the time of the event.
triggered_by	string	The principal that triggered the event. (USER, APPCONFIG, CLOUDWATCH_ALARM, INTERNAL_ERROR)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_experiment_run_events	select	application_identifier, experiment_definition_identifier, run, region	max_results, next_token	Lists the events for a specified experiment run. Events provide a timeline of actions and state changes that occurred during the run.

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.
max_results	integer	The maximum number of items to return.
next_token	string	A token to start the list from a previously truncated response.

SELECT examples

list_experiment_run_events

Lists the events for a specified experiment run. Events provide a timeline of actions and state changes that occurred during the run.

SELECT
associated_deployment,
description,
event_type,
exposure_percentage,
occurred_at,
treatment_overrides,
triggered_by
FROM aws.appconfig.experiment_run_events
WHERE application_identifier = '{{ application_identifier }}' -- required
AND experiment_definition_identifier = '{{ experiment_definition_identifier }}' -- required
AND run = '{{ run }}' -- required
AND region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
;