[ aws . kinesisvideo ]
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 specifyWSS
as the protocol, this API produces a secure websocket endpoint. If you specifyHTTPS
as the protocol, this API generates an HTTPS endpoint.
Role
determines the messaging permissions. AMASTER
role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. AVIEWER
role results in this API generating an endpoint that a client can use to communicate only with aMASTER
.
See also: AWS API Documentation
get-signaling-channel-endpoint
--channel-arn <value>
[--single-master-channel-endpoint-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--channel-arn
(string)
The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.
--single-master-channel-endpoint-configuration
(structure)
A structure containing the endpoint configuration for the
SINGLE_MASTER
channel type.Protocols -> (list)
This property is used to determine the nature of communication over this
SINGLE_MASTER
signaling channel. IfWSS
is specified, this API returns a websocket endpoint. IfHTTPS
is specified, this API returns anHTTPS
endpoint.(string)
Role -> (string)
This property is used to determine messaging permissions in this
SINGLE_MASTER
signaling channel. IfMASTER
is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. IfVIEWER
is specified, this API returns an endpoint that a client can use only to send offers to anotherMASTER
client on this signaling channel.
Shorthand Syntax:
Protocols=string,string,Role=string
JSON Syntax:
{
"Protocols": ["WSS"|"HTTPS"|"WEBRTC", ...],
"Role": "MASTER"|"VIEWER"
}
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
ResourceEndpointList -> (list)
A list of endpoints for the specified signaling channel.
(structure)
An object that describes the endpoint of the signaling channel returned by the
GetSignalingChannelEndpoint
API.Protocol -> (string)
The protocol of the signaling channel returned by the
GetSignalingChannelEndpoint
API.ResourceEndpoint -> (string)
The endpoint of the signaling channel returned by the
GetSignalingChannelEndpoint
API.