UpdateSignalingChannel
Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
If the MessageTtlSeconds
value is updated (either increased or reduced),
it only applies to new messages sent via this channel after it's been updated. Existing
messages are still expired as per the previous MessageTtlSeconds
value.
Request Syntax
POST /updateSignalingChannel HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string
",
"CurrentVersion": "string
",
"SingleMasterConfiguration": {
"MessageTtlSeconds": number
}
}
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 signaling channel that you want to update.
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
- CurrentVersion
-
The current version of the signaling channel that you want to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9]+
Required: Yes
- SingleMasterConfiguration
-
The structure containing the configuration for the
SINGLE_MASTER
type of the signaling channel that you want to update.Type: SingleMasterConfiguration object
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
-
When the input
StreamARN
orChannelARN
inCLOUD_STORAGE_MODE
is already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARN
orChannelARN
is not in Active status, try one of the following :-
The
DescribeMediaStorageConfiguration
API to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfiguration
API to determine the channel that the given stream is mapped to. -
The
DescribeStream
orDescribeSignalingChannel
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
- VersionMismatchException
-
The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: