Schedule Catalog

Container which can hold multiple schedules.

Property	Detail
Parent Elements	`DataCollections`
Data Type	ScheduleCatalogType
Child Elements	Description
`Delete`	A management verb for removing schedules from the catalog.
`Schedule`	Represents a block of airings.
Attributes	Description
`id`	The identifier for the schedule catalog. The default value is `DEFAULT_SCHEDULE_CATALOG`. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long
`action`	Indicates which action to take for a catalog submission. Default value is `upsert`. Valid values: `upsert`, `replace`. Data Type: CatalogActionType

<ScheduleCatalog id="SCHEDULE_MAY2025_WEEK1" 
                 version="123">
    
    <!-- Linear Schedule Example - Regular Broadcast Day -->
    <Schedule id="KIRO_20250501"
             version="1682924400"
             date="2025-05-01"
             territories="US"
             stationRef="STATION_CAT_1:KIRO"
             stationCatalogRef="STATION_CAT_1"
             programCatalogRef="PROGRAM_CAT_1">
        
        <!-- Early Morning News -->
        <Airing id="KIRO_0500_NEWS"
                startTime="2025-05-01T05:00:00Z"
                duration="PT2H"
                programRef="MORNING_NEWS_ID">
            <Live/>
            <New/>
            <AudioLanguages>
                <AudioLanguage language="en" default="true" original="true"/>
                <AudioLanguage language="es">español</AudioLanguage>
            </AudioLanguages>
            <SubtitleLanguages>
                <SubtitleLanguage language="en" closed="true" default="true"/>
            </SubtitleLanguages>
        </Airing>

        <!-- Syndicated Morning Show -->
        <Airing id="KIRO_0700_MORNING"
                startTime="2025-05-01T07:00:00Z"
                duration="PT1H"
                programRef="MORNING_SHOW_ID">
            <Edited cropped="true" content="true"/>
            <AudioLanguages>
                <AudioLanguage language="en" default="true"/>
            </AudioLanguages>
            <SubtitleLanguages>
                <SubtitleLanguage language="en" closed="true" default="true"/>
            </SubtitleLanguages>
            <GeoRestrictions>
                <GeoRestriction policyRef="WEST_COAST_POSTAL_CODES"/>
            </GeoRestrictions>
        </Airing>

        <!-- Additional day programming... -->
    </Schedule>

   <!-- Super Bowl Special Event Schedule -->
    <Schedule id="NFL_SUPERBOWL_LIX_20250202"
             version="1706860800"
             territories="US"
             programCatalogRef="PROGRAM_CAT_1">
        
        <!-- Super Bowl Pre-game -->
        <Airing id="SB_PREGAME_SHOW"
                startTime="2025-02-02T20:00:00Z"
                duration="PT4H"
                programRef="SUPERBOWL_LIX_PREGAME">
            <Live/>
            <New/>
            <AudioLanguages>
                <AudioLanguage language="en" default="true" original="true"/>
                <AudioLanguage language="es">español</AudioLanguage>
            </AudioLanguages>
            <SubtitleLanguages>
                <SubtitleLanguage language="en" closed="true" default="true"/>
                <SubtitleLanguage language="es" closed="true"/>
            </SubtitleLanguages>
        </Airing>

        <!-- Super Bowl Main Event -->
        <Airing id="SB_GAME"
                startTime="2025-02-03T00:00:00Z"
                duration="PT4H"
                programRef="PROGRAM_CAT_1:SUPERBOWL_LIX_GAME">
            <Live/>
            <New/>
            <AudioLanguages>
                <AudioLanguage language="en" default="true" original="true"/>
                <AudioLanguage language="es">español</AudioLanguage>
            </AudioLanguages>
            <SubtitleLanguages>
                <SubtitleLanguage language="en" closed="true" default="true"/>
                <SubtitleLanguage language="es" closed="true"/>
            </SubtitleLanguages>
        </Airing>

        <!-- Super Bowl Post-game -->
        <Airing id="SB_POSTGAME_SHOW"
                startTime="2025-02-03T04:00:00Z"
                duration="PT2H"
                programRef="SUPERBOWL_LIX_POSTGAME">
            <Live/>
            <New/>
            <AudioLanguages>
                <AudioLanguage language="en" default="true" original="true"/>
                <AudioLanguage language="es">español</AudioLanguage>
            </AudioLanguages>
        </Airing>
    </Schedule>
    
    <!-- NFL 2025 Season - Week 1 Schedule -->
    <Schedule id="NFL_2025_WEEK1"
             version="1725148800"
             territories="US"
             programCatalogRef="PROGRAM_CAT_1">
        
        <!-- Thursday Night Kickoff Game -->
        <Airing id="NFL_2025_W1_THU"
                startTime="2025-09-04T00:20:00Z"
                duration="PT3H30M"
                programRef="NFL_KC_BUF_W1">
            <Live/>
        </Airing>

        <!-- Sunday Games -->
        <Airing id="NFL_2025_W1_SUN_1"
                startTime="2025-09-07T17:00:00Z"
                duration="PT3H30M"
                programRef="NFL_SEA_LAR_W1">
            <Live/>
            <GeoRestrictions>
                <GeoRestriction policyRef="NFL_BROADCAST_RULES"/>
                <GeoRestriction policyRef="SEATTLE_LA_MARKETS"/>
            </GeoRestrictions>
        </Airing>

        <Airing id="NFL_2025_W1_SUN_2"
                startTime="2025-09-07T17:00:00Z"
                duration="PT3H30M"
                programRef="NFL_NE_MIA_W1">
            <Live/>
        </Airing>

        <Airing id="NFL_2025_W1_SUN_3"
                startTime="2025-09-07T17:00:00Z"
                duration="PT3H30M"
                programRef="NFL_GB_CHI_W1">
            <Live/>
        </Airing>

        <!-- Additional Week 1 games ... -->
    </Schedule>
</ScheduleCatalog>

↑ Back to top

A management verb that enables programmatic removal of an item from the catalog. When the ingestion system processes a Delete element, it removes the item with the specified ID from the system.

Property	Detail
Parent Elements	`DataCollections` `ProgramCatalog` `ScheduleCatalog` `OfferCatalog` `StationCatalog` `LineupCatalog` `PolicyCatalog`
Data Type	DeleteType
Attributes	Description
`id` Required	The unique identifier of the entity to delete. Data Type: ID
`version`	Version of the entity to delete. Must be greater than or equal to the current entity version. Default value is `1`. Data Type: long

↑ Back to top

Represents a block of airings. All schedule dates and times must be in UTC format. Each schedule requires a unique ID and version number, where submitting a new schedule with an existing ID completely replaces the previous version.

Use schedule elements to define linear schedules. The schedule element must provide continuous non-overlapping station programming for the full 24-hour period. Suggested ID Convention: "STATION_YYYYMMDD". Required attributes: date, stationRef.

Property	Detail
Parent Elements	`ScheduleCatalog`
Data Type	ScheduleType
Child Elements	Description
`Airing` Required	Airing entities associate programs with specific time slots.
Attributes	Description
`id` Required	The identifier for the schedule. Data Type: ID
`version`	The version for the schedule. Default value is `1`. Data Type: long
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`date` Required	Date for the 24-hour non-overlapping station schedule. Data Type: DateType
`stationRef` Required	Reference to the station used for the schedule. Data Type: ID
`stationCatalogRef`	Reference to the station catalog that contains the station used for the schedule. The default value is `DEFAULT_STATION_CATALOG`. Data Type: ID
`programCatalogRef`	Reference to the program catalog that contains the programs used for the schedule. The default value is `DEFAULT_PROGRAM_CATALOG`. Data Type: ID

↑ Back to top

Airing entities associate programs with time slots. You must define the content for the schedule by referring to an existing program entry using a ref attribute to your identifier. You can define ratings in the schedule, but these are overrides for a single schedule entry and don't affect the content's ratings.

