ConnectAsMaster - Kinesis Video Streams
RequestResponseErrorsLimits/ThrottlingIdempotentRetry behaviorConcurrent calls
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ConnectAsMaster

Connects as a master to the signaling channel specified by the endpoint. Any WebSocket-complaint library can be used to connect to the endpoint obtained from a GetSignalingChannelEndpoint API call. The Amazon Resource Name (ARN) of the signaling channel must be provided as a query string parameter. There are separate endpoints for connecting as a master and as a viewer. If more than one client connects as master to a specific channel, then the most recent request takes precedence. Existing connection metadata is overwritten by the new one.

Request

"X-Amz-ChannelARN": "string"

  • X-Amz-ChannelARN - ARN of the signaling channel.

    • Type: string

    • Length constraints: Minimum length of 1. Maximum length of 1024.

    • Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

    • Required: Yes

Response

200 OK HTTP status code with an empty body.

Errors

  • InvalidArgumentException

    A specified parameter exceeds its restrictions, is not supported, or cannot be used. For more information, see the returned message.

    HTTP Status Code: 400

  • AccessDeniedException

    The caller is not authorized to access the given channel or the token has expired.

    HTTP Status Code: 403

  • ResourceNotFoundException

    The channel doesn't exist.

    HTTP Status Code: 404

  • ClientLimitExceededException

    When the API is invoked at a rate that is too high. For more information, see Amazon Kinesis Video Streams with WebRTC Service Quotas and Error Retries and Exponential Backoff in Amazon.

    HTTP Status Code: 400

Limits/Throttling

This API is throttled at an account level if the API is invoked at too high a rate. An error returned when throttled with ClientLimitExceededException.

Idempotent

If a connection already exists for the specified clientId and channel, the connection metadata is updated with the new information.

Retry behavior

This is counted as a new API call.

Concurrent calls

Concurrent calls are allowed, the connection metadata is updated for each call.