AWS kinesisvideostreams documentation change
Summary
Entire documentation content for GetDASHStreamingSessionURL API was removed, including request/response syntax, parameters, errors, and security notes about session token protection.
Security assessment
The change removes documentation content but provides no evidence of addressing a specific security vulnerability. While security notes about token protection were deleted, the removal appears to be general cleanup rather than response to a security incident. No vulnerability patching or exploit mitigation is indicated.
Diff
diff --git a/kinesisvideostreams/latest/dg/API_reader_GetDASHStreamingSessionURL.md b/kinesisvideostreams/latest/dg/API_reader_GetDASHStreamingSessionURL.md index 2d40916c0..8b1378917 100644 --- a//kinesisvideostreams/latest/dg/API_reader_GetDASHStreamingSessionURL.md +++ b//kinesisvideostreams/latest/dg/API_reader_GetDASHStreamingSessionURL.md @@ -1 +0,0 @@ -[View a markdown version of this page](API_reader_GetDASHStreamingSessionURL.md) @@ -3,380 +1,0 @@ -[](/pdfs/kinesisvideostreams/latest/dg/kinesisvideo-dg.pdf#API_reader_GetDASHStreamingSessionURL "Open PDF") - -[Documentation](/index.html)[Amazon Kinesis Video Streams](/kinesis/index.html)[Developer Guide](what-is-kinesis-video.html) - -Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also - -# GetDASHStreamingSessionURL - -Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You can then open the URL in a media player to view the stream contents. - -Both the `StreamName` and the `StreamARN` parameters are optional, but you must specify either the `StreamName` or the `StreamARN` when invoking this API operation. - -An Amazon Kinesis video stream has the following requirements for providing data through MPEG-DASH: - - * [Video playback track requirements](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html). - - * Data retention must be greater than 0. - - * The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more information, see [MPEG-4 specification ISO/IEC 14496-15](https://www.iso.org/standard/55980.html). For information about adapting stream data to a given format, see [NAL Adaptation Flags](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html). - - * The audio track (if present) of each fragment must contain codec private data in the AAC format ([AAC specification ISO/IEC 13818-7](https://www.iso.org/standard/43345.html)) or the [MS Wave format](https://www.mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html). - - - - -The following procedure shows how to use MPEG-DASH with Kinesis Video Streams: - - 1. Call the `GetDataEndpoint` API to get an endpoint. Then send the `GetDASHStreamingSessionURL` requests to this endpoint using the [\--endpoint-url parameter](https://docs.aws.amazon.com/cli/latest/reference/). - - 2. Retrieve the MPEG-DASH URL using `GetDASHStreamingSessionURL`. Kinesis Video Streams creates an MPEG-DASH streaming session to be used for accessing content in a stream using the MPEG-DASH protocol. `GetDASHStreamingSessionURL` returns an authenticated URL (that includes an encrypted session token) for the session's MPEG-DASH _manifest_ (the root resource needed for streaming with MPEG-DASH). - -###### Note - -Don't share or store this token where an unauthorized entity can access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you use with your AWS credentials. - -The media that is made available through the manifest consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available. - - 3. Provide the URL (containing the encrypted session token) for the MPEG-DASH manifest to a media player that supports the MPEG-DASH protocol. Kinesis Video Streams makes the initialization fragment and media fragments available through the manifest URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain encoded video frames or encoded audio samples. - - 4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions: - - * **GetDASHManifest:** Retrieves an MPEG DASH manifest, which contains the metadata for the media that you want to playback. - - * **GetMP4InitFragment:** Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "`fytp`" and "`moov`" MP4 atoms, and the child atoms that are needed to initialize the media player decoder. - -The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames. - - * **GetMP4MediaFragment:** Retrieves MP4 media fragments. These fragments contain the "`moof`" and "`mdat`" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their timestamps. - -###### Important - -The codec private data (CPD) contained in each fragment contains codec-specific initialization information, such as frame rate, resolution, and encoding profile, which are necessary to properly decode the fragment. CPD changes aren't supported during a streaming session. The CPD must remain consistent through the queried media. - -###### Important - -Track changes aren't supported. Tracks must remain consistent throughout the queried media. Streaming will fail if the fragments in the stream change from having only video to having both audio and video, or if an AAC audio track is changed to an A-Law audio track. - -Data retrieved with this action is billable. See [Pricing](https://aws.amazon.com/kinesis/video-streams/pricing/) for details. - - - - -###### Note - -For restrictions that apply to MPEG-DASH sessions, see [Kinesis Video Streams quotas](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html). - -You can monitor the amount of data that the media player consumes by monitoring the `GetMP4MediaFragment.OutgoingBytes` Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see [Monitoring Kinesis Video Streams](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html). For pricing information, see [Amazon Kinesis Video Streams Pricing](https://aws.amazon.com/kinesis/video-streams/pricing/) and [AWS Pricing](https://aws.amazon.com/pricing/). Charges for both HLS sessions and outgoing AWS data apply. - -For more information about HLS, see [HTTP Live Streaming](https://developer.apple.com/streaming/) on the [Apple Developer site](https://developer.apple.com). - -###### Important - -If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information: - - * `x-amz-ErrorType` HTTP header – contains a more specific error type in addition to what the HTTP status code provides. - - * `x-amz-RequestId` HTTP header – if you want to report an issue to AWS the support team can better diagnose the problem if given the Request Id. - - - - -Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again. - -For more information, see the **Errors** section at the bottom of this topic, as well as [Common Errors](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html). - -## Request Syntax - - - POST /getDASHStreamingSessionURL HTTP/1.1 - Content-type: application/json - - { - "DASHFragmentSelector": { - "[FragmentSelectorType](./API_reader_DASHFragmentSelector.html#KinesisVideo-Type-reader_DASHFragmentSelector-FragmentSelectorType)": "string", - "[TimestampRange](./API_reader_DASHFragmentSelector.html#KinesisVideo-Type-reader_DASHFragmentSelector-TimestampRange)": { - "[EndTimestamp](./API_reader_DASHTimestampRange.html#KinesisVideo-Type-reader_DASHTimestampRange-EndTimestamp)": number, - "[StartTimestamp](./API_reader_DASHTimestampRange.html#KinesisVideo-Type-reader_DASHTimestampRange-StartTimestamp)": number - } - }, - "DisplayFragmentNumber": "string", - "DisplayFragmentTimestamp": "string", - "Expires": number, - "MaxManifestFragmentResults": number, - "PlaybackMode": "string", - "StreamARN": "string", - "StreamName": "string" - } - -## URI Request Parameters - -The request does not use any URI parameters. - -## Request Body - -The request accepts the following data in JSON format. - -**DASHFragmentSelector ** - - -The time range of the requested fragment and the source of the timestamps. - -This parameter is required if `PlaybackMode` is `ON_DEMAND` or `LIVE_REPLAY`. This parameter is optional if PlaybackMode is`` `LIVE`. If `PlaybackMode` is `LIVE`, the `FragmentSelectorType` can be set, but the `TimestampRange` should not be set. If `PlaybackMode` is `ON_DEMAND` or `LIVE_REPLAY`, both `FragmentSelectorType` and `TimestampRange` must be set. - -Type: [DASHFragmentSelector](./API_reader_DASHFragmentSelector.html) object - -Required: No - -**DisplayFragmentNumber ** - - -Fragments are identified in the manifest file based on their sequence number in the session. If DisplayFragmentNumber is set to `ALWAYS`, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g. `GetMedia` and `GetMediaForFragmentList`). A custom MPEG-DASH media player is necessary to leverage these this custom attribute. - -The default value is `NEVER`. - -Type: String - -Valid Values: `ALWAYS | NEVER` - -Required: No - -**DisplayFragmentTimestamp ** - - -Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to `ALWAYS`, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute. - -The default value is `NEVER`. When [DASHFragmentSelector](./API_reader_DASHFragmentSelector.html) is `SERVER_TIMESTAMP`, the timestamps will be the server start timestamps. Similarly, when [DASHFragmentSelector](./API_reader_DASHFragmentSelector.html) is `PRODUCER_TIMESTAMP`, the timestamps will be the producer start timestamps. - -Type: String - -Valid Values: `ALWAYS | NEVER` - -Required: No - -**Expires ** - - -The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and 43200 (12 hours). - -When a session expires, no new calls to `GetDashManifest`, `GetMP4InitFragment`, or `GetMP4MediaFragment` can be made for that session. - -The default is 300 (5 minutes). - -Type: Integer - -Valid Range: Minimum value of 300. Maximum value of 43200. - -Required: No - -**MaxManifestFragmentResults ** - - -The maximum number of fragments that are returned in the MPEG-DASH manifest. - -When the `PlaybackMode` is `LIVE`, the most recent fragments are returned up to this value. When the `PlaybackMode` is `ON_DEMAND`, the oldest fragments are returned, up to this maximum number. - -When there are a higher number of fragments available in a live MPEG-DASH manifest, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3 fragments and a maximum of 10 fragments. - -The default is 5 fragments if `PlaybackMode` is `LIVE` or `LIVE_REPLAY`, and 1,000 if `PlaybackMode` is `ON_DEMAND`. - -The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on streams with 1-second fragments, and more than 2 1/2 hours of video on streams with 10-second fragments. - -Type: Long - -Valid Range: Minimum value of 1. Maximum value of 5000. - -Required: No - -**PlaybackMode ** - - -Whether to retrieve live, live replay, or archived, on-demand data. - -Features of the three types of sessions include the following: