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

# UpdateDataRetention
<a name="API_UpdateDataRetention"></a>

依您指定的值增加或減少串流的資料保留期間。若要指出是否要增加或減少資料保留期間，請在請求內文中指定 `Operation` 參數。在請求中，您必須指定 `StreamName`或 `StreamARN`。

這項操作需要 `KinesisVideo:UpdateDataRetention` 動作的許可。

變更資料保留期間會影響串流中的資料，如下所示：
+ 如果資料保留期間增加，現有資料會保留新的保留期間。例如，如果資料保留期間從 1 小時增加到 7 小時，則所有現有的資料都會保留 7 小時。
+ 如果資料保留期間減少，則會在新的保留期間保留現有資料。例如，如果資料保留期間從 7 小時縮短為 1 小時，所有現有的資料都會保留 1 小時，而且任何超過 1 小時的資料都會立即刪除。

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

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

{
   "CurrentVersion": "string",
   "DataRetentionChangeInHours": number,
   "Operation": "string",
   "StreamARN": "string",
   "StreamName": "string"
}
```

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

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

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

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

 ** [CurrentVersion](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-CurrentVersion"></a>
您想要變更其保留期間之串流的版本。若要取得 版本，請呼叫 `DescribeStream`或 `ListStreams` API。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`[a-zA-Z0-9]+`  
必要：是

 ** [DataRetentionChangeInHours](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-DataRetentionChangeInHours"></a>
調整目前保留的時數。您指定的值會根據 新增至目前值或從中減去`operation`。  
資料保留的最小值為 0，最大值為 87600 （十年）。  
類型：整數  
有效範圍：最小值為 1。  
必要：是

 ** [Operation](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-Operation"></a>
指出您是否要增加或減少保留期間。  
類型：字串  
有效值:`INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION`   
必要：是

 ** [StreamARN](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-StreamARN"></a>
您要變更其保留期間之串流的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`  
必要：否

 ** [StreamName](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-StreamName"></a>
您要變更其保留期間之串流的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z0-9_.-]+`  
必要：否

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

```
HTTP/1.1 200
```

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

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

## 錯誤
<a name="API_UpdateDataRetention_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_UpdateDataRetention_SeeAlso"></a>

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