AWS kinesisvideostreams documentation change
Summary
Entire documentation page for GetIceServerConfig API has been removed, including request/response syntax, parameters, error handling, and references.
Security assessment
The change removes documentation about an API that handles ICE server configuration (including credentials). However, there is no evidence this deletion addresses a specific security vulnerability. It appears to be routine documentation cleanup or restructuring rather than a security fix.
Diff
diff --git a/kinesisvideostreams/latest/dg/API_signaling_GetIceServerConfig.md b/kinesisvideostreams/latest/dg/API_signaling_GetIceServerConfig.md index 3c4f9b1eb..8b1378917 100644 --- a//kinesisvideostreams/latest/dg/API_signaling_GetIceServerConfig.md +++ b//kinesisvideostreams/latest/dg/API_signaling_GetIceServerConfig.md @@ -1 +0,0 @@ -[View a markdown version of this page](API_signaling_GetIceServerConfig.md) @@ -3,211 +1,0 @@ -[](/pdfs/kinesisvideostreams/latest/dg/kinesisvideo-dg.pdf#API_signaling_GetIceServerConfig "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 - -# GetIceServerConfig - -**Note:** Before using this API, you must call the `GetSignalingChannelEndpoint` API to request the HTTPS endpoint. You then specify the endpoint and region in your `GetIceServerConfig` API request. - -Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, user name, and password which can be used to configure the WebRTC connection. The ICE component uses this configuration information to set up the WebRTC connection, including authenticating with the Traversal Using Relays around NAT (TURN) relay server. - -TURN is a protocol that is used to improve the connectivity of peer-to-peer applications. By providing a cloud-based relay service, TURN ensures that a connection can be established even when one or more peers are incapable of a direct peer-to-peer connection. For more information, see [A REST API For Access To TURN Services](https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00). - -You can invoke this API to establish a fallback mechanism in case either of the peers is unable to establish a direct peer-to-peer connection over a signaling channel. You must specify the Amazon Resource Name (ARN) of your signaling channel in order to invoke this API. - -## Request Syntax - - - POST /v1/get-ice-server-config HTTP/1.1 - Content-type: application/json - - { - "ChannelARN": "string", - "ClientId": "string", - "Service": "string", - "Username": "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 ARN of the signaling channel to be used for the peer-to-peer connection between configured peers. - -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: Yes - -**ClientId ** - - -Unique identifier for the viewer. Must be unique within the signaling channel. - -Type: String - -Length Constraints: Minimum length of 1. Maximum length of 256. - -Pattern: `[a-zA-Z0-9_.-]+` - -Required: No - -**Service ** - - -Specifies the desired service. Currently, `TURN` is the only valid value. - -Type: String - -Valid Values: `TURN` - -Required: No - -**Username ** - - -An optional user ID to be associated with the credentials. - -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: application/json - - { - "IceServerList": [ - { - "[Password](./API_signaling_IceServer.html#KinesisVideo-Type-signaling_IceServer-Password)": "**_string_** ", - "[Ttl](./API_signaling_IceServer.html#KinesisVideo-Type-signaling_IceServer-Ttl)": **_number_** , - "[Uris](./API_signaling_IceServer.html#KinesisVideo-Type-signaling_IceServer-Uris)": [ "**_string_** " ], - "[Username](./API_signaling_IceServer.html#KinesisVideo-Type-signaling_IceServer-Username)": "**_string_** " - } - ] - } - -## Response Elements - -If the action is successful, the service sends back an HTTP 200 response. - -The following data is returned in JSON format by the service. - -**IceServerList ** - - -The list of ICE server information objects. - -Type: Array of [IceServer](./API_signaling_IceServer.html) objects - -## Errors - -For information about the errors that are common to all actions, see [Common Error Types](./CommonErrors.html). - -**ClientLimitExceededException** - - -Your request was throttled 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 - -**InvalidClientException** - - -The specified client is invalid. - -HTTP Status Code: 400 - -**NotAuthorizedException** - - -The caller is not authorized to perform this operation. - -HTTP Status Code: 401 - -**ResourceNotFoundException** - - -The specified resource is not found. - -HTTP Status Code: 404 - -**SessionExpiredException** - - -If the client session is expired. Once the client is connected, the session is valid for 45 minutes. Client should reconnect to the channel to continue sending/receiving messages. - -HTTP Status Code: 400 - -## 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-signaling-2019-12-04/GetIceServerConfig) - - * [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-signaling-2019-12-04/GetIceServerConfig) - - * [AWS SDK for C++](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-signaling-2019-12-04/GetIceServerConfig) - - * [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) - - * [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) - - * [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) - - * [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-signaling-2019-12-04/GetIceServerConfig) - - * [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) - - * [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) - - * [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) - - - - - **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.