Skip to content
AWS for Query.Farm

aws.evidently.get_launch

Example SQL Queries

SELECT * FROM
aws.evidently.get_launch
WHERE
"launch" = 'VALUE'
AND "project" = 'VALUE';

Description

Returns the details about one launch. You must already know the launch name. To retrieve a list of launches in your account, use ListLaunches.

Table Definition

Column NameColumn Data Type
project Required Input Column

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

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_launch Input Column
VARCHAR
launch

A structure containing the configuration details of the launch.

STRUCT(
    "arn" VARCHAR,
    "created_time" TIMESTAMP_S,
    "description" VARCHAR,
    "execution" STRUCT(
        "ended_time" TIMESTAMP_S,
        "started_time" TIMESTAMP_S
    ),
    "groups" STRUCT(
        "description" VARCHAR,
        "feature_variations" MAP(VARCHAR, VARCHAR),
        "name" VARCHAR
    )[],
    "last_updated_time" TIMESTAMP_S,
    "metric_monitors" STRUCT(
        "metric_definition" STRUCT(
            "entity_id_key" VARCHAR,
            "event_pattern" VARCHAR,
            "name" VARCHAR,
            "unit_label" VARCHAR,
            "value_key" VARCHAR
        )
    )[],
    "name" VARCHAR,
    "project" VARCHAR,
    "randomization_salt" VARCHAR,
    "scheduled_splits_definition" STRUCT(
        "steps" STRUCT(
            "group_weights" MAP(VARCHAR, BIGINT),
            "segment_overrides" STRUCT(
                "evaluation_order" BIGINT,
                "segment" VARCHAR,
                "weights" MAP(VARCHAR, BIGINT)
            )[],
            "start_time" TIMESTAMP_S
        )[]
    ),
    "status" VARCHAR,
    "status_reason" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "type" VARCHAR
)
Show child fields
launch.arn

The ARN of the launch.

launch.created_time

The date and time that the launch is created.

launch.description

The description of the launch.

launch.execution

A structure that contains information about the start and end times of the launch.

Show child fields
launch.execution.ended_time

The date and time that the launch ended.

launch.execution.started_time

The date and time that the launch started.

launch.groups[]
Show child fields
launch.groups[].description

A description of the launch group.

launch.groups[].feature_variations

The feature variation for this launch group. This is a key-value pair.

launch.groups[].name

The name of the launch group.

launch.last_updated_time

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

launch.metric_monitors[]
Show child fields
launch.metric_monitors[].metric_definition

A structure that defines the metric.

Show child fields
launch.metric_monitors[].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.

launch.metric_monitors[].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.

launch.metric_monitors[].metric_definition.name

The name of the metric.

launch.metric_monitors[].metric_definition.unit_label

The label for the units that the metric is measuring.

launch.metric_monitors[].metric_definition.value_key

The value that is tracked to produce the metric.

launch.name

The name of the launch.

launch.project

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

launch.randomization_salt

This value is used when Evidently assigns a particular user session to the launch, to help 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.

launch.scheduled_splits_definition

An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

Show child fields
launch.scheduled_splits_definition.steps[]
Show child fields
launch.scheduled_splits_definition.steps[].group_weights

The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.

launch.scheduled_splits_definition.steps[].segment_overrides[]
Show child fields
launch.scheduled_splits_definition.steps[].segment_overrides[].evaluation_order

A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.

launch.scheduled_splits_definition.steps[].segment_overrides[].segment

The ARN of the segment to use.

launch.scheduled_splits_definition.steps[].segment_overrides[].weights

The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

launch.scheduled_splits_definition.steps[].start_time

The date and time that this step of the launch starts.

launch.status

The current state of the launch.

launch.status_reason

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

launch.tags

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

launch.type

The type of launch.