AWS kinesisvideostreams documentation change
Summary
Entire documentation for JoinStorageSession API was removed, including request/response syntax, parameters, errors, and usage notes.
Security assessment
The change removes API documentation without adding security content or addressing vulnerabilities. There's no evidence of security fixes (e.g., no CVE mentions, vulnerability disclosures, or security improvements). Removal appears to be routine documentation cleanup.
Diff
diff --git a/kinesisvideostreams/latest/dg/API_webrtc_JoinStorageSession.md b/kinesisvideostreams/latest/dg/API_webrtc_JoinStorageSession.md index 14798b44e..8b1378917 100644 --- a//kinesisvideostreams/latest/dg/API_webrtc_JoinStorageSession.md +++ b//kinesisvideostreams/latest/dg/API_webrtc_JoinStorageSession.md @@ -1 +0,0 @@ -[View a markdown version of this page](API_webrtc_JoinStorageSession.md) @@ -3,198 +1,0 @@ -[](/pdfs/kinesisvideostreams/latest/dg/kinesisvideo-dg.pdf#API_webrtc_JoinStorageSession "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 - -# JoinStorageSession - -###### Note - -Before using this API, you must call the `GetSignalingChannelEndpoint` API to request the WEBRTC endpoint. You then specify the endpoint and region in your `JoinStorageSession` API request. - -Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel. If there's not an existing session for the channel, create a new streaming session and provide the Amazon Resource Name (ARN) of the signaling channel. - -Currently for the `SINGLE_MASTER` type, a video producing device is able to ingest both audio and video media into a stream. Only video producing devices can join the session and record media. - -###### Important - -Both audio and video tracks are currently required for WebRTC ingestion. - -Current requirements: - - * Video track: H.264 - - * Audio track: Opus - - - - -Video: - - * Max resolution is SQFHD (1920x1920) - - * KVS WebRTC ingestion currently supports a specific set of H264 profiles: - - * constrained-baseline - - * baseline - - * main - - * high - - * constrained-high - - * progressive-high - - - - -The resulting ingested video in the Kinesis video stream will have the following parameters: H.264 video and AAC audio. - -Once a master participant has negotiated a connection through WebRTC, the ingested media session will be stored in the Kinesis video stream. Multiple viewers are then able to play back real-time media through our Playback APIs. - -You can also use existing Kinesis Video Streams features like `HLS` or `DASH` playback, image generation via [GetImages](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/gs-getImages.html), and more with ingested WebRTC media. - -###### Note - -S3 image delivery and notifications are not currently supported. - -###### Note - -Assume that only one video producing device client can be associated with a session for the channel. If more than one client joins the session of a specific channel as a video producing device, the most recent client request takes precedence. - -**Additional information** - - * **Idempotent** \- This API is not idempotent. - - * **Retry behavior** \- This is counted as a new API call. - - * **Concurrent calls** \- Concurrent calls are allowed. An offer is sent once per each call. - - - - -## Request Syntax - - - POST /joinStorageSession HTTP/1.1 - Content-type: application/json - - { - "channelArn": "string" - } - -## URI Request Parameters - -The request does not use any URI parameters. - -## Request Body - -The request accepts the following data in JSON format. - -**channelArn ** - - -The Amazon Resource Name (ARN) of the signaling channel. - -###### Important - -Note the capitalization of this input parameter. - -Type: String - -Pattern: `arn:(aws[a-zA-Z-]*):kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` - -Required: Yes - -## Response Syntax - - - HTTP/1.1 200 - - -## Response Elements - -If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. - -## Errors - -For information about the errors that are common to all actions, see [Common Error Types](./CommonErrors.html). - -**AccessDeniedException** - - -You do not have required permissions to perform this operation. - -HTTP Status Code: 403 - -**ClientLimitExceededException** - - -Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. - -HTTP Status Code: 400 - -**InvalidArgumentException** - - -The value for this input parameter is invalid. - -HTTP Status Code: 400 - -**ResourceNotFoundException** - - -The specified resource is not found. - -HTTP Status Code: 404 - -## See Also - -For more information about using this API in one of the language-specific AWS SDKs, see the following: - - * [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) - - * [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) - - * [AWS SDK for C++](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) - - * [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) - - * [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) - - * [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) - - * [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) - - * [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) - - * [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) - - * [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession) - - - - - **Javascript is disabled or is unavailable in your browser.** - -To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions. - -[Document Conventions](/general/latest/gr/docconventions.html) - -Amazon Kinesis Video WebRTC Storage - -JoinStorageSessionAsViewer - -Did this page help you? - Yes - -Thanks for letting us know we're doing a good job! - -If you've got a moment, please tell us what we did right so we can do more of it. -