Document History - Amazon Interactive Video Service

Document History

User Guide Changes

Change Description Date

Auto-Record to S3

Added a new section, “Playback of Recorded Content from Private Buckets.” Also updated the introduction to this page.

July 28, 2021

Amazon IVS Broadcast SDK (Android and iOS)

Initial release of the broadcast SDK for Android and iOS. See the documentation under “Amazon IVS Broadcast SDK,” a new section of the Amazon IVS documentation landing page.

July 27, 2021

Amazon IVS Player

Updated Desktop Browsers to indicate Amazon IVS Player 1.3.0 support for ultra-low latency on new versions of Safari for macOS.

July 14, 2021

Amazon IVS Service Quotas

For the PutMetadata endpoint, added a limit of 155 TPS per account.

June 29, 2021

ivs.rocks

On the Amazon IVS User Guide landing page, added a link to and brief description of ivs.rocks.

June 25, 2021

Player Browser & Platform Requirements

For the Amazon IVS Player, added links to sites listing the latest versions of supported browsers.

June 25, 2021

Streaming Configuration

In "Channel Types," updated definitions of channel types. For STANDARD channels, resolution can be up to 1080p; for BASIC channels, 480p. (The prior definitions were only in terms of vertical resolution.)

June 17, 2021

Costs

Added a new page on costs.

June 17, 2021

Amazon IVS Player: SDK for Android Guide

Added a new "Permissions" section.

June 17, 2021

Player mobile-browser support

In Mobile Browsers, added information about support for Chrome for iPadOS and Safari for iPadOS.

June 14, 2021

Player SDK size

Added a new "SDK Size" section to the Android and iOS Player SDK guides.

June 11, 2021

Amazon IVS Player: SDK for Web Guide

Added two "Known Issues" when playing content on an iOS mobile browser (with player.getQualities() and player.getLiveLatency() calls).

June 9, 2021

Supported regions and service endpoints

Replace lists of supported regions with a link to the Amazon IVS page in the AWS General Reference, which is updated automatically when support for new regions is added. Changes were made on the Monitoring Amazon IVS with Amazon CloudWatch page.

June 8, 2021

Amazon IVS Player issues

In "Known Issues and Workarounds," for the Web, Android, and iOS Player, asked customers to report all issues to Support. Also added an issue with Android 11 emulators.

June 4, 2021

Android and iOS Player 1.3.3 release

Bug-fix release; see Amazon IVS Release Notes. Also updated version-number references in links and text in the Android Player Guide and iOS Player Guide.

The Amazon IVS documentation landing page always points to the most current versions of the Player SDK References.

June 1, 2021

Setting Up Private Channels

Updated "Generate and Sign Playback Tokens" (information on creating the signature and steps in "Instructions").

May 26, 2021

Global versus regional

Moved "Global Solution, Regional Control" from Getting Started with Amazon IVS to What Is Amazon IVS.

May 21, 2021

Amazon IVS Player: Video.js Integration

In "Sample Code," updated the Cloudflare version number from 7.6.6 to 7.11.4.

May 20, 2021

Android Player 1.3.2 release

Bug-fix release; see Amazon IVS Release Notes. Also updated version-number references in links and text in the Android Player Guide.

May 19, 2021

Amazon IVS Service Quotas

Minor wording changes. Deleted information about maximum number of tags; this was moved to the API Reference.

May 12, 2021

Amazon IVS Release Notes

Added a note for Web Player 1.3.1: the 1.3.0 NPM package exists but does not work.

May 11, 2021

Using Amazon EventBridge with Amazon IVS

Updated stream_id to be a "sanitized" value in all relevant examples.

May 10, 2021

Amazon IVS Player: SDK for Web Guide

Added a known issue and workaround, for player.seekTo() calls when playing recorded content on an iOS mobile browser.

May 10, 2021

Streaming Configuration

Renamed the Encoder Configuration page to Streaming Configuration.

May 6, 2021

Using Amazon EventBridge with Amazon IVS

