Document History - Amazon Interactive Video Service

Document History

User Guide Changes

Change Description Date

Using Amazon EventBridge with Amazon IVS

Updated Limit Breach events: the detail section of the JSON blob uses limit_name for all these events. (Previously only Concurrent Broadcasts showed that and the others showed limit.)

October 28, 2020

Setting Up Private Channels

In the section on "Generate and Sign Playback Tokens,"noted that the exp (expiration) field in JWT payloads is an integer.

October 27, 2020

Amazon IVS Service Quotas

Increased three limits: number of channels, concurrent viewers, and concurrent broadcasts.

October 27, 2020

Web Player 1.1.2 release

Bug-fix release; see the Amazon IVS Release Notes. Version-number references in links and text were updated in the Web Player Guide and Video.js integration Guide.

October 9, 2020

Ingest resolution quotas & event

Added service quotas and EventBridge events for ingest resolution. See Amazon IVS Service Quotas and Using Amazon EventBridge with Amazon IVS.

October 9, 2020

Player 1.1.0 release

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, and Video.js Integration.

In the iOS and Web guides, added a new section on "Known Issues."

On the Amazon IVS documentation landing page, updated the player SDK Reference links to point to the new versions.

In the Amazon IVS Player overview, deleted the Android getSessionId function (which does not yet work).

October 7, 2020

Setting Up Private Channels

Added a new section, "Workflow for Private Channels." In the section on generating and signing tokens, clarified payload field descriptions and example. Corrected examples for listing and getting playback key pairs.

September 21, 2020

Using Amazon EventBridge with Amazon IVS

The channel_name field was added to several events.

September 14, 2020

Embedding Metadata Within a Video Stream

Expanded information on setting up IAM permissions (full procedure and policy), inserting metadata (added a CLI procedure), and consuming metadata (linked to several GitHub demos).

September 14, 2020

Player guides

Clarified which is the most current version of each player (Web, Android, iOS, and Video.js Integration).

September 9, 2020

Getting Started with Amazon IVS

Mentioned that there is a short delay before a new stream can be viewed in the console.

September 9, 2020

Amazon IVS Release Notes

Changed the Player iOS download link to be the same as what is in the Player iOS Guide.

September 9, 2020

Embedding Metadata within a Video Stream

Added link to relevant AWS blog posts.

September 3, 2020

Amazon IVS Player

Expanded the discussion of player features. Clarified that we can guarantee the performance of only the Amazon IVS player (not third-party players).

September 3, 2020

Amazon IVS Service Quotas

Corrected this to indicate that only the channels, concurrent viewers, and concurrent broadcasts quotas can be adjusted.

August 31, 2020

Encoder Configuration

Several changes, including adding Reducing Latency subsection on “Avoid Third-Party Streaming/Forwarding Services” and clarifying why we strongly recommend CBR over VBR.

August 24, 2020

Embedding Metadata within a Video Stream

Updated Web example in Consuming Timed Metadata.

August 24, 2020

Amazon IVS Player: SDK for Android Guide

Updated code example in Install the Library.

August 24, 2020

Using Amazon EventBridge with Amazon IVS

In the section on “Examples: Limit Breach,” updated several field names: limit_name, limit_value, exceeded_by, and limit_unit. These names include underscores (not dashes).

August 19, 2020

Setting Up Private Channels

New User Guide page on new Amazon IVS functionality, supporting private channels. This also affects several existing documents:

Getting Started with Amazon IVS and Logging Amazon IVS API Calls with AWS CloudTrail: Added authorized field to channel.

Security: Several changes including a new section on “Privileged and Unprivileged Access.”

Service Quotas: Added several playback quotas.

Glossary: Added playback key pair.

August 19, 2020

Getting Started with Amazon IVS

Added a new section on AWS Regional Service.

August 11, 2020

Amazon IVS Player: SDK for iOS Guide

Updated links to the reference documentation and framework download to point to the 1.0.6 release. Also updated reference-doc link on the Amazon IVS doc landing page.

August 11, 2020

Using Amazon EventBridge with Amazon IVS

Amazon IVS EventBridge events are now available through the Amazon EventBridge console. See the section on "Creating Amazon EventBridge Rules for Amazon IVS."

August 5, 2020

Amazon IVS Player: Video.js Integration

In the “Setup With NPM” section, updated the link to the Video.js npm package to install, to version 7.6.6.

July 30, 2020

Using Amazon EventBridge with Amazon IVS

For Amazon IVS stream-state and stream-health changes, the event name is provided in a field called event_name (not eventName, as previously documented).

July 29, 2020

Getting Started with Amazon IVS

Changed the instructions for setting up streaming software, to indicate that port 443 is required for Amazon IVS ingest. This also affects the Encoder Configuration document; see the new section on RTMPS and Port 443.

July 27, 2020

Amazon IVS Player: SDK for iOS Guide

Changed the download location of the latest version, in the instructions for installing the framework manually.

July 27, 2020

Embedding Metadata Within a Video Stream

Added Android and iOS examples of consuming timed metadata.

July 24, 2020

New service and User Guide

This is the initial release of Amazon Interactive Video Service (IVS).

July 15, 2020

API Reference Changes

API Change Description Date

Authentication

Added Sigv4 signing info. See "Authentication" in the Welcome section.

October 9, 2020

DeleteChannel & DeleteStreamKey

Changed the HTTP response from 200 to 204. August 26, 2020
DeleteChannel Clarified how to delete a channel that’s live, to avoid an error. August 20, 2020
Playback authorization (for private channels)
  • New PlaybackKeyPair endpoints

  • A new authorized field in the Channel and ChannelSummary objects

  • New objects, PlaybackKeyPair and PlaybackKeyPairSummary

August 19, 2020
New service and API Reference This is the initial release of Amazon Interactive Video Service (IVS). July 15, 2020