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

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

ListEdgeAgentConfigurations

返回与指定 Edge Agent 关联的边缘配置数组。

在请求中，您必须指定边缘代理HubDeviceArn。

注意

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

请求语法

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中返回。要获得另一批边缘配置，请在下次请求中提供此令牌。

类型：字符串

长度约束：最小长度为 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

如果响应被截断，则调用将返回带有给定令牌的此元素。要获取下一批边缘配置，请在下一个请求中使用此令牌。

类型：字符串

长度约束：最小长度为 0。最大长度为 512。

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

错误

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

ClientLimitExceededException

Kinesis Video Streams 已限制该请求，因为你已超过允许的客户端调用限制。稍后再尝试拨打电话。

HTTP 状态代码：400

InvalidArgumentException

此输入参数的值无效。

HTTP 状态代码：400

NotAuthorizedException

呼叫者无权执行此操作。

HTTP 状态代码：401

另请参阅

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