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

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

StartEdgeConfigurationUpdate

可更新串流現有邊緣設定的非同步 API。Kinesis 視訊串流會將串流的邊緣設定與在 IoT 中樞裝置上執行的邊緣代理程式 IoT Greengrass 元件同步，並在您的內部部署進行設定。同步的時間可能會有所不同，並取決於集線器裝置的連線能力。SyncStatus將在確認邊緣組態並與 Edge 代理程式同步時更新。

如果第一次叫用此 API，則會為串流建立新的 Edge 設定，並將同步狀態設定為SYNCING。在再次使用此 API 之前IN_SYNC，您必須等待同步狀態達到終端狀態SYNC_FAILED，例如：，或者。如果您在同步過程中調用此 API，則ResourceInUseException將拋出。串流邊緣設定和 Edge 代理程式的連線會重試 15 分鐘。15 分鐘後，狀態將轉換為狀SYNC_FAILED態。

若要將邊緣組態從一個裝置移至另一個裝置，請使用DeleteEdgeConfiguration來刪除目前的邊緣組態。然後，您可以使用更新 StartEdgeConfigurationUpdate 的集線器裝置 ARN 呼叫。

注意

AWS 非洲 (開普敦) 地區 af-south-1 不提供此 API。

請求語法

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

呼叫更新程序所需的 Edge 組態詳細資訊。

類型：EdgeConfig 物件

必要：是

StreamARN

串流的 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

要更新其邊緣配置的流的名稱。指定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

第一次建立串流邊緣設定的時間戳記。

類型：Timestamp

EdgeConfig

將用來與邊緣代理程式 IoT Greengrass 元件同步處理之串流邊緣設定的說明。Edge 代理程式元件將在您的內部部署的 IoT 中樞裝置設定上執行。

類型：EdgeConfig 物件

FailedStatusDetails

產生失敗狀態的描述。

類型：字串

LastUpdatedTime

上次更新串流邊緣設定的時間戳記。

類型：Timestamp

StreamARN

串流的 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

邊緣組態已更新來源的資料流名稱。

類型：字串

長度限制：長度下限為 1。長度上限為 256。

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

SyncStatus

串流邊緣設定的目前同步狀態。當您調用此 API 時，同步狀態將設置為狀SYNCING態。使用 DescribeEdgeConfiguration API 取得邊緣設定的最新狀態。

類型：字串

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

錯誤

如需所有動作常見錯誤的資訊，請參閱常見錯誤。

AccessDeniedException

您沒有執行此作業所需的權限。

狀態碼：

ClientLimitExceededException

Kinesis Video Streams 已限制要求，因為您已經超過允許的用戶端呼叫限制。稍後再嘗試撥打電話。

HTTP 狀態碼：400

InvalidArgumentException

此輸入參數的值無效。

HTTP 狀態碼：400

NoDataRetentionException

以小時為單位的串流資料保留等於零。

HTTP 狀態碼：400

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

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：