Skip to content
AWS for Query.Farm

aws.evidently.get_experiment

Example SQL Queries

SELECT * FROM
aws.evidently.get_experiment
WHERE
"experiment" = 'VALUE'
AND "project" = 'VALUE';

Description

Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments.

Table Definition

Column NameColumn Data Type
project Required Input Column

The name or ARN of the project that contains the experiment.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
_input_experiment Input Column
VARCHAR
experiment

A structure containing the configuration details of the experiment.

STRUCT(
    "arn" VARCHAR,
    "created_time" TIMESTAMP_S,
    "description" VARCHAR,
    "execution" STRUCT(
        "ended_time" TIMESTAMP_S,
        "started_time" TIMESTAMP_S
    ),
    "last_updated_time" TIMESTAMP_S,
    "metric_goals" STRUCT(
        "desired_change" VARCHAR,
        "metric_definition" STRUCT(
            "entity_id_key" VARCHAR,
            "event_pattern" VARCHAR,
            "name" VARCHAR,
            "unit_label" VARCHAR,
            "value_key" VARCHAR
        )
    )[],
    "name" VARCHAR,
    "online_ab_definition" STRUCT(
        "control_treatment_name" VARCHAR,
        "treatment_weights" MAP(VARCHAR, BIGINT)
    ),
    "project" VARCHAR,
    "randomization_salt" VARCHAR,
    "sampling_rate" BIGINT,
    "schedule" STRUCT(
        "analysis_complete_time" TIMESTAMP_S
    ),
    "segment" VARCHAR,
    "status" VARCHAR,
    "status_reason" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "treatments" STRUCT(
        "description" VARCHAR,
        "feature_variations" MAP(VARCHAR, VARCHAR),
        "name" VARCHAR
    )[],
    "type" VARCHAR
)
Show child fields
experiment.arn

The ARN of the experiment.

experiment.created_time

The date and time that the experiment is first created.

experiment.description

A description of the experiment.

experiment.execution

A structure that contains the date and time that the experiment started and ended.

Show child fields
experiment.execution.ended_time

The date and time that the experiment ended.

experiment.execution.started_time

The date and time that the experiment started.

experiment.last_updated_time

The date and time that the experiment was most recently updated.

experiment.metric_goals[]
Show child fields
experiment.metric_goals[].desired_change

INCREASE means that a variation with a higher number for this metric is performing better.

DECREASE means that a variation with a lower number for this metric is performing better.

experiment.metric_goals[].metric_definition

A structure that contains details about the metric.

Show child fields
experiment.metric_goals[].metric_definition.entity_id_key

The entity, such as a user or session, that does an action that causes a metric value to be recorded.

experiment.metric_goals[].metric_definition.event_pattern

The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

experiment.metric_goals[].metric_definition.name

The name of the metric.

experiment.metric_goals[].metric_definition.unit_label

The label for the units that the metric is measuring.

experiment.metric_goals[].metric_definition.value_key

The value that is tracked to produce the metric.

experiment.name

The name of the experiment.

experiment.online_ab_definition

A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

Show child fields
experiment.online_ab_definition.control_treatment_name

The name of the variation that is the default variation that the other variations are compared to.

experiment.online_ab_definition.treatment_weights

A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

experiment.project

The name or ARN of the project that contains this experiment.

experiment.randomization_salt

This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

experiment.sampling_rate

In thousandths of a percent, the amount of the available audience that is allocated to this experiment. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

This is represented in thousandths of a percent, so a value of 10,000 is 10% of the available audience.

experiment.schedule

A structure that contains the time and date that Evidently completed the analysis of the experiment.

Show child fields
experiment.schedule.analysis_complete_time

The time and date that Evidently completed the analysis of the experiment.

experiment.segment

The audience segment being used for the experiment, if a segment is being used.

experiment.status

The current state of the experiment.

experiment.status_reason

If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

experiment.tags

The list of tag keys and values associated with this experiment.

experiment.treatments[]
Show child fields
experiment.treatments[].description

The description of the treatment.

experiment.treatments[].feature_variations

The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

experiment.treatments[].name

The name of this treatment.

experiment.type

The type of this experiment. Currently, this value must be aws.experiment.onlineab.