Offer Catalog

Contains offer-related entities that define how users can access and discover content.

Property	Detail
Parent Elements	`DataCollections`
Data Type	OfferCatalogType
Child Elements	Description
`Delete`	A management verb for removing offers from the catalog.
`ProgramOffers`	Defines access details for a specific program.
`ProgramAiringOffers`	Defines access details for specific airings of a program.
`StationOffers`	Defines access details for a specific station.
`ProgramDiscovery`	Defines program discovery attributes like rankings, ratings, and promotional badges.
Attributes	Description
`id`	The identifier for the offer catalog. The default value is `DEFAULT_OFFER_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

↑ 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

List of program offers.

Property	Detail
Parent Elements	`OfferCatalog`
Data Type	ProgramOffersType
Child Elements	Description
`ProgramOffer` Required	Defines access details for the program.
Attributes	Description
`id` Required	The identifier for the program offer. Data Type: ID
`version`	The version for the program offer. Default value is `1`. Data Type: long
`programRef` Required	Reference identifier that links this offer to a specific program. Data Type: ID
`programCatalogRef`	Reference to the catalog that contains the offered program. The default value is `DEFAULT_PROGRAM_CATALOG`. Data Type: ID

↑ Back to top

List of airing offers.

Property	Detail
Parent Elements	`OfferCatalog`
Data Type	ProgramAiringOffersType
Child Elements	Description
`ProgramAiringOffer` Required	Defines access details for the airing.
Attributes	Description
`id` Required	The identifier for the airing offer. Data Type: ID
`version`	The version for the airing offer. Default value is `1`. Data Type: long
`programRef` Required	Reference identifier that links this offer to a specific program or program airing. Data Type: ID
`programCatalogRef`	Reference to the catalog that contains the offered program or program airing. The default value is `DEFAULT_PROGRAM_CATALOG`. Data Type: ID

↑ Back to top

List of station offers.

Property	Detail
Parent Elements	`OfferCatalog`
Data Type	StationOffersType
Child Elements	Description
`StationOffer` Required	Defines access details for the station.
Attributes	Description
`id` Required	The identifier for the station offer. Data Type: ID
`version`	The version for the station offer. Data Type: long
`stationRef` Required	Reference identifier that links this offer to a specific station. Data Type: ID
`stationCatalogRef`	Reference to the catalog that contains the offered station. The default value is `DEFAULT_STATION_CATALOG`. Data Type: ID

↑ Back to top

Defines program discovery attributes like rankings, ratings, and promotional badges.

Property	Detail
Parent Elements	`OfferCatalog`
Data Type	ProgramDiscoveryType
Child Elements	Description
`Ranks`	List of the `Rank` elements.
`CustomerRatings`	List of the `CustomerRating` elements.
`Badges`	List of the `Badge` elements.
Attributes	Description
`start`	Discovery availability start time. Data Type: DateTimeType
`end`	Discovery availability end time. Data Type: DateTimeType
`territories`	Countries where the program or station can be discovered. Comma-separated list of territory codes, such as `"US,CA"`. To indicate that the value applies to all territories, use `GLOBAL`. Data Type: TerritoriesType
`programRef` Required	Reference identifier that links this offer to a specific program or program airing. Data Type: ID
`programCatalogRef`	Reference to the catalog that contains the offered program or program airing. The default value is `DEFAULT_PROGRAM_CATALOG`. Data Type: ID

↑ Back to top

Defines access details for the program.

Property	Detail
Parent Elements	`ProgramOffers`
Data Type	ProgramOfferType
Child Elements	Description
`Entitlements` Required	List of entitlements for content access.
`AudioLanguages`	Contains available audio language options.
`SubtitleLanguages`	Contains available subtitle language options.
`VideoResolutions`	Contains available video resolution options.
`VideoAttributes`	Contains available video attribute options.
`AudioAttributes`	Contains available audio attribute options.
`Ads`	Indicates ads in the program. This is an empty element.
`Tags`	List of the `Tag` elements.
`GeoRestrictions`	List of geographic restrictions to access the content.
`LaunchTargets`	List of the `LaunchTarget` elements.
Attributes	Description
`start`	Subscription availability start time. Data Type: DateTimeType
`end`	Subscription availability end time. Data Type: DateTimeType
`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

List of entitlements for content access.

Property	Detail
Parent Elements	`ProgramOffer` `ProgramAiringOffer` `StationOffer`
Data Type	EntitlementListType
Child Elements	Description
`Entitlement` Required	Entitlement details to access the content. Specify either a `type` or a `policyRef` attribute, not both: Use `type` for simple standard entitlements (`free`, `subscription`) and when no additional policy configuration is needed. Use `policyRef` when sharing user entitlements with Amazon using Subscription Entitlement API integration.

