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	aws.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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Project, Treatments, MetricGoals, OnlineAbConfig, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
get_resource	SELECT	data__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 aws.evidently.experiments
WHERE region = 'us-east-1' AND data__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 aws.evidently.experiments (
 Name,
 Project,
 Treatments,
 MetricGoals,
 OnlineAbConfig,
 region
)
SELECT 
'{{ Name }}',
 '{{ Project }}',
 '{{ Treatments }}',
 '{{ MetricGoals }}',
 '{{ OnlineAbConfig }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.evidently.experiments (
 Name,
 Project,
 Description,
 RunningStatus,
 RandomizationSalt,
 Treatments,
 MetricGoals,
 SamplingRate,
 OnlineAbConfig,
 Segment,
 RemoveSegment,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Project }}',
 '{{ Description }}',
 '{{ RunningStatus }}',
 '{{ RandomizationSalt }}',
 '{{ Treatments }}',
 '{{ MetricGoals }}',
 '{{ SamplingRate }}',
 '{{ OnlineAbConfig }}',
 '{{ Segment }}',
 '{{ RemoveSegment }}',
 '{{ 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: RunningStatus
        value:
          Status: '{{ Status }}'
          AnalysisCompleteTime: '{{ AnalysisCompleteTime }}'
          Reason: '{{ Reason }}'
          DesiredState: '{{ DesiredState }}'
      - name: RandomizationSalt
        value: '{{ RandomizationSalt }}'
      - name: Treatments
        value:
          - TreatmentName: '{{ TreatmentName }}'
            Description: '{{ Description }}'
            Feature: '{{ Feature }}'
            Variation: '{{ Variation }}'
      - name: MetricGoals
        value:
          - MetricName: '{{ MetricName }}'
            EntityIdKey: '{{ EntityIdKey }}'
            ValueKey: '{{ ValueKey }}'
            EventPattern: '{{ EventPattern }}'
            UnitLabel: '{{ UnitLabel }}'
            DesiredChange: '{{ DesiredChange }}'
      - name: SamplingRate
        value: '{{ SamplingRate }}'
      - name: OnlineAbConfig
        value:
          ControlTreatmentName: '{{ ControlTreatmentName }}'
          TreatmentWeights:
            - Treatment: '{{ Treatment }}'
              SplitWeight: '{{ SplitWeight }}'
      - name: Segment
        value: '{{ Segment }}'
      - name: RemoveSegment
        value: '{{ RemoveSegment }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.evidently.experiments
WHERE data__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