In "Examples: Recording State Change," added the recording_duration_ms field, changed the example value of the recording_s3_key_prefix field, and changed the value of the recording_status_reason field.

May 5, 2021

Player 1.3 release

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, Video.js Integration, and JW Player Integration. For Android, added mavenCentral() to "Install the Library."

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

In Player 1.3.0 and later, timed metadata is now supported on Chrome and Safari for iOS. This is noted in the Amazon IVS Player overview (table on "Mobile Browsers") and Embedding Metadata within a Video Stream (in "Consuming Metadata").

Also see the Amazon IVS Release Notes for this release.

May 5, 2021

Amazon IVS Service Quotas

Added a new section, "Service Quotas Integration with CloudWatch Usage Metrics."

April 26, 2021

Maximum duration of a stream

In Getting Started with Amazon IVS ("Step 4: Set Up Streaming Software"), added a note about the maximum duration of a stream, 48 hours.

April 23, 2021

IAM policy changes

Made several IAM policy changes:

April 22, 2021

New CloudWatch metrics

Various doc changes for the release of new CloudWatch metrics:

April 13, 2021

Auto-Record to S3

New User Guide page for this new Amazon IVS functionality. This also affects several existing documents:

April 7, 2021

Amazon IVS Streaming Configuration

In "Closed Captioning," clarified that the Player SDKs support only 1 language, not multi-track captions playback.

March 29, 2021

Global versus regional

In What is Amazon IVS, added a new section, "Global Solution, Regional Control," to clarify what is global versus regional. In Getting Started with Amazon IVS, mentioned selecting a region, in the instructions for creating a channel.

March 25, 2021

EventBridge event latency & IDR/Keyframe encoder setting

Clarified the relationship between the IDR/Keyframe video-encoder setting and latency in some EventBridge events. This affects two documents:

March 25, 2021

Monitoring Amazon IVS with Amazon CloudWatch

Clarified how long CloudWatch retains data.

March 18, 2021

Streaming Configuration

In "Audio Settings," changed the supported bitrate to 320 Kpbs (from 192).

March 15, 2021

Required versions of TLS

Clarified requirements for TLS (Transport Layer Security). For API calls, clients must support TLS 1.0 or later, but we recommend TLS 1.2 or later. For streaming/playback, TLS version 1.2 or later is required.

Changes were made in two documents: Streaming Configuration (section on "Stream Ingest: Codecs, RTMPS, and Port 443") and Security (section on "Infrastructure Security").

March 15, 2021

Amazon IVS Player: SDK for Web Guide

Added a known issue with HTML5 and setQuality().

March 15, 2021

Amazon IVS Player: SDK for Web Guide

Added a known issue with captions.

March 11, 2021

Amazon IVS Player

Added sections on "Thread Safety" in SDK for Android Guide and SDK for IOS Guide.

Also, for Android, noted that after the player.release() method is called, the player can no longer be used.

March 2, 2021

Monitoring Amazon IVS with Amazon CloudWatch

Updated the procedure for accessing Amazon IVS metrics using the CloudWatch console: added information on when "IVS" is listed and a screenshot.

February 26, 2021

Security

In “Infrastructure Security,” added a note that Amazon IVS streaming requires TLS 1.2. Also listed a new web page for details on AWS global network security procedures.

February 17, 2021

Amazon IVS Player: JW Player Integration

New User Guide page on the JW Player plug-in for the Amazon IVS player. Also added a JW Player row to the Framework Integrations table in the Web Player Guide.

January 28, 2021

Using Amazon EventBridge with Amazon IVS

Expanded the wording about guarantees for sending events.

January 22, 2021

Using Amazon EventBridge with Amazon IVS

Added: Events are sent on a best-effort basis.

January 13, 2021

Streaming Configuration

Changed the codec audio setting from AAC to AAC (LC).

December 18, 2020

Amazon IVS Service Quotas

In "Resource Quotas," added the maximum number of tags for a resource.

December 17, 2020

Android Player 1.2.1 release