Property	Detail
Parent Elements	`Schedule` `ProgramAiringOffer`
Data Type	AiringType
Child Elements	Description
`Live`	Indicates that this program is being broadcast in real time. This is an empty element.
`New`	Indicates that the program is being aired for the first time. This is an empty element.
`Edited`	Indicates if the airing is altered from its original version.
`Ratings`	List of the `Rating` elements.
`AudioLanguages`	Contains available audio language options.
`SubtitleLanguages`	Contains available subtitle language options.
`Tags`	List of the `Tag` elements.
`GeoRestrictions`	List of policy references, such as region restrictions, for the schedule.
Attributes	Description
`id` Required	The identifier for the airing entity. Data Type: ID
`startTime` Required	Start time for the airing. Data Type: DateTimeType
`duration` Required	Duration of the airing. Data Type: DurationType
`programRef` Required	A reference to the program that is associated with the airing. Data Type: ID
`programCatalogRef`	Reference to the program catalog that contains the program aired. Overrides the program catalog provided for schedule. The default value is `DEFAULT_PROGRAM_CATALOG`. Data Type: ID

↑ Back to top

Indicates that this program is being broadcast in real time. This is an empty element.

Property	Detail
Parent Elements	`Airing`
Data Type	string

↑ Back to top

Indicates that the program is being aired for the first time. This is an empty element.

Property	Detail
Parent Elements	`Airing`
Data Type	string

↑ Back to top

Indicates if the airing is altered from its original version.

Property	Detail
Parent Elements	`Airing`
Data Type	EditedType
Attributes	Description
`cropped`	Indicates the content is cropped. Cropping edits the aspect ratio, typically for a more appropriate aspect ratio for TV. Data Type: boolean
`content`	Indicates the program is edited for content. Editing for content shortens the broadcast length of the program. This could be done to remove more restrictive scenes or to fit the broadcast window. Data Type: boolean
`language`	Indicates the program is edited for language. Editing the language typically doesn't affect the length of the program, but dubs the audio or mutes profanity to achieve a less restrictive rating. Data Type: boolean

↑ Back to top

List of the Rating elements.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `Airing` `Station`
Data Type	RatingList
Child Elements	Description
`Rating` Required	Provides certification for age-appropriate viewer restrictions.

↑ Back to top

Provides certification for age-appropriate viewer restrictions. The adultProduct and notRated flags are boolean attributes that indicate that the program has applicable age restriction business rules applied. Rating values exist for actual programs and for airings. The Rating element includes content descriptors, which have a code and a corresponding description. Descriptions are from the governing body of the rating system and use the primary language of the rating body. Content descriptors are legally required in some territories. Supported ratings and descriptors are listed in the Video Central documentation. Use the Global Ratings specification.

Catalog-specific conditions:

Schedule catalog: If you specify a rating for an airing, it overwrites the program rating information.
Station catalog: If there is no program or airing rating, the catalog system uses the station rating.

Property	Detail
Parent Elements	`Ratings`
Data Type	RatingType - Structure that contains the certification for age-appropriate viewer restrictions.
Child Elements	Description
`Descriptors`	List of the `Descriptor` elements.
Attributes	Description
`system` Required	Motion picture content rating system. Data Type: string
`certification` Required	Certification value based on a program's suitability for audiences. Data Type: string
`adultProduct`	Indicates whether the program has applicable age restriction business rules applied. Data Type: boolean
`notRated`	Indicates whether the program has applicable age restriction business rules applied. Data Type: boolean
`territories`	Comma-separated list of territory codes, such as `"US,CA"`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`sourceName`	The name of the source. If not provided, catalog system uses the data submitter as the source of the data element. Data Type: SourceNameType
`sourceDate`	The date that the information was retrieved. If not provided, the system uses the data submission date. Data Type: SourceDateType
`sourceId`	An identifier (internal or external) or URI for the data record that provided the value. If not provided, it defaults to the ID of the containing entity. Data Type: SourceIdType

↑ Back to top

List of the Descriptor elements.