↑ Back to top

Entitlement details to access the content. Specify either a type or a policyRef attribute, not both:

Use type for simple standard entitlements (free, subscription) and when no additional policy configuration is needed.
Use policyRef when sharing user entitlements with Amazon using Subscription Entitlement API integration.

Property	Detail
Parent Elements	`Entitlements`
Data Type	EntitlementType
Attributes	Description
`type` Required	One of `type` or `policyRef` is required. Type of entitlement. Valid values: `free` – Content is available for free. `subscription` – Content requires a subscription or an add-on subscription. For example, premium tier content or a sports add-on. Data Type: EntitlementTypeEnumType
`policyRef` Required	One of `type` or `policyRef` is required. Reference to the policy with entitlement 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

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

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

Contains available video attribute options.

Property	Detail
Parent Elements	`ProgramOffer` `ProgramAiringOffer` `StationOffer`
Data Type	VideoAttributeList
Child Elements	Description
`VideoAttribute` Required	Video attributes of the program that are included as part of the offer.

↑ Back to top

Video attributes of the program that are included as part of the offer. Examples include SDR, HDR10+, and Dolby Vision.

Property	Detail
Parent Elements	`VideoAttributes`
Data Type	A string.

↑ Back to top

Contains available audio attribute options.

Property	Detail
Parent Elements	`ProgramOffer` `ProgramAiringOffer` `StationOffer`
Data Type	AudioAttributeList
Child Elements	Description
`AudioAttribute` Required	Audio attributes of the program.

↑ Back to top

Audio attributes of the program. Examples include Dolby Digital 5.1, DD 5.1, DD7.1, DD7.1+, and Dolby Atmos.

Property	Detail
Parent Elements	`AudioAttributes`
Data Type	A string.

↑ Back to top

Indicates ads in the program. This is an empty element.

Property	Detail
Parent Elements	`ProgramOffer` `ProgramAiringOffer` `StationOffer`
Data Type	AdsType - Empty element that indicates whether dynamic ads are inserted during content playback.

↑ 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

List of the LaunchTarget elements.

Property	Detail
Parent Elements	`ProgramOffer` `ProgramAiringOffer` `StationOffer`
Data Type	LaunchTargetList
Child Elements	Description
`LaunchTarget` Required	Specifies the information needed to launch a given program, airing, or station on various devices, services, and presentations.

↑ Back to top

Specifies the information needed to launch a given program, airing, or station on various devices, services, and presentations.

Property	Detail
Parent Elements	`LaunchTargets`
Data Type	LaunchTargetType - A string that specifies the information needed to launch a given program, airing, or station.
Attributes	Description
`type`	Enumeration of valid launch target types. Valid values: `WEB`, `FIRETV`. Data Type: LaunchTargetTypeEnum

↑ Back to top

Defines access details for the airing.

Property	Detail
Parent Elements	`ProgramAiringOffers`
Data Type	ProgramAiringOfferType
Child Elements	Description
`Airing` Required	Program airing details.
`Entitlements` Required	List of entitlements for content access.
`VideoResolutions`	Contains available video resolution options.
`VideoAttributes`	Contains available video attribute options.
`AudioAttributes`	Contains available audio attribute options.
`Ads`	Indicates ads in the program. This is an empty element.
`Tags`	List of the `Tag` elements.
`LaunchTargets`	List of the `LaunchTarget` elements.
Attributes	Description
`start`	Subscription availability start time. Data Type: DateTimeType
`end`	Subscription availability end time. Data Type: DateTimeType
`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
`scheduleCatalogRef`	Reference to the catalog that contains the airing. The default value is `DEFAULT_SCHEDULE_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

Defines access details for the station.

