本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # StartEdgeConfigurationUpdate 非同步 API，可更新串流的現有邊緣組態。Kinesis Video Stream 會將串流的邊緣組態與在 IoT Hub 裝置上執行的 Edge Agent IoT Greengrass 元件同步，該元件會在您現場部署中設定。同步的時間可能會有所不同，取決於 Hub 裝置的連線能力。`SyncStatus` 會在確認邊緣組態時更新，並與 Edge Agent 同步。如果第一次叫用此 API，則會為串流建立新的邊緣組態，並將同步狀態設定為 `SYNCING`。您必須等待同步狀態達到終端狀態，例如： `IN_SYNC`或 `SYNC_FAILED`，才能再次使用此 API。如果您在同步程序期間叫用此 API，`ResourceInUseException`則會擲回。串流邊緣組態和 Edge Agent 的連線將會重試 15 分鐘。15 分鐘後，狀態會轉換為 `SYNC_FAILED` 狀態。若要將邊緣組態從一個裝置移至另一個裝置，請使用 [DeleteEdgeConfiguration](API_DeleteEdgeConfiguration.md)刪除目前的邊緣組態。然後，您可以使用更新的 Hub 裝置 ARN 叫用 StartEdgeConfigurationUpdate。 **注意** 此 API 不適用於 AWS 非洲（開普敦）區域 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](#API_StartEdgeConfigurationUpdate_RequestSyntax) ** 叫用更新程序所需的邊緣組態詳細資訊。類型：[EdgeConfig](API_EdgeConfig.md) 物件必要：是 ** [StreamARN](#API_StartEdgeConfigurationUpdate_RequestSyntax) ** 串流的 Amazon Resource Name (ARN)。指定 `StreamName`或 `StreamARN`。類型：字串長度限制：長度下限為 1。長度上限為 1024。模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` 必要：否 ** [StreamName](#API_StartEdgeConfigurationUpdate_RequestSyntax) ** 您要更新其邊緣組態的串流名稱。指定 `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](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 第一次建立串流邊緣組態的時間戳記。類型：Timestamp ** [EdgeConfig](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 串流邊緣組態的描述，將用於與 Edge Agent IoT Greengrass 元件同步。Edge Agent 元件會在您現場部署的 IoT Hub 裝置設定上執行。類型：[EdgeConfig](API_EdgeConfig.md) 物件 ** [FailedStatusDetails](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 所產生失敗狀態的描述。類型：字串 ** [LastUpdatedTime](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 上次更新串流邊緣組態的時間戳記。類型：Timestamp ** [StreamARN](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 串流的 Amazon Resource Name (ARN)。類型：字串長度限制：長度下限為 1。長度上限為 1024。模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` ** [StreamName](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 邊緣組態更新來源的串流名稱。類型：字串長度限制：長度下限為 1。長度上限為 256。模式：`[a-zA-Z0-9_.-]+` ** [SyncStatus](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 串流邊緣組態的目前同步狀態。當您叫用此 API 時，同步狀態會設為 `SYNCING` 狀態。使用 `DescribeEdgeConfiguration` API 取得邊緣組態的最新狀態。類型：字串有效值:`SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。 ** AccessDeniedException ** 您沒有執行此操作所需的許可。 HTTP 狀態碼：401 ** ClientLimitExceededException ** Kinesis Video Streams 已調節請求，因為您已超過允許的用戶端呼叫限制。稍後嘗試進行呼叫。 HTTP 狀態碼：400 ** InvalidArgumentException ** 此輸入參數的值無效。 HTTP 狀態碼：400 ** NoDataRetentionException ** 串流資料保留小時數等於零。 HTTP 狀態碼：400 ** ResourceInUseException ** 當輸入`StreamARN`或 `ChannelARN` 中的 `CLOUD_STORAGE_MODE` 已映射至不同的 Kinesis Video Stream 資源，或提供的輸入`StreamARN`或 `ChannelARN` 未處於作用中狀態時，請嘗試下列其中一個： 1. 用於判斷串流指定頻道所對應的 `DescribeMediaStorageConfiguration` API。 1. 用於判斷指定串流所對應的頻道的 `DescribeMappedResourceConfiguration` API。 1. 用於判斷資源狀態的 `DescribeStream`或 `DescribeSignalingChannel` API。 HTTP 狀態碼：400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams 找不到您指定的串流。 HTTP 狀態碼：404 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate)