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

StartEdgeConfigurationUpdate

Eine asynchrone API, die die bestehende Edge-Konfiguration eines Streams aktualisiert. Der Kinesis Video Stream synchronisiert die Edge-Konfiguration des Streams mit der Edge Agent IoT Greengrass-Komponente, die auf einem bei Ihnen vor Ort eingerichteten IoT Hub-Gerät ausgeführt wird. Die Dauer der Synchronisierung kann variieren und hängt von der Konnektivität des Hub-Geräts ab. Das SyncStatus wird aktualisiert, sobald die Edge-Konfiguration bestätigt und mit dem Edge-Agenten synchronisiert wird.

Wenn diese API zum ersten Mal aufgerufen wird, wird eine neue Edge-Konfiguration für den Stream erstellt, und der Synchronisierungsstatus wird auf gesetzt. SYNCING Sie müssen warten, bis der Synchronisierungsstatus einen Terminalstatus wie: oder erreicht hat IN_SYNCSYNC_FAILED, bevor Sie diese API erneut verwenden können. Wenn Sie diese API während des Synchronisierungsvorgangs aufrufen, ResourceInUseException wird a ausgelöst. Die Verbindung zwischen der Edge-Konfiguration des Streams und dem Edge-Agenten wird für 15 Minuten erneut versucht. Nach 15 Minuten wechselt der Status in den SYNC_FAILED Status.

Um eine Edge-Konfiguration von einem Gerät auf ein anderes zu verschieben, verwenden Sie, DeleteEdgeConfiguration um die aktuelle Edge-Konfiguration zu löschen. Sie können dann StartEdgeConfigurationUpdate mit einem aktualisierten Hub-Geräte-ARN aufrufen.

Anmerkung

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

Anforderungssyntax

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

{
   "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"
         }
      }
   },
   "StreamARN": "string",
   "StreamName": "string"
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

EdgeConfig

Die Edge-Konfigurationsdetails, die zum Aufrufen des Aktualisierungsvorgangs erforderlich sind.

Typ: EdgeConfig Objekt

Erforderlich: Ja

StreamARN

Der Amazon-Ressourcenname (ARN) des -Stream. Geben Sie entweder den StreamName oder den anStreamARN.

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

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 aktuelle Synchronisierungsstatus der Edge-Konfiguration des Streams. Wenn Sie diese API aufrufen, wird der Synchronisierungsstatus auf den SYNCING Status gesetzt. Verwenden Sie die DescribeEdgeConfiguration API, um den neuesten Status der Edge-Konfiguration abzurufen.

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

NoDataRetentionException

Die Stream-Datenspeicherung in Stunden ist gleich Null.

HTTP Status Code: 400

ResourceInUseException

Wenn der Eingang StreamARN oder ChannelARN Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet CLOUD_STORAGE_MODE ist oder wenn sich der angegebene Eingang StreamARN oder Eingang nicht im Status Aktiv ChannelARN befindet, versuchen Sie es mit einer der folgenden Methoden:

  1. Die DescribeMediaStorageConfiguration API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.

  2. Die DescribeMappedResourceConfiguration API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.

  3. Die DescribeStream oder DescribeSignalingChannel API zur Bestimmung des Status der Ressource.

HTTP Status Code: 400

ResourceNotFoundException

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

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: