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

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

UpdateStream

更新串流中繼資料，例如裝置名稱和媒體類型。

您必須提供串流名稱或資料流的 Amazon 資源名稱 (ARN)。

若要在更新串流之前確定您擁有最新版本的串流，您可以指定串流版本。Kinesis 視訊串流會為每個串流指派一個版本。當您更新串流時，Kinesis Video Streams 會指派新的版本號碼。若要取得最新的串流版本，請使用 DescribeStream API。

UpdateStream是非同步作業，需要時間才能完成。

請求語法

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

{
   "CurrentVersion": "string",
   "DeviceName": "string",
   "MediaType": "string",
   "StreamARN": "string",
   "StreamName": "string"
}

URI 請求參數

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

請求主體

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

CurrentVersion

您要更新其中繼資料的串流版本。

類型：字串

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

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

必要：是

DeviceName

寫入串流的裝置名稱。

注意

在目前的實作中，Kinesis Video Streams 不會使用此名稱。

類型：字串

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

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

必要：否

MediaType

串流的媒體類型。用MediaType於指定串流包含給串流取用者的內容類型。如需媒體類型的詳細資訊，請參閱媒體類型。如果您選擇指定MediaType，請參閱命名需求。

若要在主機上播放視訊，您必須指定正確的視訊類型。例如，如果串流中的視訊是 H.264，請指定video/h264MediaType為.

類型：字串

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

模式：[\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*

必要：否

StreamARN

您要更新其中繼資料的串流的 ARN。

類型：字串

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

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

必要：否

StreamName

您要更新其中繼資料的串流名稱。

串流名稱是串流的識別碼，每個帳戶和區域都必須是唯一的。

類型：字串

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

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

必要：否

回應語法

HTTP/1.1 200

回應元素

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

錯誤

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

ClientLimitExceededException

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

HTTP 狀態碼：400

InvalidArgumentException

此輸入參數的值無效。

HTTP 狀態碼：400

NotAuthorizedException

呼叫者沒有執行此操作的授權。

狀態碼：

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 的詳細資訊，請參閱下列內容：