UpdateDataRetention - Amazon Kinesis Video Streams
请求语法URI 请求参数请求正文响应语法响应元素错误另请参阅
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

UpdateDataRetention

按您指定的值增加或减少数据流的数据保留期。要指明您是要延长还是缩短数据保留期，请在请求正文中指定Operation参数。在请求中，您必须指定StreamName或StreamARN。

此操作需要 KinesisVideo:UpdateDataRetention 操作权限。

更改数据保留期会对流中的数据产生如下影响：

  • 如果延长了数据保留期，则现有数据将在新的保留期内保留。例如，如果数据保留期从一小时延长到七小时，则所有现有数据将保留七个小时。

  • 如果缩短了数据保留期，则现有数据将在新的保留期内保留。例如，如果数据保留期从七小时缩短到一小时，则所有现有数据将保留一小时，并且任何超过一小时的数据都将立即删除。

请求语法

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。

类型：字符串

长度限制：最小长度为 0。最大长度为 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

您要更改其保留期的直播名称。

类型：字符串

长度限制：最小长度为 0。长度上限为 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

如果输入StreamARN或ChannelARN输入已映射到其他 Kinesis Video Stream 资源，或者提供的输入StreamARN或未ChannelARN处于 “活动” 状态，请尝试以下方法之一：CLOUD_STORAGE_MODE

  1. 用于确定给定频道的直播映射到什么的 DescribeMediaStorageConfiguration API。

  2. 用于确定给定直播映射到哪个频道的 DescribeMappedResourceConfiguration API。

  3. DescribeStream或 DescribeSignalingChannel API，用于确定资源状态。

HTTP 状态代码：400

ResourceNotFoundException

Amazon Kinesis Video Streams 找不到你指定的直播。

HTTP 状态代码：404

VersionMismatchException

您指定的直播版本不是最新版本。要获取最新版本，请使用 DescribeStreamAPI。

HTTP 状态代码：400

另请参阅

有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：