ListEdgeAgentConfigurations - Amazon Kinesis Video Streams
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

ListEdgeAgentConfigurations

Gibt ein Array von Edge-Konfigurationen zurück, die dem angegebenen Edge-Agenten zugeordnet sind.

In der Anfrage müssen Sie den Edge-Agent angebenHubDeviceArn.

Anmerkung

Diese API ist in der Region AWS Afrika (Kapstadt), af-south-1, nicht verfügbar.

Anforderungssyntax

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

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

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

HubDeviceArn

Das „Internet der Dinge (IoT) -Ding“ Arn of the Edge Agent.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 1024 Zeichen.

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

Erforderlich: Ja

MaxResults

Die maximale Anzahl von Edge-Konfigurationen, die in der Antwort zurückgegeben werden sollen. Der Standardwert ist 5.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 1. Maximalwert 10.

Erforderlich: Nein

NextToken

Wenn Sie diesen Parameter angeben und das Ergebnis einer ListEdgeAgentConfigurations Operation gekürzt wird, gibt der Aufruf NextToken in der Antwort den zurück. Um einen weiteren Stapel von Edge-Konfigurationen zu erhalten, geben Sie dieses Token in Ihrer nächsten Anfrage an.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge von 512.

Pattern: [a-zA-Z0-9+/=]*

Erforderlich: Nein

Antwortsyntax

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"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

EdgeConfigs

Eine Beschreibung der Edge-Konfiguration eines einzelnen Streams.

Typ: Array von ListEdgeAgentConfigurationsEdgeConfig-Objekten

NextToken

Wenn die Antwort gekürzt wird, gibt der Aufruf dieses Element mit einem bestimmten Token zurück. Verwenden Sie dieses Token in Ihrer nächsten Anfrage, um den nächsten Stapel von Edge-Konfigurationen abzurufen.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge von 512.

Pattern: [a-zA-Z0-9+/=]*

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

ClientLimitExceededException

Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.

HTTP Status Code: 400

InvalidArgumentException

Der Wert für diesen Eingabeparameter ist ungültig.

HTTP Status Code: 400

NotAuthorizedException

Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.

HTTP-Statuscode: 401

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: