DescribeEdgeConfiguration - 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.

DescribeEdgeConfiguration

Beschreibt die Edge-Konfiguration eines Streams, die mithilfe der StartEdgeConfigurationUpdate API festgelegt wurde, und den aktuellen Status der Recorder- und Uploader-Jobs des Edge-Agenten. Verwenden Sie diese API, um den Status der Konfiguration abzurufen und festzustellen, ob die Konfiguration mit dem Edge-Agent synchronisiert ist. Verwenden Sie diese API, um den Zustand des Edge-Agenten zu bewerten.

Anmerkung

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

Anforderungssyntax

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

{
   "StreamARN": "string",
   "StreamName": "string"
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

StreamARN

Der Amazon-Ressourcenname (ARN) des -Stream. Geben Sie entweder den oder den anStreamName. StreamARN

Typ: Zeichenfolge

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

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

Erforderlich: Nein

StreamName

Der Name des Streams, dessen Edge-Konfiguration Sie aktualisieren möchten. Geben Sie entweder den StreamName oder den anStreamARN.

Typ: Zeichenfolge

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

Pattern: [a-zA-Z0-9_.-]+

Erforderlich: Nein

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "EdgeAgentStatus": { 
      "LastRecorderStatus": { 
         "JobStatusDetails": "string",
         "LastCollectedTime": number,
         "LastUpdatedTime": number,
         "RecorderStatus": "string"
      },
      "LastUploaderStatus": { 
         "JobStatusDetails": "string",
         "LastCollectedTime": number,
         "LastUpdatedTime": number,
         "UploaderStatus": "string"
      }
   },
   "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"
}

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.

CreationTime

Der Zeitstempel, zu dem die Edge-Konfiguration eines Streams zum ersten Mal erstellt wurde.

Typ: Zeitstempel

EdgeAgentStatus

Ein Objekt, das die neuesten Statusdetails für die Recorder- und Uploader-Jobs eines Edge-Agenten enthält. Verwenden Sie diese Informationen, um den aktuellen Zustand eines Edge-Agents zu ermitteln.

Typ: EdgeAgentStatus Objekt

EdgeConfig

Eine Beschreibung der Edge-Konfiguration des Streams, die für die Synchronisierung mit der Edge Agent IoT Greengrass-Komponente verwendet wird. Die Edge Agent-Komponente wird auf einem IoT Hub-Gerät ausgeführt, das bei Ihnen vor Ort eingerichtet ist.

Typ: EdgeConfig Objekt

FailedStatusDetails

Eine Beschreibung des generierten Fehlerstatus.

Typ: Zeichenfolge

LastUpdatedTime

Der Zeitstempel, zu dem die Edge-Konfiguration eines Streams zuletzt aktualisiert wurde.

Typ: Zeitstempel

StreamARN

Der Amazon-Ressourcenname (ARN) des -Stream.

Typ: Zeichenfolge

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

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

StreamName

Der Name des Streams, von dem aus die Edge-Konfiguration aktualisiert wurde.

Typ: Zeichenfolge

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

Pattern: [a-zA-Z0-9_.-]+

SyncStatus

Der neueste Status des Edge-Konfigurationsupdates.

Typ: Zeichenfolge

Zulässige Werte: SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED

Fehler

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

AccessDeniedException

Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.

HTTP-Statuscode: 401

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

ResourceNotFoundException

Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.

HTTP Status Code: 404

StreamEdgeConfigurationNotFoundException

Die Ausnahme wurde gerendert, wenn Amazon Kinesis Video Stream die von Ihnen angegebene Edge-Konfiguration eines Streams nicht finden kann.

HTTP Status Code: 404

Weitere Informationen finden Sie unter:

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