Property	Detail
Parent Elements	`Rating`
Data Type	DescriptorList
Child Elements	Description
`Descriptor` Required	The `Descriptor` element provides content descriptors. A content descriptor includes a code and a corresponding description.

↑ Back to top

The Descriptor element provides content descriptors. A content descriptor includes a code and a corresponding description. Descriptions are from the governing body of the rating system and use the primary language of the rating body. Content descriptors are legally required in some territories. Supported ratings and descriptors are listed in the Video Central documentation. Use the Global Ratings specification.

Property	Detail
Parent Elements	`Descriptors`
Data Type	DescriptorType
Attributes	Description
`code`	Two letter code for the descriptor. Data Type: string

↑ Back to top

Contains available audio language options.

Property	Detail
Parent Elements	`Airing` `ProgramOffer` `StationOffer` `Station`
Data Type	AudioLanguageList
Child Elements	Description
`AudioLanguage` Required	The audio language of the program or station.

↑ Back to top

The audio language of the program or station.

Property	Detail
Parent Elements	`AudioLanguages`
Data Type	AudioLanguageType - A string that represents the audio language for a program.
Attributes	Description
`language` Required	Contains language data for this item. Data Type: LanguageType
`default`	Indicates the default audio language. Data Type: boolean
`original`	Indicates whether this is the original language of the content. Use true for original language and false for dubbed content. Data Type: boolean

↑ Back to top

Contains available subtitle language options.

Property	Detail
Parent Elements	`Airing` `ProgramOffer` `StationOffer` `Station`
Data Type	SubtitleLanguageList
Child Elements	Description
`SubtitleLanguage` Required	The subtitle language of the program or station.

↑ Back to top

The subtitle language of the program or station.

Property	Detail
Parent Elements	`SubtitleLanguages`
Data Type	SubtitleLanguageType - A string that represents the subtitle language for a program.
Attributes	Description
`language` Required	Contains language data for this item. Data Type: LanguageType
`closed`	True for closed captions; false or omitted for burned-in subtitles. Data Type: boolean
`default`	Indicates the default subtitle language in a list of `SubtitleLanguage` elements. Data Type: boolean

↑ Back to top

List of the Tag elements.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `OffAir` `ToBeAnnounced` `Airing` `ProgramOffer` `StationOffer` `ProgramAiringOffer` `Station` `EntitlementPolicy`
Data Type	TagList
Child Elements	Description
`Tag` Required	Additional metadata used to categorize, promote, or otherwise apply custom processing to a program or airing.

↑ Back to top

Additional metadata used to categorize, promote, or otherwise apply custom processing to a program or airing. The scheme, key, and valid formats for those values must be negotiated between you and Amazon. This feature serves to enable non-standard or emerging use cases until dedicated entities or attributes are added and versioned into the specification.

Property	Detail
Parent Elements	`Tags`
Data Type	TagType -A string with the addition of required `scheme`, and `key` attributes.
Attributes	Description
`scheme` Required	Universally unique namespace for key-value pairs. Data Type: string
`key` Required	The key of the key-value pair. The value is the element value. Data Type: string

↑ Back to top

List of geographic restrictions to access the content.

Property	Detail
Parent Elements	`Airing` `ProgramOffer` `StationOffer` `Lineup`
Data Type	GeoRestrictionList
Child Elements	Description
`GeoRestriction` Required	GeoRestriction details to access the content.

↑ Back to top

GeoRestriction details to access the content.

Property	Detail
Parent Elements	`GeoRestrictions`
Data Type	ID
Attributes	Description
`policyRef` Required	Reference to the policy with geographic restriction details. Data Type: string
`policyCatalogRef`	Reference to the policy catalog that contains the referenced policy. The default value is `DEFAULT_POLICY_CATALOG`. Data Type: ID

↑ Back to top

Schedule Catalog

ScheduleCatalog

Delete

Schedule

Airing

Live

New

Edited

Ratings

Rating

Descriptors

Descriptor

AudioLanguages

AudioLanguage

SubtitleLanguages

SubtitleLanguage

Tags

Tag

GeoRestrictions

GeoRestriction