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

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

ListEdgeAgentConfigurations

傳回與指定 Edge 代理程式相關聯的邊緣組態陣列。

在要求中，您必須指定 Edge 代理程式HubDeviceArn。

注意

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

請求語法

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

{
   "HubDeviceArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}

URI 請求參數

請求不會使用任何 URI 參數。

請求主體

請求接受採用 JSON 格式的下列資料。

HubDeviceArn

邊緣代理程式的「物聯網 (IoT) 物聯網」Arn。

類型：字串

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

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

必要：是

MaxResults

要在回應中傳回的邊緣組態數目上限。預設值為 5。

類型：整數

有效範圍：最小值為 1。最大值為 10。

必要：否

NextToken

如果您指定此參數，當截斷ListEdgeAgentConfigurations作業的結果時，呼叫會在回應NextToken中傳回。要獲取另一批 Edge 配置，請在下一個請求中提供此令牌。

類型：字串

長度限制：長度下限為 0。長度上限為 512。

模式：[a-zA-Z0-9+/=]*

必要：否

回應語法

HTTP/1.1 200
Content-type: application/json

{
   "EdgeConfigs": [ 
      { 
         "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"
      }
   ],
   "NextToken": "string"
}

回應元素

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

EdgeConfigs

單一資料流邊緣設定的描述。

類型：ListEdgeAgentConfigurationsEdgeConfig 物件陣列

NextToken

如果響應被截斷，調用返回帶有給定令牌的這個元素。要獲取下一批 Edge 配置，請在下一個請求中使用此令牌。

類型：字串

長度限制：長度下限為 0。長度上限為 512。

模式：[a-zA-Z0-9+/=]*

錯誤

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

ClientLimitExceededException

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

HTTP 狀態碼：400

InvalidArgumentException

此輸入參數的值無效。

HTTP 狀態碼：400

NotAuthorizedException

呼叫者沒有執行此操作的授權。

狀態碼：

另請參閱

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