翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# 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 (10 年) です。  
タイプ: 整数  
値の範囲: 最小値 は 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 リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最小長は 1 です。最大長は 1,024 です。  
パターン: `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`が既に別の Kinesis Video Stream リソースに`CLOUD_STORAGE_MODE`マッピングされている場合、または指定された入力 `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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateDataRetention)