Skip to content
AWS for Query.Farm

aws.evidently.get_segment

Example SQL Queries

SELECT * FROM
aws.evidently.get_segment
WHERE
"segment" = 'VALUE';

Description

Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.

Table Definition

Column NameColumn Data Type
_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_segment Input Column
VARCHAR
segment

A structure that contains the complete information about the segment.

STRUCT(
    "arn" VARCHAR,
    "created_time" TIMESTAMP_S,
    "description" VARCHAR,
    "experiment_count" BIGINT,
    "last_updated_time" TIMESTAMP_S,
    "launch_count" BIGINT,
    "name" VARCHAR,
    "pattern" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
segment.arn

The ARN of the segment.

segment.created_time

The date and time that this segment was created.

segment.description

The customer-created description for this segment.

segment.experiment_count

The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.

segment.last_updated_time

The date and time that this segment was most recently updated.

segment.launch_count

The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.

segment.name

The name of the segment.

segment.pattern

The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.

segment.tags

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