Skip to content
AWS for Query.Farm

aws.ivs_realtime.list_compositions

Example SQL Queries

SELECT * FROM
aws.ivs_realtime.list_compositions;

Description

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

Table Definition

Column NameColumn Data Type
filter_by_encoder_configuration_arn Input Column

Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.

VARCHAR
filter_by_stage_arn Input Column

Filters the Composition list to match the specified Stage ARN.

VARCHAR
max_results Input Column

Maximum number of results to return. Default: 100.

BIGINT
next_token Input Column

If there are more compositions than maxResults, use nextToken in the request to get the next set.

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.

compositions

List of the matching Compositions (summary information only).

STRUCT(
    "arn" VARCHAR,
    "stage_arn" VARCHAR,
    "destinations" STRUCT(
        "id" VARCHAR,
        "state" VARCHAR,
        "start_time" TIMESTAMP_S,
        "end_time" TIMESTAMP_S
    )[],
    "state" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S
)[]
Show child fields
compositions[]
Show child fields
compositions[].arn

ARN of the Composition resource.

compositions[].destinations[]
Show child fields
compositions[].destinations[].end_time

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

compositions[].destinations[].id

Unique identifier for this destination, assigned by IVS.

compositions[].destinations[].start_time

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

compositions[].destinations[].state

State of the Composition Destination.

compositions[].end_time

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

compositions[].stage_arn

ARN of the attached stage.

compositions[].start_time

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

compositions[].state

State of the Composition resource.

compositions[].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.