Station Catalog

Defines the customer-facing and management attributes of a station or channel.

Property	Detail
Parent Elements	`DataCollections`
Data Type	StationCatalogType
Child Elements	Description
`Delete`	A management verb for removing stations from the catalog.
`Station`	Contains station details such as name, image, call signs, and affiliate information.
`ExternalStation`	A station entity that references an external metadata system, with the ability to override certain fields.
Attributes	Description
`id`	The identifier for the station catalog. The default value is `DEFAULT_STATION_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

<StationCatalog id="LOCAL_STA_123" 
                version="1">
    
    <!-- Local Network Affiliate -->
    <Station id="STA_KIRO_HD" 
             version="1"
             name="CBS_NEWS_SEA"
             territories="US">
        <Titles>
            <Title language="en" territories="US" default="true">CBS News Seattle</Title>
        </Titles>
        <Images>
            <Image category="logo"
                   language="en"
                   aspectRatio="16:9"
                   mimeType="image/png"
                   resolution="HD"
                   version="1">
                https://images.example.com/logos/cbs_seattle.png
            </Image>
            
            <Image category="cover"
               language="en"
               aspectRatio="16:9"
               mimeType="image/jpeg"
               resolution="HD"
               version="1">
            https://images.example.com/covers/cbs_seattle_cover.jpg
        </Image>
        </Images>
        <ExternalIds>
            <ExternalId scheme="tms">TMS123456789</ExternalId>
        </ExternalIds>
        <CallSign>KIRO7</CallSign>
        <Descriptions>
            <Description language="en" territories="US">
                CBS Network affiliate serving the Seattle-Tacoma area with local news, 
                weather, and CBS network programming.
            </Description>
        </Descriptions>
        <Genres>
            <Genre scheme="ember_genre">ember_genre_news_current_affairs</Genre>
        </Genres>
        <OriginalBroadcastType>Full Power Broadcast</OriginalBroadcastType>
        <AffiliatedNetworks>
            <AffiliatedNetwork>CBS</AffiliatedNetwork>
        </AffiliatedNetworks>
        <VideoResolutions>
            <VideoResolution>HD</VideoResolution>
        </VideoResolutions>
        <Ratings>
            <Rating system="TVPG" 
                   certification="TV-PG" 
                   territories="US"
                   adultProduct="false"
                   notRated="false"/>
        </Ratings>
        <AudioLanguages>
            <AudioLanguage language="en" default="true" original="true">English</AudioLanguage>
            <AudioLanguage language="es">Español</AudioLanguage>
        </AudioLanguages>
        <SubtitleLanguages>
            <SubtitleLanguage language="en" closed="true" default="true"/>
            <SubtitleLanguage language="es" closed="true"/>
        </SubtitleLanguages>
    </Station>
</StationCatalog>

↑ 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

Contains station details such as name, image, call signs, and affiliate information. For details on when to use the Station element and when to use the ExternalStation element, see Linear catalogs on the best practices page.

Property	Detail
Parent Elements	`StationCatalog`
Data Type	StationType
Child Elements	Description
`Titles` Required	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
`Images`	List of the `Image` elements.
`ExternalIds`	Contains external system identifiers. Allows cross-referencing with third-party systems.
`CallSign`	Unique identifier for the broadcasting station.
`Descriptions`	List of the `Description` elements represented by a localized string.
`Genres`	List of genres.
`Tags`	List of the `Tag` elements.
`StationCategories`	Contains station category entities.
`OriginalBroadcastType`	The type of broadcast the station provides.
`AffiliatedNetworks`	List of affiliated networks.
`VideoResolutions`	Contains available video resolution options.
`Ratings`	List of the `Rating` elements.
`AudioLanguages`	Contains available audio language options.
`SubtitleLanguages`	Contains available subtitle language options.
Attributes	Description
`id` Required	The main identifier for a station entity. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long
`name` Required	The English name for the station that can be used for operations. Data Type: string
`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

↑ Back to top

A station entity that references an external metadata system, with the ability to override certain fields. Supported external ID schemes for external stations are tms and gvd. For details on when to use the Station element and when to use the ExternalStation element, see Linear catalogs on the best practices page.

Property	Detail
Parent Elements	`StationCatalog`
Data Type	ExternalStationType
Child Elements	Description
`ExternalId` Required	Links the program or other entity to an external source.
`Titles`	List of `Title` elements. A `Title` element represents the title of the program and the locale to which it applies.
`Images`	List of the `Image` elements.
Attributes	Description
`id` Required	The main identifier for a station entity. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long
`name` Required	The English name for the station that can be used for operations. Data Type: string
`territories`	Countries where the station is available. Comma-separated list of territory codes, such as `"US,CA"`. To indicate that the value applies to all territories, use `GLOBAL`. Data Type: TerritoriesType

↑ Back to top

List of Title elements. A Title element represents the title of the program and the locale to which it applies.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `OffAir` `ToBeAnnounced` `Station` `ExternalStation`
Data Type	TitleList
Child Elements	Description
`Title` Required	A localized string representing the title of the program and the language and territory to which it applies.

↑ Back to top

A localized string representing the title of the program and the language and territory to which it applies. The default attribute specifies the title for the original release territory and is the fallback title for any language that isn't specified. Territory-specific values are used where specified.

Property	Detail
Parent Elements	`Titles` `SeriesTitles`
Data Type	LocalizedStringType
Attributes	Description
`language` Required	Contains language data for this item. Data Type: LanguageType
`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
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean
`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 Image elements.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `OffAir` `ToBeAnnounced` `Station` `ExternalStation`
Data Type	ImageList
Child Elements	Description
`Image` Required	Publicly available URL of the image location.

↑ Back to top

Publicly available URL of the image location. Supports HTTP and HTTPS protocols. Amazon imports these images and provides geographically distributed copies (CDN) of the images to Fire TV clients. Image locations must allow anonymous public access, conform to the Uniform Resource Locators (w3.org) specification, and must not exceed 10 MB in size. To avoid spaces and other invalid characters in the URL, you must perform URL encoding. The URL must be accessible without additional authentication (must not be password protected). HTTPS access must maintain up-to-date and valid certificates.

For image details and examples, see EMBER Images.

Property	Detail
Parent Elements	`Images`
Data Type	ImageType - Structure that provides the image data. The Image URL value is a string with the pattern `(http\|HTTP)(s\|S)://.`.
Attributes	Description
`category`	Type of image. Supported image categories are as follows: `background` – A program image without burned-in title text. No language attribute is required for this image type. Ambient text such as signs in the scenery are not reason for localization. JPEG format. Aspect Ratio: 16:9. `cover` – A program image with burned-in text. Language must match the text in the title. Language is a required attribute for this image category. JPEG format. Aspect Ratio: 16:9. `poster` – Poster art. JPEG format. Aspect Ratio: 2:3. Preferred size: 2000 x 3000 px. Minimum size: 2000 x 3000 px. `episodic` – Used to capture the context of the content. It is usually a still from the TV episode or extra (e.g., trailer) content. JPEG format. Aspect Ratio: 16:9. `title` – The catalog system uses this type of image in place of title text on detail pages. It consists of a 5:2 PNG image of the program title treatment with a transparent background. `logo` – Used for station logos. PNG format. Aspect Ratio: 16:9. Preferred size: 3840 x 2160 px. Minimum size: 1920 x 1080 px. Has background color options: color, white, light, black, gray, dark. Data Type: ImageCategory
`language`	Applies to cover, poster, and title images. The burned-in title on the image must match the title text for the same language/territory combination. Background images do not have text and therefore do not have a language. They can have territories. Data Type: LanguageType
`territories`	Optionally applies to all image types, including background. If present, it indicates that the image is preferred for distribution in the indicated territories. Use ISO 3166-1 alpha-2 format or `GLOBAL`. Default value is `GLOBAL` (indicates that the value applies to all territories). Data Type: TerritoriesType
`aspectRatio`	Expressed in width to height, for example: 16:9, 2:3. Data Type: AspectRatioType
`mimeType`	Background, cover, poster, and episodic images must be JPEG images. Title images (used in place of text titles) and station logos must be transparent PNG images. Data Type: MimeType
`resolution`	Closed enumeration which indicates that the image has enough vertical pixels to use as a background for common screen resolutions. Value valids are `SD`, `HD`, `FullHD`, `4K`, and `8K`. Data Type: ResolutionType
`version`	The version or checksum of the image. This value must change whenever you update the contents of the image without changing the URL. Alternately, you can change the image URL when you update the image. This value is used to optimize the image downloading, encoding, and CDN redistribution process. Data Type: long
`color`	Specifies the color variant of an image, particularly for logos. Data Type: ImageColorType
`default`	If set to true, the catalog system uses this image for languages and territories that do not have an explicit image provided. Apply default to no more than one image per image type. Data Type: boolean
`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

Contains external system identifiers. Allows cross-referencing with third-party systems.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `Studio` `Credit` `Sport` `League` `Season` `Tournament` `Round` `Team` `Player` `Station` `Lineup`
Data Type	ExternalIdList
Child Elements	Description
`ExternalId` Required	Links the program or other entity to an external source.

↑ Back to top

Links the program or other entity to an external source. The scheme attribute identifies the external source, and the value is a valid ID within that namespace. A partial list of program ID schemes includes: imdb, tms, isan, ean, upc, asin, gvd, sportsradar, and stats. Other schemes are used for people and sports entities, such as teams and players. You can also use the ExternalId element to relate sports factual data and sports programs. Use multiple external IDs if they are available.

The ExternalStation element, can have only one ExternalId. Applicable external ID schemes for ExternalStation are tms and gvd.

Property	Detail
Parent Elements	`ExternalIds` `ExternalStation`
Data Type	ExternalIdType - string with a required `scheme` attribute.
Attributes	Description
`scheme` Required	The source of the external ID. Data Type: string

↑ Back to top

Unique identifier for the broadcasting station.

Property	Detail
Parent Elements	`Station`
Data Type	string

↑ Back to top

List of the Description elements represented by a localized string.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `OffAir` `ToBeAnnounced` `Station`
Data Type	DescriptionList
Child Elements	Description
`Description` Required	A localized string that describes the program without giving away the story or detailing its premise.

↑ Back to top

A localized string that describes the program without giving away the story or detailing its premise.

Property	Detail
Parent Elements	`Descriptions`
Data Type	LocalizedStringType
Attributes	Description
`language` Required	Contains language data for this item. Data Type: LanguageType
`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
`default`	The catalog system uses this value as a default when no matching language is available. Can apply to only one value per property for the originating language, or language and territories. Titles, captioned images, descriptions, and summaries follow this convention. Data Type: boolean
`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 genres.

Property	Detail
Parent Elements	`Movie` `TVEpisode` `TVSeason` `TVSeries` `Extra` `SportsEvent` `Event` `Other` `Station`
Data Type	GenreList
Child Elements	Description
`Genre` Required	The genre of the content.

↑ Back to top

The genre of the content. You can use the scheme attribute to indicate a specific genre enum value. The supported scheme value is ember_genre. You can also use free-form text without the scheme attribute. For a list of supported genre codes in the EMBER genre scheme, see EMBER Genres.

Property	Detail
Parent Elements	`Genres`
Data Type	GenreType - A structure that holds the genre namespace and value. Use the scheme attribute to indicate a specific genre enum value or use free-form text without the scheme attribute.
Attributes	Description
`scheme`	The genre namespace. Data Type: string
`language`	Contains language data for this item. Data Type: LanguageType
`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 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

Contains station category entities.

Property	Detail
Parent Elements	`Station`
Data Type	StationCategoryList
Child Elements	Description
`StationCategory` Required	Enumeration for the category of the station.

↑ Back to top

Enumeration for the category of the station. Allows stations with similar content to be grouped together. Some station categories are similar to program genres. For stations with homogeneous content, use genres in addition to a station category. The following table lists valid categories.

Name	Value	Description
Children	`ember_category_children`	Contains programming for young viewers.
Classic TV	`ember_category_classic_tv`	Contains nostalgic programming, typically over 20 years old.
DIY	`ember_category_diy`	Hobbies, crafts, and instructional content. For example, cooking, home improvement, real estate, and painting.
Education	`ember_category_education`	Documentaries, lectures, science, travel, history, and nature.
Entertainment	`ember_category_entertainment`	Programming with broad appeal. Big budget movies, and the business of show business.
Family	`ember_category_family`	Contains programming appropriate for all ages.
Game Shows	`ember_category_game`	Contains unscripted competitions of knowledge, skill, or luck with contestants and prizes.
General Programming	`ember_category_general`	A mix of programming for many audiences. Over the Air (OTA) local broadcast affiliate stations (LBAs) typically fall in this category.
Movies	`ember_category_movies`	Typically contains long-format non-serialized content.
Music	`ember_category_music`	Performances, concerts, music videos, variety shows, and audio only.
News	`ember_category_news`	Local, national, and world news programming.
Seasonal	`ember_category_seasonal`	Holiday-based programming. For example, Valentine's Day, Memorial Day, Thanksgiving, and Diwali.
Sports	`ember_category_sports`	Content focuses on sports and sports-related topics.
TV Shows	`ember_category_shows`	Contains primarily serialized content.
Weather	`ember_category_weather`	Local, national, and international weather reporting.

Property	Detail
Parent Elements	`StationCategories`
Data Type	StationCategoryType - Enum of station category values.
Attributes	Description
`scheme`	Scheme of the station category. Data Type: string

↑ Back to top

The type of broadcast the station provides. Valid values: TV, VOD, Radio, Full Power Broadcast, Low Power Broadcast, Cable Only, Digital Broadcast Network, Network, Satellite, Split, Over the Top. An example of Split is full power broadcast during day and low power broadcast at night.

Property	Detail
Parent Elements	`Station`
Data Type	OriginalBroadcastType

↑ Back to top

List of affiliated networks.

Property	Detail
Parent Elements	`Station`
Data Type	AffiliatedNetworkList
Child Elements	Description
`AffiliatedNetwork` Required	References the affiliated networks of this station if it has any. For example, ABC, CBS.

↑ Back to top

References the affiliated networks of this station if it has any. For example, ABC, CBS.

Property	Detail
Parent Elements	`AffiliatedNetworks`
Data Type	string

↑ Back to top

Contains available video resolution options.

Property	Detail
Parent Elements	`ProgramOffer` `ProgramAiringOffer` `StationOffer` `Station`
Data Type	VideoResolutionList
Child Elements	Description
`VideoResolution` Required	Closed enumeration indicating the video resolution offered. Value valids are `SD`, `HD`, `FullHD`, `4K`, and `8K`.

↑ Back to top

Closed enumeration indicating the video resolution offered. Value valids are SD, HD, FullHD, 4K, and 8K.

Property	Detail
Parent Elements	`VideoResolutions`
Data Type	ResolutionType

↑ 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

Station Catalog

StationCatalog

Delete

Station

ExternalStation

Titles

Title

Images

Image

ExternalIds

ExternalId

CallSign

Descriptions

Description

Genres

Genre

Tags

Tag

StationCategories

StationCategory

OriginalBroadcastType

AffiliatedNetworks

AffiliatedNetwork

VideoResolutions

VideoResolution

Ratings

Rating

Descriptors

Descriptor

AudioLanguages

AudioLanguage

SubtitleLanguages

SubtitleLanguage