UpdateSignalingChannel - Amazon Kinesis Video Streams
請求語法URI 請求參數請求主體回應語法回應元素錯誤另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

UpdateSignalingChannel

更新現有的信令通道。這是非同步作業，需要時間才能完成。

如果該MessageTtlSeconds值已更新（增加或減少），則僅適用於在更新後通過此通道發送的新消息。現有消息仍然按照以前的MessageTtlSeconds值過期。

請求語法

POST /updateSignalingChannel HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "CurrentVersion": "string",
   "SingleMasterConfiguration": { 
      "MessageTtlSeconds": number
   }
}

URI 請求參數

請求不會使用任何 URI 參數。

請求主體

請求接受採用 JSON 格式的下列資料。

ChannelARN

您要更新的信令通道的 Amazon 資源名稱 (ARN)。

類型：字串

長度限制：長度下限為 1。長度上限為 1024。

模式：arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

必要：是

CurrentVersion

您要更新的信令通道的目前版本。

類型：字串

長度限制：長度下限為 1。長度上限為 64。

模式：[a-zA-Z0-9]+

必要：是

SingleMasterConfiguration

包含您要更新之信號通道SINGLE_MASTER類型之組態的結構。

類型：SingleMasterConfiguration 物件

必要：否

回應語法

HTTP/1.1 200

回應元素

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

錯誤

如需所有動作常見錯誤的資訊，請參閱常見錯誤。

AccessDeniedException

您沒有執行此作業所需的權限。

狀態碼：4

ClientLimitExceededException

Kinesis Video Streams 已限制要求，因為您已經超過允許的用戶端呼叫限制。稍後再嘗試撥打電話。

HTTP 狀態碼：400

InvalidArgumentException

此輸入參數的值無效。

HTTP 狀態碼：400

ResourceInUseException

當輸入StreamARN或 ChannelARN in CLOUD_STORAGE_MODE 已對應至不同的 Kinesis Video Stream 資源，或者如果提供的輸入StreamARN或不處ChannelARN於作用中狀態，請嘗試下列其中一種方法：

  1. 用於確定給定通道的流映射到的 DescribeMediaStorageConfiguration API。

  2. 用於確定給定流映射到的信道的 DescribeMappedResourceConfiguration API。

  3. DescribeSignalingChannel用來判斷資源狀態的DescribeStream或 API。

HTTP 狀態碼：400

ResourceNotFoundException

Amazon Kinesis Video Streams 找不到您指定的串流。

HTTP 狀態碼：404

VersionMismatchException

您指定的串流版本不是最新版本。若要取得最新版本，請使用 DescribeStreamAPI。

HTTP 狀態碼：400

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：