Console

Settings

Sign out

Notifications

Alexa

Amazon Appstore

Ring

AWS

Documentation

Support

My Cases

Console

Fire OS Developer Docs

Home

Develop

Test

Publish

Monetize

Engage users

Device specifications

Resources

Policy Catalog

A policy catalog defines reusable rules for geographic restrictions and entitlement tiers that other catalogs can reference. The following sections describe the elements contained in the PolicyCatalog.

Expand all element examples

PolicyCatalog

Policies define availability rules and restrictions for content distribution.

Property	Detail
Parent Elements	`DataCollections`
Data Type	PolicyCatalogType
Child Elements	Description
`Delete`	Management verb for removing policies from the policy catalog.
`RegionPolicy`	Defines regional availability rules and restrictions.
`EntitlementPolicy`	Defines entitlement details to access content.
Attributes	Description
`id`	Unique identifier for the policy catalog. The default value is `DEFAULT_POLICY_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

Delete

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

RegionPolicy

Defines geographical availability rules for specific regions and postal codes.

Property	Detail
Parent Elements	`PolicyCatalog`
Data Type	RegionPolicyType
Child Elements	Description
`Region`	Defines specific geographical areas using territories and postal codes.
Attributes	Description
`id` Required	Unique identifier for this regional policy. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long

↑ Back to top

Region

Defines specific geographical areas using territories and postal codes.

Property	Detail
Parent Elements	`RegionPolicy`
Data Type	RegionType
Child Elements	Description
`PostalCode`	Specific postal codes for the region.
Attributes	Description
`filter` Required	Postal code filters for the region. Valid values: `allow_all` – Allows all postal codes in the region regardless of the `PostalCode` list. `allow_only` – Only allows the postal codes explicitly listed in the `PostalCode` elements. `block_only` – Blocks only the postal codes listed in the `PostalCode` elements. Data Type: PolicyFilterType
`territories` Required	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

PostalCode

Defines a specific postal code. In a region policy, postal code is used for content availability control. In venue address element, it is used as postal code for the address.

Property	Detail
Parent Elements	`Address` `Region`
Data Type	string

↑ Back to top

EntitlementPolicy

Defines entitlement details for the catalog tier.

Property	Detail
Parent Elements	`PolicyCatalog`
Data Type	EntitlementPolicyType
Child Elements	Description
`EntitlementId` Required	The entitlement ID sent to Amazon Subscription Entitlement API by the app.
`ShortDisplayNames`	Short display name for the entitlement. For example, "Sports" shown below the buy box.
`LongDisplayNames`	Long display name for the entitlement. For example, "Sports AddOn" shown during the purchase flow.
`Tags`	List of the `Tag` elements.
Attributes	Description
`id` Required	Unique identifier for this entitlement policy. Data Type: ID
`version`	Integer that increases with each revision. Used for version control. Default value is `1`. Data Type: long
`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
`defaultForSignedInUser`	This catalog tier is available to any user who signs in to the app. Data Type: boolean

↑ Back to top

EntitlementId

The entitlement ID sent to Amazon Subscription Entitlement API by the app.

Property	Detail
Parent Elements	`EntitlementPolicy`
Data Type	string

↑ Back to top

ShortDisplayNames

List of localized short display names for the entitlement.

Property	Detail
Parent Elements	`EntitlementPolicy`
Data Type	ShortDisplayNameList
Child Elements	Description
`ShortDisplayName` Required	A localized string for the entitlement name.

↑ Back to top

ShortDisplayName

Short display name for the entitlement. For example, the text shown below the buy box. Limited to 8 characters.

Property	Detail
Parent Elements	`ShortDisplayNames`
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

↑ Back to top

LongDisplayNames

List of localized long display names for the entitlement.

Property	Detail
Parent Elements	`EntitlementPolicy`
Data Type	LongDisplayNameList
Child Elements	Description
`LongDisplayName` Required	A localized string for the entitlement name.

↑ Back to top

LongDisplayName

Long display name for the entitlement. For example, the text shown in the purchase flow.

Property	Detail
Parent Elements	`LongDisplayNames`
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

↑ Back to top

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

Tag

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

Last updated: May 27, 2026

Policy Catalog

PolicyCatalog

Delete

RegionPolicy

Region

PostalCode

EntitlementPolicy

EntitlementId

ShortDisplayNames

ShortDisplayName

LongDisplayNames

LongDisplayName

Tags

Tag