AWS kinesisvideostreams documentation change
Summary
The entire documentation content for the GetSignalingChannelEndpoint API was removed. This included API reference details, request/response syntax, parameters, error codes, and related SDK information.
Security assessment
The change removes API documentation but contains no evidence of addressing a specific security vulnerability, weakness, or incident. While the removed content mentioned security protocols (WSS/HTTPS), the deletion itself isn't linked to any security fix or advisory.
Diff
diff --git a/kinesisvideostreams/latest/dg/API_GetSignalingChannelEndpoint.md b/kinesisvideostreams/latest/dg/API_GetSignalingChannelEndpoint.md index d69bdf4f1..8b1378917 100644 --- a//kinesisvideostreams/latest/dg/API_GetSignalingChannelEndpoint.md +++ b//kinesisvideostreams/latest/dg/API_GetSignalingChannelEndpoint.md @@ -1 +0,0 @@ -[View a markdown version of this page](API_GetSignalingChannelEndpoint.md) @@ -3,182 +1,0 @@ -[](/pdfs/kinesisvideostreams/latest/dg/kinesisvideo-dg.pdf#API_GetSignalingChannelEndpoint "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 - -# GetSignalingChannelEndpoint - -Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the `SingleMasterChannelEndpointConfiguration` input parameter, which consists of the `Protocols` and `Role` properties. - -`Protocols` is used to determine the communication mechanism. For example, if you specify `WSS` as the protocol, this API produces a secure websocket endpoint. If you specify `HTTPS` as the protocol, this API generates an HTTPS endpoint. If you specify `WEBRTC` as the protocol, but the signaling channel isn't configured for ingestion, you will receive the error `InvalidArgumentException`. - -`Role` determines the messaging permissions. A `MASTER` role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A `VIEWER` role results in this API generating an endpoint that a client can use to communicate only with a `MASTER`. - -## Request Syntax - - - POST /getSignalingChannelEndpoint HTTP/1.1 - Content-type: application/json - - { - "ChannelARN": "string", - "SingleMasterChannelEndpointConfiguration": { - "[Protocols](./API_SingleMasterChannelEndpointConfiguration.html#KinesisVideo-Type-SingleMasterChannelEndpointConfiguration-Protocols)": [ "string" ], - "[Role](./API_SingleMasterChannelEndpointConfiguration.html#KinesisVideo-Type-SingleMasterChannelEndpointConfiguration-Role)": "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 signalling channel for which you want to get an endpoint. - -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 - -**SingleMasterChannelEndpointConfiguration ** - - -A structure containing the endpoint configuration for the `SINGLE_MASTER` channel type. - -Type: [SingleMasterChannelEndpointConfiguration](./API_SingleMasterChannelEndpointConfiguration.html) object - -Required: No - -## Response Syntax - - - HTTP/1.1 200 - Content-type: application/json - - { - "ResourceEndpointList": [ - { - "[Protocol](./API_ResourceEndpointListItem.html#KinesisVideo-Type-ResourceEndpointListItem-Protocol)": "**_string_** ", - "[ResourceEndpoint](./API_ResourceEndpointListItem.html#KinesisVideo-Type-ResourceEndpointListItem-ResourceEndpoint)": "**_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. - -**ResourceEndpointList ** - - -A list of endpoints for the specified signaling channel. - -Type: Array of [ResourceEndpointListItem](./API_ResourceEndpointListItem.html) objects - -## 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: 401 - -**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 - -**ResourceInUseException** - - -When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is already mapped to a different Kinesis Video Stream resource, or if the provided input `StreamARN` or `ChannelARN` is not in Active status, try one of the following : - - 1. The `DescribeMediaStorageConfiguration` API to determine what the stream given channel is mapped to. - - 2. The `DescribeMappedResourceConfiguration` API to determine the channel that the given stream is mapped to. - - 3. The `DescribeStream` or `DescribeSignalingChannel` API to determine the status of the resource. - - - - -HTTP Status Code: 400 - -**ResourceNotFoundException** - - -Amazon Kinesis Video Streams can't find the stream that you specified. - -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/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) - - * [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) - - * [AWS SDK for C++](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) - - * [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) - - * [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) - - * [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) - - * [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) - - * [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) - - * [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) - - * [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) - - - - - **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) - -GetDataEndpoint - -ListEdgeAgentConfigurations - -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. - -Did this page help you? - No - -Thanks for letting us know this page needs work. We're sorry we let you down. - -If you've got a moment, please tell us how we can make the documentation better.