StreamJournalToKinesis - Amazon Quantum Ledger-Datenbank (AmazonQLDB)
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.

StreamJournalToKinesis

Erstellt einen Journal-Stream für ein bestimmtes Amazon QLDB-Ledger. Der Stream erfasst jede Dokumentversion, die im Journal des Ledgers festgeschrieben wurde, und liefert die Daten an eine angegebene Amazon Kinesis Data Streams-Ressource.

Anforderungssyntax

POST /ledgers/name/journal-kinesis-streams HTTP/1.1
Content-type: application/json

{
   "ExclusiveEndTime": number,
   "InclusiveStartTime": number,
   "KinesisConfiguration": { 
      "AggregationEnabled": boolean,
      "StreamArn": "string"
   },
   "RoleArn": "string",
   "StreamName": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

name

Der Name des Ledgers.

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

Pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Erforderlich: Ja

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ExclusiveEndTime

Das exklusive Datum und die Uhrzeit, die angeben, wann der Stream endet. Wenn Sie diesen Parameter nicht definieren, wird der Stream auf unbestimmte Zeit ausgeführt, bis Sie ihn abbrechen.

ExclusiveEndTime muss im ISO 8601-Datums- und Uhrzeitformat sowie in UTC (Universal Coordinated Time) vorliegen. Zum Beispiel: 2019-06-13T21:36:34Z.

Typ: Zeitstempel

Erforderlich: Nein

InclusiveStartTime

Datums- und Uhrzeitangaben zum Zeitpunkt, ab dem das Streamen von Journaldaten gestartet werden soll. Diese Parameter muss im ISO 8601-Datums- und Uhrzeitformat sowie in UTC (Universal Coordinated Time) vorliegen. Zum Beispiel: 2019-06-13T21:36:34Z.

InclusiveStartTime kann nicht in der Zukunft liegen und muss vor ExclusiveEndTime liegen.

Wenn Sie eine InclusiveStartTime angeben, die vor der CreationDateTime des Ledgers liegt, wird sie von QLDB standardmäßig auf die CreationDateTime des Ledgers festgelegt.

Typ: Zeitstempel

Erforderlich: Ja

KinesisConfiguration

Die Konfigurationseinstellungen des Ziels für Kinesis Data Streams für Ihre Stream-Anforderung.

Typ: KinesisConfiguration Objekt

Erforderlich: Ja

RoleArn

Der Amazon-Ressourcenname (ARN) der IAM-Rolle, die QLDB-Berechtigungen für einen Journalstream zum Schreiben von Datensätzen in eine Kinesis Data Streams-Ressource gewährt.

Um beim Anfordern eines Journalstreams eine Rolle an QLDB zu übergeben, müssen Sie über Berechtigungen zum Ausführen der iam:PassRole-Aktion für die IAM-Rollenressource verfügen. Dies ist für alle Journalstream-Anforderungen erforderlich.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.

Erforderlich: Ja

StreamName

Der Name, den Sie dem QLDB-Journal-Stream zuweisen möchten. Benutzerdefinierte Namen können helfen, den Zweck eines Streams zu identifizieren und anzugeben.

Der Stream-Name muss unter anderen aktiven Streams für ein bestimmtes Ledger eindeutig sein. Stream-Namen haben dieselben Benennungsbeschränkungen wie Ledgernamen, wie sie unter Kontingente in Amazon QLDB im Amazon QLDB-Entwicklerhandbuch definiert sind.

Typ: Zeichenfolge

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

Pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Erforderlich: Ja

Tags

Die Schlüssel-Wert-Paare, die dem Stream, den Sie erstellen möchten, als Tags hinzugefügt werden sollen. Bei Tag-Schlüsseln wird zwischen Groß- und Kleinschreibung unterschieden. Bei Tag-Werten wird zwischen Groß- und Kleinschreibung unterschieden und sie können Null sein.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Karteneinträge: Mindestanzahl von 0 Elementen. Die maximale Anzahl beträgt 200 Elemente.

Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.

Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.

Erforderlich: Nein

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "StreamId": "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.

StreamId

Die UUID (dargestellt in Base62-codiertem Text), die QLDB jedem QLDB-Journal-Stream zuweist.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 22.

Pattern: ^[A-Za-z-0-9]+$

Fehler

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

InvalidParameterException

Ein oder mehrere Parameter in der Anfrage sind nicht gültig.

HTTP Status Code: 400

ResourceNotFoundException

Die angegebene Ressource ist nicht vorhanden.

HTTP Status Code: 404

ResourcePreconditionNotMetException

Der Vorgang ist fehlgeschlagen, weil eine Bedingung nicht im Voraus erfüllt wurde.

HTTP-Statuscode: 412

Weitere Informationen finden Sie unter:

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