UpdateSignalingChannelCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { KinesisVideoClient, UpdateSignalingChannelCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import
// const { KinesisVideoClient, UpdateSignalingChannelCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import
const client = new KinesisVideoClient(config);
const input = { // UpdateSignalingChannelInput
  ChannelARN: "STRING_VALUE", // required
  CurrentVersion: "STRING_VALUE", // required
  SingleMasterConfiguration: { // SingleMasterConfiguration
    MessageTtlSeconds: Number("int"),
  },
};
const command = new UpdateSignalingChannelCommand(input);
const response = await client.send(command);
// {};

UpdateSignalingChannelCommand Input

See UpdateSignalingChannelCommandInput for more details

Parameter
Type
Description
ChannelARN
Required
string | undefined

The Amazon Resource Name (ARN) of the signaling channel that you want to update.

CurrentVersion
Required
string | undefined

The current version of the signaling channel that you want to update.

SingleMasterConfiguration
SingleMasterConfiguration | undefined

The structure containing the configuration for the SINGLE_MASTER type of the signaling channel that you want to update.

UpdateSignalingChannelCommand Output

See UpdateSignalingChannelCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have required permissions to perform this operation.

ClientLimitExceededException
client

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException
client

The value for this input parameter is invalid.

ResourceInUseException
client

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.

ResourceNotFoundException
client

Amazon Kinesis Video Streams can't find the stream that you specified.

VersionMismatchException
client

The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream  API.

KinesisVideoServiceException
Base exception class for all service exceptions from KinesisVideo service.