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

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

UpdateDataRetention

依照您指定的值增加或減少串流的資料保留期間。若要指出您要增加或縮短資料保留期間，請在要求主體中指定Operation參數。在請求中，您必須指定StreamName或StreamARN。

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

變更資料保留期限會影響串流中的資料，如下所示：

  • 如果資料保留期間增加，現有資料會保留新的保留期間。例如，如果資料保留期從一小時增加到七小時，則所有現有資料都會保留 7 小時。

  • 如果資料保留期間縮短，則會在新的保留期間內保留現有資料。例如，如果資料保留時間從 7 小時縮短為一小時，則所有現有資料都會保留一小時，且會立即刪除超過一小時的任何資料。

請求語法

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 (十年)。

類型：整數

有效範圍：最小值為 1。

必要：是

Operation

指出您要增加或減少保留期間。

類型：字串

有效值:INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION

必要：是

StreamARN

您要變更其保留期的資料流的 Amazon 資源名稱 (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

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

狀態碼：4

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