Bug-fix release; see Amazon IVS Release Notes. Also updated version-number references in links and text in the Android Player Guide.

December 16, 2020

Amazon IVS Release Notes

For Amazon IVS Android Player 1.2.0 and 1.1.0, added a known issue which causes the SDK to crash.

December 11, 2020

Getting Started with Amazon IVS

In bullet on playback URLs (in "Step 3: Create a Channel"), added a note that custom domains for playback are not supported.

December 4, 2020

Amazon IVS Release Notes

Deleted download links for iOS Player 1.0.6 and 1.0.0; these versions are deprecated.

Added a "Known Issue" for iOS Player 1.2.0.

December 4, 2020

Player 1.2.0 release

Updated version number and artifact links for the new release, in all player guides: Web, Android, iOS, and Video.js Integration. Added a Known Issue to the Android guide.

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

Also see the updated Amazon IVS Release Notes.

November 23, 2020

Setting Up Private Channels

In the section on "Generate and Sign Playback Tokens," the channel-arn value in the JWT payload is a string.

November 18, 2020

Using Amazon EventBridge with Amazon IVS

Added stream_id field to many events. This is a unique stream identifier assigned each time a channel goes live. For a given channel, each live stream has a new stream_id. Stream IDs allow customers to distinguish different stream sessions on the same channel.

November 12, 2020

Embedding Metadata Within a Video Stream

Added new section on "Viewing Timed Metadata" from the Amazon IVS console.

November 9, 2020

Web Player Guide

Updated the section on "Content Security Policy," especially for hosting assets on a separate page when using Safari.

November 4, 2020

Service Quotas (CCV and CCB limits)

Added notes about the importance of ensuring adequate concurrent-viewer and concurrent-broadcaster limits, especially before large streaming events. See Getting Started with Amazon IVS and Amazon IVS Service Quotas.

November 4, 2020

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

Streaming 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 Streaming 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

PutMetadata TPS limit per account

For the PutMetadata endpoint, added a limit of 155 TPS per account.

June 29, 2021

Channel-type definitions

Updated the definitions of channel types. For STANDARD channels, resolution can be up to 1080p; for BASIC channels, 480p. (The prior definitions were only in terms of vertical resolution.)

June 17, 2021

Supported regions and service endpoints

Replace lists of supported regions with a link to the Amazon IVS page in the AWS General Reference, which is updated automatically when support for new regions is added. Changes were made on the "Welcome" page.

June 8, 2021

Tagging

In "Tagging" (in the "Welcome" section), added the maximum number of tags that can be applied to a resource (50).

May 12, 2021

New CloudWatch Metrics

Changed the definition of viewerCount in the Stream and StreamSummary objects.

April 13, 2021

Auto-Record to S3

  • Added 4 recording-configuration endpoints (Create, Delete, Get, List).

  • Add 4 data types (DestinationConfiguration, RecordingConfiguration, RecordingConfigurationSummary, S3DestinationConfiguration).

  • Added a RecordingConfigurationArn field to the Channel and ChannelSummary objects and channel endpoints.

  • Modified ListChannels to filter by recording-configuration ARN.

April 7, 2021

Authentication & authorization

  • Added an “Authentication versus Authorization” section to clarify the difference between these concepts.

  • Changed the description of the authorized field (in the Channel data type and channel endpoints), to: "Whether the channel is private (enabled for playback authorization)."

March 16, 2021

PutMetadata

Added a minimum length (1) for the metadata request field.

March 4, 2021

Channel latency mode

In Create/UpdateChannel and Channel/ChannelSummary objects, added a description of latencyMode values.

December 18, 2020

Channel default values

  • In Channel data type, add default value for authorized.

  • In Channel data type and CreateChannel, add default value for type.

December 17, 2020

All List endpoints

Indicated that the maxResults request field has a default value, 50.

December 5, 2020

Stream & StreamSummary objects

Changed the description of the viewerCount field to indicate that a value of -1 indicates that the request timed out; in this case, retry.

November 10, 2020

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