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.
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": [ "string
" ],
"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 object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ResourceEndpointList": [
{
"Protocol": "string",
"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 objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
-
The resource is currently not available for this operation. New resources cannot be created with the same name as existing resources. Also, resources cannot be updated or deleted unless they are in an
ACTIVE
state.If this exception is returned, do not use it to determine whether the requested resource already exists. Instead, it is recommended you use the resource-specific describe API, for exmaple,
DescribeStream
for video streams.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: