

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

# UpdateStream
<a name="API_UpdateStream"></a>

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

您必須提供串流名稱或串流的 Amazon Resource Name (ARN)。

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

 `UpdateStream` 是一種非同步操作，需要一些時間才能完成。

## 請求語法
<a name="API_UpdateStream_RequestSyntax"></a>

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

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

## URI 請求參數
<a name="API_UpdateStream_RequestParameters"></a>

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

## 請求主體
<a name="API_UpdateStream_RequestBody"></a>

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

 ** [CurrentVersion](#API_UpdateStream_RequestSyntax) **   <a name="KinesisVideo-UpdateStream-request-CurrentVersion"></a>
您要更新其中繼資料的串流版本。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`[a-zA-Z0-9]+`  
必要：是

 ** [DeviceName](#API_UpdateStream_RequestSyntax) **   <a name="KinesisVideo-UpdateStream-request-DeviceName"></a>
正在寫入串流的裝置名稱。  
 在目前的實作中，Kinesis Video Streams 不會使用此名稱。
類型：字串  
長度限制：長度下限為 1。長度上限為 128。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

 ** [MediaType](#API_UpdateStream_RequestSyntax) **   <a name="KinesisVideo-UpdateStream-request-MediaType"></a>
串流的媒體類型。使用 `MediaType`指定串流包含的內容類型給串流的取用者。如需媒體類型的詳細資訊，請參閱[媒體類型](http://www.iana.org/assignments/media-types/media-types.xhtml)。如果您選擇指定 `MediaType`，請參閱[命名需求](https://tools.ietf.org/html/rfc6838#section-4.2)。  
若要在主控台上播放影片，您必須指定正確的影片類型。例如，如果串流中的視訊是 H.264，請將 指定`video/h264`為 `MediaType`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 128。  
模式：`[\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*`  
必要：否

 ** [StreamARN](#API_UpdateStream_RequestSyntax) **   <a name="KinesisVideo-UpdateStream-request-StreamARN"></a>
您要更新其中繼資料之串流的 ARN。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_UpdateStream_RequestSyntax) **   <a name="KinesisVideo-UpdateStream-request-StreamName"></a>
您要更新其中繼資料的串流名稱。  
串流名稱是串流的識別符，而且每個帳戶和區域都必須是唯一的。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

## 回應語法
<a name="API_UpdateStream_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UpdateStream_ResponseElements"></a>

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

## 錯誤
<a name="API_UpdateStream_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ClientLimitExceededException **   
Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。  
HTTP 狀態碼：400

 ** InvalidArgumentException **   
此輸入參數的值無效。  
HTTP 狀態碼：400

 ** NotAuthorizedException **   
發起人無權執行此操作。  
HTTP 狀態碼：401

 ** ResourceInUseException **   
當輸入`StreamARN`或 `ChannelARN` 中的 `CLOUD_STORAGE_MODE` 已映射至不同的 Kinesis Video Stream 資源，或提供的輸入`StreamARN`或 `ChannelARN` 未處於作用中狀態時，請嘗試下列其中一個 ：  

1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。

1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。

1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams 找不到您指定的串流。  
HTTP 狀態碼：404

 ** VersionMismatchException **   
您指定的串流版本不是最新版本。若要取得最新版本，請使用 [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_UpdateStream_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateStream) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateStream) 