UpdateStream - Amazon Kinesis Video Streams
请求语法URI 请求参数请求体响应语法响应元素错误另请参阅

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

UpdateStream

更新直播元数据，例如设备名称和媒体类型。

您必须提供直播名称或直播的 Amazon 资源名称 (ARN)。

要确保在更新直播之前拥有最新版本，可以指定直播版本。Kinesis Video Streams 为每个直播分配一个版本。当你更新直播时，Kinesis Video Streams 会分配一个新的版本号。要获取最新的直播版本，请使用 DescribeStream API。

UpdateStream是一种异步操作，需要一段时间才能完成。

请求语法

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

{
   "CurrentVersion": "string",
   "DeviceName": "string",
   "MediaType": "string",
   "StreamARN": "string",
   "StreamName": "string"
}

URI 请求参数

该请求不使用任何 URI 参数。

请求体

请求接受采用 JSON 格式的以下数据。

CurrentVersion

您要更新其元数据的直播的版本。

类型：字符串

长度限制：长度下限为 1。长度上限为 64。

模式：[a-zA-Z0-9]+

必需：是

DeviceName

正在写入流的设备的名称。

注意

在当前的实现中，Kinesis Video Streams 没有使用这个名称。

类型：字符串

长度限制：长度下限为 1。长度上限为 128。

模式：[a-zA-Z0-9_.-]+

必需：否

MediaType

直播的媒体类型。用于MediaType向直播的使用者指定流中包含的内容类型。有关媒体类型的更多信息，请参阅媒体类型。如果您选择指定MediaType，请参阅命名要求。

要在主机上播放视频，必须指定正确的视频类型。例如，如果流中的视频是 H.264，则指定video/h264为。MediaType

类型：字符串

长度限制：长度下限为 1。长度上限为 128。

模式：[\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*

必需：否

StreamARN

您要更新其元数据的直播的 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

呼叫者无权执行此操作。

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

亚马逊 Kinesis Video Streams 找不到你指定的直播。

HTTP 状态代码：404

VersionMismatchException

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

HTTP 状态代码：400

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：