翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListEdgeAgentConfigurations
指定した Edge Agent に関連付けられているエッジ構成の配列を返します。
リクエストでは、Edge エージェントを指定する必要がありますHubDeviceArn。
注記
この API AWS はアフリカ (ケープタウン) リージョン af-south-1 ではご利用いただけません。
リクエストの構文
POST /listEdgeAgentConfigurations HTTP/1.1
Content-type: application/json
{
"HubDeviceArn": "string",
"MaxResults": number,
"NextToken": "string"
}URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- HubDeviceArn
-
エッジエージェントの「モノのインターネット (IoT) モノ」。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 1,024 です。
Pattern:
arn:[a-z\d-]+:iot:[a-z0-9-]+:[0-9]+:thing/[a-zA-Z0-9_.-]+必須：はい
- MaxResults
-
レスポンスで返されるエッジ設定の最大数。デフォルトは 5 です。
タイプ：整数
値の範囲: 最小値 は 1 です。最大値は 10 です。
必須: いいえ
- NextToken
-
このパラメータを指定すると、
ListEdgeAgentConfigurations操作の結果が切り捨てられ、呼び出しはレスポンスでNextTokenを返します。エッジ設定の別のバッチを取得するには、次のリクエストでこのトークンを渡してください。型: 文字列
長さの制限: 最小長は 0 です。最大長は 512 です。
Pattern:
[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
その他の参照資料
言語固有の AWS SDK の 1 つでこの API を使用する方法の詳細については、以下を参照してください。
