Skip to content
AWS for Query.Farm

aws.ivs.get_recording_configuration

Example SQL Queries

SELECT * FROM
aws.ivs.get_recording_configuration
WHERE
"arn" = 'VALUE';

Description

Gets the recording configuration for the specified ARN.

Table Definition

Column NameColumn Data Type
arn Required Input Column

ARN of the recording configuration 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.

_aws_region Input Column

The AWS region to use.

VARCHAR
recording_configuration 
STRUCT(
    "arn" VARCHAR,
    "name" VARCHAR,
    "destination_configuration" STRUCT(
        "s3" STRUCT(
            "bucket_name" VARCHAR
        )
    ),
    "state" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "thumbnail_configuration" STRUCT(
        "recording_mode" VARCHAR,
        "target_interval_seconds" BIGINT,
        "resolution" VARCHAR,
        "storage" VARCHAR[]
    ),
    "recording_reconnect_window_seconds" BIGINT,
    "rendition_configuration" STRUCT(
        "rendition_selection" VARCHAR,
        "renditions" VARCHAR[]
    )
)
Show child fields
recording_configuration.arn

Recording-configuration ARN.

recording_configuration.destination_configuration

A complex type that contains information about where recorded video will be stored.

Show child fields
recording_configuration.destination_configuration.s3

An S3 destination configuration where recorded videos will be stored.

Show child fields
recording_configuration.destination_configuration.s3.bucket_name

Location (S3 bucket name) where recorded videos will be stored.

recording_configuration.name

Recording-configuration name. The value does not need to be unique.

recording_configuration.recording_reconnect_window_seconds

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

recording_configuration.rendition_configuration

Object that describes which renditions should be recorded for a stream.

Show child fields
recording_configuration.rendition_configuration.rendition_selection

Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.

recording_configuration.rendition_configuration.renditions[]
recording_configuration.state

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

recording_configuration.tags

Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

recording_configuration.thumbnail_configuration

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

Show child fields
recording_configuration.thumbnail_configuration.recording_mode

Thumbnail recording mode. Default: INTERVAL.

recording_configuration.thumbnail_configuration.resolution

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

recording_configuration.thumbnail_configuration.storage[]
recording_configuration.thumbnail_configuration.target_interval_seconds

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: For the BASIC channel type, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.