UpdateDataRetention - Amazon Kinesis Video Streams
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラーその他の参照資料

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

UpdateDataRetention

ストリームのデータ保持期間を指定した値で増減します。データ保持期間を延長するか短縮するかを指定するには、リクエスト本文の Operation パラメータを指定します。リクエストでは、StreamName または StreamARN のパラメータを指定する必要があります。

この操作には KinesisVideo:UpdateDataRetention アクションに対するアクセス許可が必要です。

データ保持期間を変更すると、ストリーム内のデータに次のように影響します。

  • データ保持期間を延長すると、既存のデータは新しい保持期間で保持されます。例えば、データ保持期間を 1 時間から 7 時間に延長すると、既存のすべてのデータが 7 時間保持されます。

  • データ保持期間が短縮されると、既存のデータは新しい保存期間にわたって保持されます。例えば、データ保持期間が 7 時間から 1 時間に短縮すると、既存のすべてのデータが 1 時間保持され、1 時間より古いデータは直ちに削除されます。

リクエストの構文

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

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

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

CurrentVersion

保持期間を変更するストリームのバージョン。バージョンを取得するには、DescribeStream またはListStreams API を呼び出します。

型: 文字列

長さの制限：最小長は 1 です。最大長は 64 文字です。

パターン: [a-zA-Z0-9]+

必須：はい

DataRetentionChangeInHours

現在の保存期間を調整する時間数。指定した値は、に応じて現在の値に加算または減算されます。operation

データ保持の最小値は 0 で、最大値は 87600 (10 年) です。

タイプ：整数

値の範囲: 最小値 は 1 です。

必須: はい

Operation

保持期間を増減させるかどうかを示します。

型: 文字列

有効な値：INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION

必須: はい

StreamARN

保持期間を変更するストリームの Amazon リソースネーム (ARN)。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 1,024 です。

パターン: 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

呼び出し元には、この操作を実行するための権限がありません。

HTTP ステータスコード: 401

ResourceInUseException

StreamARNChannelARNCLOUD_STORAGE_MODE入力または入力が既に別の Kinesis Video Stream リソースにマッピングされている場合、StreamARNChannelARNまたは提供された入力がアクティブステータスでない場合は、次のいずれかを試してください。

  1. DescribeMediaStorageConfigurationAPI は、特定のチャンネルがどのストリームにマップされているかを判断します。

  2. 特定のストリームがマップされているチャンネルを決定するための DescribeMappedResourceConfiguration API。

  3. DescribeStreamまたは DescribeSignalingChannel API を使用してリソースのステータスを判断します。

HTTP ステータスコード：400

ResourceNotFoundException

Amazon Kinesis Video Streams は、指定したストリームを見つけることができません。

HTTP ステータスコード: 404

VersionMismatchException

指定したストリームバージョンは最新バージョンではありません。最新バージョンを入手するには DescribeStreamAPI を使用してください。

HTTP ステータスコード：400

その他の参照資料

この API を言語固有の AWS SDK で使用する方法について詳しくは、以下を参照してください。