Property	Detail
Parent Elements	`StationOffers`
Data Type	StationOfferType
Child Elements	Description
`Entitlements` Required	List of entitlements for content access.
`AudioLanguages`	Contains available audio language options.
`SubtitleLanguages`	Contains available subtitle language options.
`VideoResolutions`	Contains available video resolution options.
`VideoAttributes`	Contains available video attribute options.
`AudioAttributes`	Contains available audio attribute options.
`Ads`	Indicates ads in the program. This is an empty element.
`Tags`	List of the `Tag` elements.
`GeoRestrictions`	List of geographic restrictions to access the content.
`LaunchTargets`	List of the `LaunchTarget` elements.
`StationTransport`	Station transport details.
Attributes	Description
`start`	Subscription availability start time. Data Type: DateTimeType
`end`	Subscription availability end time. Data Type: DateTimeType
`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

Specifies the information needed to launch a given station title on various devices, services, and presentations.

Property	Detail
Parent Elements	`StationOffer` `Channel`
Data Type	StationTransportType - A string that specifies the information needed to launch a given station title.
Attributes	Description
`channelnum` Required	The channel number as displayed to viewers. Can include decimals and subchannels, such as "2.1". Data Type: string
`subsystem`	The delivery system type. Valid values: `DVB-T`, `DVB-S`, `DVB-C`, `ISDB-T`, `ISDB-S`, `ISDB-C`, `ATSC`, `ATSC3`, `DTMB`. Data Type: string
`onid`	Original Network ID. Unique identifier for the network. Data Type: string
`tsid`	Transport Stream ID. Identifies the multiplex stream. Data Type: string
`sid`	Service ID. Identifies the specific service within the transport stream. Data Type: string

↑ Back to top

List of the Rank elements.

Property	Detail
Parent Elements	`ProgramDiscovery`
Data Type	RankList
Child Elements	Description
`Rank` Required	Rank is a score relative to every other program in the catalog.

↑ Back to top

Rank is a score relative to every other program in the catalog. Lower value means that the program is ranked higher than other items with a higher value. The highest rank an item can have is 1. It is acceptable for multiple items to have the same rank.

Property	Detail
Parent Elements	`Ranks`
Data Type	RankType - A structure that contains the ranking of the program.
Attributes	Description
`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
`value`	Data Type: nonNegativeInteger

↑ Back to top

List of the CustomerRating elements.

Property	Detail
Parent Elements	`ProgramDiscovery`
Data Type	CustomerRatingList
Child Elements	Description
`CustomerRating` Required	Customer ratings contain crowd-sourced or professionally reviewed relative ratings of the title. The source, score, score basis (max score), and cohort size for the system are required as is the date that the data was retrieved from the source.

↑ Back to top

Customer ratings contain crowd-sourced or professionally reviewed relative ratings of the title. The source, score, score basis (max score), and cohort size for the system are required as is the date that the data was retrieved from the source.

Property	Detail
Parent Elements	`CustomerRatings`
Data Type	CustomerRating - Structure that contains crowd-sourced or professionally reviewed ratings of the title.
Attributes	Description
`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
`score`	The actual rating value or score given to the content. Data Type: decimal
`maxScore`	The maximum possible score in the rating system. Data Type: decimal
`numVotes`	The total number of votes or ratings given. Data Type: unsignedInt
`sourceName`	Name of the organization or system providing the ratings. Data Type: string
`sourceDate`	Date when the rating data was collected or last updated. Data Type: DateType

↑ Back to top

List of the Badge elements.

Property	Detail
Parent Elements	`ProgramDiscovery`
Data Type	BadgeList
Child Elements	Description
`Badge` Required	A badge contains an enumerated value that allows program titles to provide additional information to customers regarding the origin or availability of the title. Localize badge text or iconography to the customer language and territory.

↑ Back to top

A badge contains an enumerated value that allows program titles to provide additional information to customers regarding the origin or availability of the title. Localize badge text or iconography to the customer language and territory.

Property	Detail
Parent Elements	`Badges`
Data Type	BadgeType - Structure that provides additional information to customers regarding the origin or availability of the title.
Attributes	Description
`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
`scheme`	The badge namespace. Supported scheme is `ember_badge`. Valid values for `ember_badge`: `original` – Produced or exclusively licensed. `new` – Recently added content to the catalog. `premiere` – First-time release or debut of a series, season, or movie. `finale` – Final episode of a series or season. `coming_soon` – Content that will be available in the near future. `leaving_soon` – Content that will be removed from the catalog soon. Check with your Amazon representative about the specific time windows that define time-sensitive badges, such as `new`, `coming_soon`, and `leaving_soon`. Data Type: string

↑ Back to top

OfferCatalog

Delete

ProgramOffers

ProgramAiringOffers

StationOffers

ProgramDiscovery

ProgramOffer

Entitlements

Entitlement

AudioLanguages

AudioLanguage

SubtitleLanguages

SubtitleLanguage

VideoResolutions

VideoResolution

VideoAttributes

VideoAttribute

AudioAttributes

AudioAttribute

Ads

Tags

Tag

GeoRestrictions

GeoRestriction

LaunchTargets

LaunchTarget

ProgramAiringOffer

Airing

Live

New

Edited

Ratings

Rating

Descriptors

Descriptor

StationOffer

StationTransport

Ranks

Rank

CustomerRatings

CustomerRating

Badges

Badge