Skip to content
AWS for Query.Farm

aws.mediatailor.describe_program

Example SQL Queries

SELECT * FROM
aws.mediatailor.describe_program
WHERE
"channel_name" = 'VALUE'
AND "program_name" = 'VALUE';

Description

Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

Table Definition

Column NameColumn Data Type
channel_name Required Input Column

The name of the channel that the program belongs to.

VARCHAR
program_name Required Input Column

The name of the program.

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.

ad_breaks

The ad break configuration settings.

STRUCT(
    "ad_break_metadata" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "message_type" VARCHAR,
    "offset_millis" BIGINT,
    "slate" STRUCT(
        "source_location_name" VARCHAR,
        "vod_source_name" VARCHAR
    ),
    "splice_insert_message" STRUCT(
        "avail_num" BIGINT,
        "avails_expected" BIGINT,
        "splice_event_id" BIGINT,
        "unique_program_id" BIGINT
    ),
    "time_signal_message" STRUCT(
        "segmentation_descriptors" STRUCT(
            "segment_num" BIGINT,
            "segmentation_event_id" BIGINT,
            "segmentation_type_id" BIGINT,
            "segmentation_upid" VARCHAR,
            "segmentation_upid_type" BIGINT,
            "segments_expected" BIGINT,
            "sub_segment_num" BIGINT,
            "sub_segments_expected" BIGINT
        )[]
    )
)[]
Show child fields
ad_breaks[]
Show child fields
ad_breaks[].ad_break_metadata[]
Show child fields
ad_breaks[].ad_break_metadata[].key

For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the EXT-X-ASSETtag. If you specify a key, you must also specify a corresponding value.

ad_breaks[].ad_break_metadata[].value

For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the EXT-X-ASSETtag. If you specify a value, you must also specify a corresponding key.

ad_breaks[].message_type

The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.

ad_breaks[].offset_millis

How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

ad_breaks[].slate

Ad break slate configuration.

Show child fields
ad_breaks[].slate.source_location_name

The name of the source location where the slate VOD source is stored.

ad_breaks[].slate.vod_source_name

The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

ad_breaks[].splice_insert_message

This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

Show child fields
ad_breaks[].splice_insert_message.avail_num

This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

ad_breaks[].splice_insert_message.avails_expected

This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

ad_breaks[].splice_insert_message.splice_event_id

This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.

ad_breaks[].splice_insert_message.unique_program_id

This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

ad_breaks[].time_signal_message

Defines the SCTE-35 time_signal message inserted around the ad.

Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.

See section 9.7.4 of the 2022 SCTE-35 specification for more information.

Show child fields
ad_breaks[].time_signal_message.segmentation_descriptors[]
Show child fields
ad_breaks[].time_signal_message.segmentation_descriptors[].segment_num

The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.

ad_breaks[].time_signal_message.segmentation_descriptors[].segmentation_event_id

The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.

ad_breaks[].time_signal_message.segmentation_descriptors[].segmentation_type_id

The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.

ad_breaks[].time_signal_message.segmentation_descriptors[].segmentation_upid

The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).

ad_breaks[].time_signal_message.segmentation_descriptors[].segmentation_upid_type

The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.

ad_breaks[].time_signal_message.segmentation_descriptors[].segments_expected

The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.

ad_breaks[].time_signal_message.segmentation_descriptors[].sub_segment_num

The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.

ad_breaks[].time_signal_message.segmentation_descriptors[].sub_segments_expected

The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.

arn

The ARN of the program.

VARCHAR
audience_media

The list of AudienceMedia defined in program.

STRUCT(
    "alternate_media" STRUCT(
        "ad_breaks" STRUCT(
            "ad_break_metadata" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[],
            "message_type" VARCHAR,
            "offset_millis" BIGINT,
            "slate" STRUCT(
                "source_location_name" VARCHAR,
                "vod_source_name" VARCHAR
            ),
            "splice_insert_message" STRUCT(
                "avail_num" BIGINT,
                "avails_expected" BIGINT,
                "splice_event_id" BIGINT,
                "unique_program_id" BIGINT
            ),
            "time_signal_message" STRUCT(
                "segmentation_descriptors" STRUCT(
                    "segment_num" BIGINT,
                    "segmentation_event_id" BIGINT,
                    "segmentation_type_id" BIGINT,
                    "segmentation_upid" VARCHAR,
                    "segmentation_upid_type" BIGINT,
                    "segments_expected" BIGINT,
                    "sub_segment_num" BIGINT,
                    "sub_segments_expected" BIGINT
                )[]
            )
        )[],
        "clip_range" STRUCT(
            "end_offset_millis" BIGINT,
            "start_offset_millis" BIGINT
        ),
        "duration_millis" BIGINT,
        "live_source_name" VARCHAR,
        "scheduled_start_time_millis" BIGINT,
        "source_location_name" VARCHAR,
        "vod_source_name" VARCHAR
    )[],
    "audience" VARCHAR
)[]
Show child fields
audience_media[]
Show child fields
audience_media[].alternate_media[]
Show child fields
audience_media[].alternate_media[].ad_breaks[]
Show child fields
audience_media[].alternate_media[].ad_breaks[].ad_break_metadata[]
Show child fields
audience_media[].alternate_media[].ad_breaks[].ad_break_metadata[].key

