experiments

Creates, updates, deletes or gets an experiment resource or lists experiments in a region

Overview

Name	experiments
Type	Resource
Description	Resource Type definition for AWS::Evidently::Experiment.
Id	awscc.evidently.experiments

Fields

Name	Datatype	Description
arn	string
name	string
project	string
description	string
▶running_status	object	Start Experiment. Default is False
randomization_salt	string
▶treatments	array
▶metric_goals	array
sampling_rate	integer
▶online_ab_config	object
segment	string
remove_segment	boolean
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

For more information, see AWS::Evidently::Experiment.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Project, Treatments, MetricGoals, OnlineAbConfig, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual experiment.

SELECT
  region,
  arn,
  name,
  project,
  description,
  running_status,
  randomization_salt,
  treatments,
  metric_goals,
  sampling_rate,
  online_ab_config,
  segment,
  remove_segment,
  tags
FROM awscc.evidently.experiments
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

INSERT example

Use the following StackQL query and manifest file to create a new experiment resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.evidently.experiments (
  Name,
  Project,
  Treatments,
  MetricGoals,
  OnlineAbConfig,
  region
)
SELECT
  '{{ name }}',
  '{{ project }}',
  '{{ treatments }}',
  '{{ metric_goals }}',
  '{{ online_ab_config }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.evidently.experiments (
  Name,
  Project,
  Description,
  RunningStatus,
  RandomizationSalt,
  Treatments,
  MetricGoals,
  SamplingRate,
  OnlineAbConfig,
  Segment,
  RemoveSegment,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ project }}',
  '{{ description }}',
  '{{ running_status }}',
  '{{ randomization_salt }}',
  '{{ treatments }}',
  '{{ metric_goals }}',
  '{{ sampling_rate }}',
  '{{ online_ab_config }}',
  '{{ segment }}',
  '{{ remove_segment }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: experiment
    props:
      - name: name
        value: '{{ name }}'
      - name: project
        value: '{{ project }}'
      - name: description
        value: '{{ description }}'
      - name: running_status
        value:
          status: '{{ status }}'
          analysis_complete_time: '{{ analysis_complete_time }}'
          reason: '{{ reason }}'
          desired_state: '{{ desired_state }}'
      - name: randomization_salt
        value: '{{ randomization_salt }}'
      - name: treatments
        value:
          - treatment_name: '{{ treatment_name }}'
            description: '{{ description }}'
            feature: '{{ feature }}'
            variation: '{{ variation }}'
      - name: metric_goals
        value:
          - metric_name: '{{ metric_name }}'
            entity_id_key: '{{ entity_id_key }}'
            value_key: '{{ value_key }}'
            event_pattern: '{{ event_pattern }}'
            unit_label: '{{ unit_label }}'
            desired_change: '{{ desired_change }}'
      - name: sampling_rate
        value: '{{ sampling_rate }}'
      - name: online_ab_config
        value:
          control_treatment_name: '{{ control_treatment_name }}'
          treatment_weights:
            - treatment: '{{ treatment }}'
              split_weight: '{{ split_weight }}'
      - name: segment
        value: '{{ segment }}'
      - name: remove_segment
        value: '{{ remove_segment }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a experiment resource, using stack-deploy.

/*+ update */
UPDATE awscc.evidently.experiments
SET PatchDocument = string('{{ {
    "Description": description,
    "RunningStatus": running_status,
    "RandomizationSalt": randomization_salt,
    "Treatments": treatments,
    "MetricGoals": metric_goals,
    "SamplingRate": sampling_rate,
    "OnlineAbConfig": online_ab_config,
    "Segment": segment,
    "RemoveSegment": remove_segment,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.evidently.experiments
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the experiments resource, the following permissions are required:

Create

evidently:CreateExperiment,
evidently:TagResource,
evidently:GetExperiment,
evidently:StartExperiment

Read

evidently:GetExperiment,
evidently:ListTagsForResource

Update

evidently:UpdateExperiment,
evidently:TagResource,
evidently:UntagResource,
evidently:GetExperiment,
evidently:StartExperiment,
evidently:StopExperiment

Delete

evidently:DeleteExperiment,
evidently:UntagResource,
evidently:GetExperiment