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

UpdateDataRetention

Erhöht oder verringert die Datenaufbewahrungsdauer des Streams um den von Ihnen angegebenen Wert. Um anzugeben, ob Sie die Datenaufbewahrungsdauer verlängern oder verkürzen möchten, geben Sie den Operation Parameter im Anfragetext an. In der Anfrage müssen Sie entweder den StreamName oder den angebenStreamARN.

Diese Operation setzt eine Berechtigung für die KinesisVideo:UpdateDataRetention-Aktion voraus.

Eine Änderung der Aufbewahrungsfrist für Daten wirkt sich wie folgt auf die Daten im Stream aus:

  • Wenn die Datenaufbewahrungsfrist verlängert wird, werden bestehende Daten für die neue Aufbewahrungsfrist aufbewahrt. Wenn beispielsweise die Datenaufbewahrungsdauer von einer Stunde auf sieben Stunden verlängert wird, werden alle vorhandenen Daten sieben Stunden lang aufbewahrt.

  • Wenn die Datenaufbewahrungsdauer verkürzt wird, werden die vorhandenen Daten für die neue Aufbewahrungsfrist aufbewahrt. Wenn beispielsweise die Datenaufbewahrungsdauer von sieben Stunden auf eine Stunde verkürzt wird, werden alle vorhandenen Daten für eine Stunde aufbewahrt, und alle Daten, die älter als eine Stunde sind, werden sofort gelöscht.

Anforderungssyntax

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

{
   "CurrentVersion": "string",
   "DataRetentionChangeInHours": number,
   "Operation": "string",
   "StreamARN": "string",
   "StreamName": "string"
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

CurrentVersion

Die Version des Streams, dessen Aufbewahrungszeitraum Sie ändern möchten. Um die Version abzurufen, rufen Sie entweder die DescribeStream oder die ListStreams API auf.

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

DataRetentionChangeInHours

Die Anzahl der Stunden, um die die aktuelle Aufbewahrung angepasst werden soll. Der von Ihnen angegebene Wert wird zum aktuellen Wert addiert oder von diesem subtrahiert, abhängig von. operation

Der Mindestwert für die Datenspeicherung ist 0 und der Höchstwert ist 87600 (zehn Jahre).

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 1.

Erforderlich: Ja

Operation

Gibt an, ob Sie die Aufbewahrungsdauer verlängern oder verkürzen möchten.

Typ: Zeichenfolge

Zulässige Werte: INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION

Erforderlich: Ja

StreamARN

Der Amazon-Ressourcenname (ARN) des Streams, dessen Aufbewahrungszeitraum Sie ändern 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: Nein

StreamName

Der Name des Streams, dessen Aufbewahrungszeitraum Sie ändern möchten.

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

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.

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

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 einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: