Skip to content
AWS for Query.Farm

aws.ivs_realtime.get_composition

Example SQL Queries

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

Description

Get information about the specified Composition resource.

Table Definition

Column NameColumn Data Type
arn Required Input Column

ARN of the Composition resource.

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.

composition

The Composition that was returned.

STRUCT(
    "arn" VARCHAR,
    "stage_arn" VARCHAR,
    "state" VARCHAR,
    "layout" STRUCT(
        "grid" STRUCT(
            "featured_participant_attribute" VARCHAR,
            "omit_stopped_video" BOOLEAN,
            "video_aspect_ratio" VARCHAR,
            "video_fill_mode" VARCHAR,
            "grid_gap" BIGINT
        ),
        "pip" STRUCT(
            "featured_participant_attribute" VARCHAR,
            "omit_stopped_video" BOOLEAN,
            "video_fill_mode" VARCHAR,
            "grid_gap" BIGINT,
            "pip_participant_attribute" VARCHAR,
            "pip_behavior" VARCHAR,
            "pip_offset" BIGINT,
            "pip_position" VARCHAR,
            "pip_width" BIGINT,
            "pip_height" BIGINT
        )
    ),
    "destinations" STRUCT(
        "id" VARCHAR,
        "state" VARCHAR,
        "start_time" TIMESTAMP_S,
        "end_time" TIMESTAMP_S,
        "configuration" STRUCT(
            "name" VARCHAR,
            "channel" STRUCT(
                "channel_arn" VARCHAR,
                "encoder_configuration_arn" VARCHAR
            ),
            "s3" STRUCT(
                "storage_configuration_arn" VARCHAR,
                "encoder_configuration_arns" VARCHAR[],
                "recording_configuration" STRUCT(
                    "format" VARCHAR
                )
            )
        ),
        "detail" STRUCT(
            "s3" STRUCT(
                "recording_prefix" VARCHAR
            )
        )
    )[],
    "tags" MAP(VARCHAR, VARCHAR),
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S
)
Show child fields
composition.arn

ARN of the Composition resource.

composition.destinations[]
Show child fields
composition.destinations[].configuration

Configuration used to create this destination.

Show child fields
composition.destinations[].configuration.channel

An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an s3 must be specified.

Show child fields
composition.destinations[].configuration.channel.channel_arn

ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).

composition.destinations[].configuration.channel.encoder_configuration_arn

ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

composition.destinations[].configuration.name

Name that can be specified to help identify the destination.

composition.destinations[].configuration.s3

An S3 storage configuration to be used for recording video data. Either a channel or an s3 must be specified.

Show child fields
composition.destinations[].configuration.s3.encoder_configuration_arns[]
composition.destinations[].configuration.s3.recording_configuration

Array of maps, each of the form string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.

Show child fields
composition.destinations[].configuration.s3.recording_configuration.format

The recording format for storing a recording in Amazon S3.

composition.destinations[].configuration.s3.storage_configuration_arn

ARN of the StorageConfiguration where recorded videos will be stored.

composition.destinations[].detail

Optional details regarding the status of the destination.

Show child fields
composition.destinations[].detail.s3

An S3 detail object to return information about the S3 destination.

Show child fields
composition.destinations[].detail.s3.recording_prefix

The S3 bucket prefix under which the recording is stored.

composition.destinations[].end_time

UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.

composition.destinations[].id

Unique identifier for this destination, assigned by IVS.

composition.destinations[].start_time

UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.

composition.destinations[].state

State of the Composition Destination.

composition.end_time

UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

composition.layout

Layout object to configure composition parameters.

Show child fields
composition.layout.grid

Configuration related to grid layout. Default: Grid layout.

Show child fields
composition.layout.grid.featured_participant_attribute

This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: "" (no featured participant).

composition.layout.grid.grid_gap

Specifies the spacing between participant tiles in pixels. Default: 2.

composition.layout.grid.omit_stopped_video

Determines whether to omit participants with stopped video in the composition. Default: false.

composition.layout.grid.video_aspect_ratio

Sets the non-featured participant display mode, to control the aspect ratio of video tiles. VIDEO is 16:9, SQUARE is 1:1, and PORTRAIT is 3:4. Default: VIDEO.

composition.layout.grid.video_fill_mode

Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.

composition.layout.pip

Configuration related to PiP layout.

Show child fields
composition.layout.pip.featured_participant_attribute

This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: "" (no featured participant).

composition.layout.pip.grid_gap

Specifies the spacing between participant tiles in pixels. Default: 0.

composition.layout.pip.omit_stopped_video

Determines whether to omit participants with stopped video in the composition. Default: false.

composition.layout.pip.pip_behavior

Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

composition.layout.pip.pip_height

Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

composition.layout.pip.pip_offset

Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.

composition.layout.pip.pip_participant_attribute

Specifies the participant for the PiP window. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: "" (no PiP participant).

composition.layout.pip.pip_position

Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

composition.layout.pip.pip_width

Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

composition.layout.pip.video_fill_mode

Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.

composition.stage_arn

ARN of the stage used as input

composition.start_time

UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

composition.state

State of the Composition.

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