For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the EXT-X-ASSETtag. If you specify a key, you must also specify a corresponding value.

audience_media[].alternate_media[].ad_breaks[].ad_break_metadata[].value

For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the EXT-X-ASSETtag. If you specify a value, you must also specify a corresponding key.

audience_media[].alternate_media[].ad_breaks[].message_type

The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.

audience_media[].alternate_media[].ad_breaks[].offset_millis

How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

audience_media[].alternate_media[].ad_breaks[].slate

Ad break slate configuration.

Show child fields
audience_media[].alternate_media[].ad_breaks[].slate.source_location_name

The name of the source location where the slate VOD source is stored.

audience_media[].alternate_media[].ad_breaks[].slate.vod_source_name

The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

audience_media[].alternate_media[].ad_breaks[].splice_insert_message

This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

Show child fields
audience_media[].alternate_media[].ad_breaks[].splice_insert_message.avail_num

This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

audience_media[].alternate_media[].ad_breaks[].splice_insert_message.avails_expected

This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

audience_media[].alternate_media[].ad_breaks[].splice_insert_message.splice_event_id

This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.

audience_media[].alternate_media[].ad_breaks[].splice_insert_message.unique_program_id

This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

audience_media[].alternate_media[].ad_breaks[].time_signal_message

Defines the SCTE-35 time_signal message inserted around the ad.

Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.

See section 9.7.4 of the 2022 SCTE-35 specification for more information.

Show child fields
audience_media[].alternate_media[].ad_breaks[].time_signal_message.segmentation_descriptors[]
Show child fields
audience_media[].alternate_media[].ad_breaks[].time_signal_message.segmentation_descriptors[].segment_num

The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.

audience_media[].alternate_media[].ad_breaks[].time_signal_message.segmentation_descriptors[].segmentation_event_id

The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.

audience_media[].alternate_media[].ad_breaks[].time_signal_message.segmentation_descriptors[].segmentation_type_id

The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.

audience_media[].alternate_media[].ad_breaks[].time_signal_message.segmentation_descriptors[].segmentation_upid

The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).

audience_media[].alternate_media[].ad_breaks[].time_signal_message.segmentation_descriptors[].segmentation_upid_type

The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.

audience_media[].alternate_media[].ad_breaks[].time_signal_message.segmentation_descriptors[].segments_expected

The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.

audience_media[].alternate_media[].ad_breaks[].time_signal_message.segmentation_descriptors[].sub_segment_num

The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.

audience_media[].alternate_media[].ad_breaks[].time_signal_message.segmentation_descriptors[].sub_segments_expected

The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.

audience_media[].alternate_media[].clip_range

Clip range configuration for the VOD source associated with the program.

Show child fields
audience_media[].alternate_media[].clip_range.end_offset_millis

The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.

audience_media[].alternate_media[].clip_range.start_offset_millis

The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.

audience_media[].alternate_media[].duration_millis

The duration of the alternateMedia in milliseconds.

audience_media[].alternate_media[].live_source_name

The name of the live source for alternateMedia.

audience_media[].alternate_media[].scheduled_start_time_millis

The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.

audience_media[].alternate_media[].source_location_name

The name of the source location for alternateMedia.

audience_media[].alternate_media[].vod_source_name

The name of the VOD source for alternateMedia.

audience_media[].audience

The Audience defined in AudienceMedia.

clip_range

The clip range configuration settings.

STRUCT(
    "end_offset_millis" BIGINT,
    "start_offset_millis" BIGINT
)
Show child fields
clip_range.end_offset_millis

The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.

clip_range.start_offset_millis

The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.

creation_time

The timestamp of when the program was created.

TIMESTAMP_S
duration_millis

The duration of the live program in milliseconds.

BIGINT
live_source_name

The name of the LiveSource for this Program.

VARCHAR
scheduled_start_time

The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.

TIMESTAMP_S
source_location_name

The source location name.

VARCHAR
vod_source_name

The name that's used to refer to a VOD source.

VARCHAR