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

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

StartEdgeConfigurationUpdate

更新流的现有 Edge 配置的异步 API。Kinesis Video Stream 会将直播的边缘配置与在物联网中心设备上运行的 Edge Agent IoT Greengrass 组件同步，并在您的场所设置。同步时间可能有所不同，具体取决于集线器设备的连接。这个SyncStatus将在确认边缘配置后进行更新，并与 Edge Agent 同步。

如果首次调用此 API，则将为该流创建一个新的 Edge 配置，同步状态将设置为SYNCING。你必须等待同步状态达到终端状态，例如：IN_SYNC，或SYNC_FAILED，然后再次使用此 API。如果您在同步过程中调用此 API，ResourceInUseException将被抛出。将在 15 分钟内重试直播边缘配置和 Edge Agent 的连接。15 分钟后，状态将转换为SYNC_FAILED州。

要将 Edge 配置从一台设备移动到另一台设备，请使用DeleteEdgeConfiguration删除当前的 Edge 配置。然后你可以调用StartEdgeConfigurationUpdate使用更新的集线器设备 ARN。

注意

此 API 在中不可用Amazon非洲（开普敦）区域，af-south-1。

请求语法

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

{
   "EdgeConfig": { 
      "DeletionConfig": { 
         "DeleteAfterUpload": boolean,
         "EdgeRetentionInHours": number,
         "LocalSizeConfig": { 
            "MaxLocalMediaSizeInMB": number,
            "StrategyOnFullSize": "string"
         }
      },
      "HubDeviceArn": "string",
      "RecorderConfig": { 
         "MediaSourceConfig": { 
            "MediaUriSecretArn": "string",
            "MediaUriType": "string"
         },
         "ScheduleConfig": { 
            "DurationInSeconds": number,
            "ScheduleExpression": "string"
         }
      },
      "UploaderConfig": { 
         "ScheduleConfig": { 
            "DurationInSeconds": number,
            "ScheduleExpression": "string"
         }
      }
   },
   "StreamARN": "string",
   "StreamName": "string"
}

URI 请求参数

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

请求正文

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

EdgeConfig

调用更新过程所需的边缘配置详细信息。

类型：EdgeConfig 对象

必需：是

StreamARN

流的 Amazon 资源名称（ARN）。指定任一StreamName或者StreamARN。

类型：字符串

长度限制：最小长度为 1。长度上限为 1024。

模式：arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

必需：否

StreamName

要更新其边缘配置的流的名称。指定任一StreamName或者StreamARN。

类型：字符串

长度限制：最小长度为 1。长度上限为 256。

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

必需：否

响应语法

HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "EdgeConfig": { 
      "DeletionConfig": { 
         "DeleteAfterUpload": boolean,
         "EdgeRetentionInHours": number,
         "LocalSizeConfig": { 
            "MaxLocalMediaSizeInMB": number,
            "StrategyOnFullSize": "string"
         }
      },
      "HubDeviceArn": "string",
      "RecorderConfig": { 
         "MediaSourceConfig": { 
            "MediaUriSecretArn": "string",
            "MediaUriType": "string"
         },
         "ScheduleConfig": { 
            "DurationInSeconds": number,
            "ScheduleExpression": "string"
         }
      },
      "UploaderConfig": { 
         "ScheduleConfig": { 
            "DurationInSeconds": number,
            "ScheduleExpression": "string"
         }
      }
   },
   "FailedStatusDetails": "string",
   "LastUpdatedTime": number,
   "StreamARN": "string",
   "StreamName": "string",
   "SyncStatus": "string"
}

响应元素

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

CreationTime

首次创建流边缘配置的时间戳。

类型：时间戳

EdgeConfig

直播边缘配置的描述，该配置将用于与 Edge Agent IoT Greengrass 组件同步。Edge Agent 组件将在您的场所的 IoT 中心设备设置上运行。

类型：EdgeConfig 对象

FailedStatusDetails

生成的故障状态的描述。

类型：字符串

LastUpdatedTime

上次更新流边缘配置的时间戳。

类型：时间戳

StreamARN

流的 Amazon 资源名称（ARN）。

类型：字符串

长度限制：最小长度为 1。长度上限为 1024。

模式：arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

StreamName

更新 Edge 配置的流的名称。

类型：字符串

长度限制：最小长度为 1。长度上限为 256。

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

SyncStatus

直播边缘配置的当前同步状态。当您调用此 API 时，同步状态将设置为SYNCING州。使用DescribeEdgeConfiguration用于获取边缘配置最新状态的 API。

类型：字符串

有效值：SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED

错误

有关所有操作常见错误的信息，请参见常见错误。

AccessDeniedException

您没有执行此操作所需的权限。

HTTP 状态码：401

ClientLimitExceededException

Kinesis Video Streams 限制了该请求，因为您已超过允许的客户端呼叫限制。稍后再试打电话。

HTTP 状态代码：400

InvalidArgumentException

此输入参数的值无效。

HTTP 状态代码：400

NoDataRetentionException

Stream 数据保留时间（以小时为单位）等于零。

HTTP 状态代码：400

ResourceInUseException

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

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

  2. 这个DescribeMappedResourceConfiguration用于确定给定流映射到的频道的 API。

  3. 这个DescribeStream要么DescribeSignalingChannel用于确定资源状态的 API。

HTTP 状态代码：400

ResourceNotFoundException

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

HTTP 状态代码：404

另请参阅

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