AWS kinesisvideostreams documentation change
Summary
Entire content of the GetMedia API documentation page was removed
Security assessment
The change deletes the entire documentation page without adding new content or referencing any security vulnerabilities. There is no evidence this change addresses a specific security issue or weakness.
Diff
diff --git a/kinesisvideostreams/latest/dg/API_dataplane_GetMedia.md b/kinesisvideostreams/latest/dg/API_dataplane_GetMedia.md index 8d4616f5d..8b1378917 100644 --- a//kinesisvideostreams/latest/dg/API_dataplane_GetMedia.md +++ b//kinesisvideostreams/latest/dg/API_dataplane_GetMedia.md @@ -1 +0,0 @@ -[View a markdown version of this page](API_dataplane_GetMedia.md) @@ -3,281 +1,0 @@ -[](/pdfs/kinesisvideostreams/latest/dg/kinesisvideo-dg.pdf#API_dataplane_GetMedia "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 - -# GetMedia - -Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number. - -###### Note - -You must first call the `GetDataEndpoint` API to get an endpoint. Then send the `GetMedia` requests to this endpoint using the [\--endpoint-url parameter](https://docs.aws.amazon.com/cli/latest/reference/). - -When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see [PutMedia](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html). The `GetMedia` API returns a stream of these chunks starting from the chunk that you specify in the request. - -The `GetMedia` API is designed to operate as a streaming API over a long-running connection. It is not intended for use in a traditional RESTful manner, where a new HTTP connection is established and closed for each fragment. When you invoke the `GetMedia` API, Kinesis Video Streams delivers fragments continuously through a persistent long-running connection using HTTP chunked transfer encoding. - -The following limits apply when using the `GetMedia` API: - - * A client can call `GetMedia` up to five times per second per stream. - - * Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a `GetMedia` session. - -###### Note - -Use `GetMedia` as a streaming long-running connection to retrieve multiple fragments in a single persistent connection. Don't use the `GetMedia` API in a traditional RESTful manner where you establish and close a new HTTP connection for each fragment. If you attempt more than three concurrent `GetMedia` connections, Kinesis Video Streams throttles the latest connections with a `ConnectionLimitExceededException` error. - - - - -###### Note - -The `GetMedia` HTTP response status code will be returned immediately, but the reading of the HTTP response payload will timeout after 3 seconds if there are no ingested fragments available for playback. - -###### Note - -If an error is thrown after invoking a Kinesis Video Streams 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 /getMedia HTTP/1.1 - Content-type: application/json - - { - "StartSelector": { - "[AfterFragmentNumber](./API_dataplane_StartSelector.html#KinesisVideo-Type-dataplane_StartSelector-AfterFragmentNumber)": "string", - "[ContinuationToken](./API_dataplane_StartSelector.html#KinesisVideo-Type-dataplane_StartSelector-ContinuationToken)": "string", - "[StartSelectorType](./API_dataplane_StartSelector.html#KinesisVideo-Type-dataplane_StartSelector-StartSelectorType)": "string", - "[StartTimestamp](./API_dataplane_StartSelector.html#KinesisVideo-Type-dataplane_StartSelector-StartTimestamp)": number - }, - "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. - -**StartSelector ** - - -Identifies the starting chunk to get from the specified stream. - -Type: [StartSelector](./API_dataplane_StartSelector.html) object - -Required: Yes - -**StreamARN ** - - -The ARN of the stream from where you want to get the media content. If you don't specify the `streamARN`, you must specify the `streamName`. - -Type: String - -Length Constraints: Minimum length of 1. Maximum length of 1024. - -Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` - -Required: No - -**StreamName ** - - -The Kinesis video stream name from where you want to get the media content. If you don't specify the `streamName`, you must specify the `streamARN`. - -Type: String - -Length Constraints: Minimum length of 1. Maximum length of 256. - -Pattern: `[a-zA-Z0-9_.-]+` - -Required: No - -## Response Syntax - - - HTTP/1.1 200 - Content-Type: ContentType - - Payload - -## Response Elements - -If the action is successful, the service sends back an HTTP 200 response. - -The response returns the following HTTP headers. - -**ContentType ** - - -The content type of the requested media. - -Length Constraints: Minimum length of 1. Maximum length of 128. - -Pattern: `^[a-zA-Z0-9_\.\-]+$` - -The response returns the following as the HTTP body. - -**Payload ** - - -The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For more information about the chunks, see [PutMedia](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html). The chunks that Kinesis Video Streams returns in the `GetMedia` call also include the following additional Matroska (MKV) tags: - - * AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your `GetMedia` call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated. - - * AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream. - - * AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk. - - * AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment. - - * AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment. - - - - -The following tags will be present if an error occurs: - - * AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop. - - * AWS_KINESISVIDEO_ERROR_ID: Integer code of the error. - - - - -The error codes are as follows: - - * 3002 - Error writing to the stream - - * 4000 - Requested fragment is not found - - * 4500 - Access denied for the stream's KMS key - - * 4501 - Stream's KMS key is disabled - - * 4502 - Validation error on the stream's KMS key - - * 4503 - KMS key specified in the stream is unavailable - - * 4504 - Invalid usage of the KMS key specified in the stream - - * 4505 - Invalid state of the KMS key specified in the stream - - * 4506 - Unable to find the KMS key specified in the stream - - * 5000 - Internal error - - - - -## Errors - -For information about the errors that are common to all actions, see [Common Error Types](./CommonErrors.html). - -**ClientLimitExceededException** -