Skip to content
AWS for Query.Farm

aws.ivs_realtime.get_stage

Example SQL Queries

SELECT * FROM
aws.ivs_realtime.get_stage
WHERE
"arn" = 'VALUE';

Description

Gets information for the specified stage.

Table Definition

Column NameColumn Data Type
arn Required Input Column

ARN of the stage for which the information is to be retrieved.

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.

stage

The stage that is returned.

STRUCT(
    "arn" VARCHAR,
    "name" VARCHAR,
    "active_session_id" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "auto_participant_recording_configuration" STRUCT(
        "storage_configuration_arn" VARCHAR,
        "media_types" VARCHAR[]
    ),
    "endpoints" STRUCT(
        "events" VARCHAR,
        "whip" VARCHAR
    )
)
Show child fields
stage.active_session_id

ID of the active session within the stage.

stage.arn

Stage ARN.

stage.auto_participant_recording_configuration

Configuration object for individual participant recording, attached to the stage.

Show child fields
stage.auto_participant_recording_configuration.media_types[]
stage.auto_participant_recording_configuration.storage_configuration_arn

ARN of the StorageConfiguration resource to use for individual participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

stage.endpoints

Summary information about various endpoints for a stage.

Show child fields
stage.endpoints.events

Events endpoint.

stage.endpoints.whip

WHIP endpoint.

stage.name

Stage name.

stage.tags

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.