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

UpdateSignalingChannel

Aktualisiert den vorhandenen Signalkanal. Dies ist ein asynchroner Vorgang, dessen Abschluss einige Zeit in Anspruch nimmt.

Wenn der MessageTtlSeconds Wert aktualisiert (entweder erhöht oder reduziert) wird, gilt er nur für neue Nachrichten, die über diesen Kanal gesendet wurden, nachdem er aktualisiert wurde. Bestehende Nachrichten sind weiterhin gemäß dem vorherigen MessageTtlSeconds Wert abgelaufen.

Anforderungssyntax

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

{
   "ChannelARN": "string",
   "CurrentVersion": "string",
   "SingleMasterConfiguration": { 
      "MessageTtlSeconds": number
   }
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ChannelARN

Der Amazon-Ressourcenname (ARN) des Signalkanals, den Sie aktualisieren möchten.

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: Ja

CurrentVersion

Die aktuelle Version des Signalkanals, den Sie aktualisieren möchten.

Typ: Zeichenfolge

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

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

Erforderlich: Ja

SingleMasterConfiguration

Die Struktur, die die Konfiguration für den SINGLE_MASTER Typ des Signalkanals enthält, den Sie aktualisieren möchten. Dieser Parameter und die Kanalnachrichten time-to-live sind für Kanäle mit dem SINGLE_MASTER Kanaltyp erforderlich.

Typ: SingleMasterConfiguration Objekt

Erforderlich: Nein

Antwortsyntax

HTTP/1.1 200

Antwortelemente

Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.

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

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

VersionMismatchException

Die von Ihnen angegebene Stream-Version ist nicht die neueste Version. Verwenden Sie die DescribeStreamAPI, um die neueste Version zu erhalten.

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

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