Skip to content
AWS for Query.Farm

aws.ivs_realtime.get_encoder_configuration

Example SQL Queries

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

Description

Gets information about the specified EncoderConfiguration resource.

Table Definition

Column NameColumn Data Type
arn Required Input Column

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

encoder_configuration

The EncoderConfiguration that was returned.

STRUCT(
    "arn" VARCHAR,
    "name" VARCHAR,
    "video" STRUCT(
        "width" BIGINT,
        "height" BIGINT,
        "framerate" DOUBLE,
        "bitrate" BIGINT
    ),
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
encoder_configuration.arn

ARN of the EncoderConfiguration resource.

encoder_configuration.name

Optional name to identify the resource.

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

encoder_configuration.video

Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps

Show child fields
encoder_configuration.video.bitrate

Bitrate for generated output, in bps. Default: 2500000.

encoder_configuration.video.framerate

Video frame rate, in fps. Default: 30.

encoder_configuration.video.height

Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.

encoder_configuration.video.width

Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.