StreamJournalToKinesis - Amazon Quantum Ledger Database (Amazon QLDB)
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

StreamJournalToKinesis

Crée un flux de journal pour un registre Amazon QLDB donné. Le flux capture chaque révision de document validée dans le journal du registre et transmet les données à une ressource Amazon Kinesis Data Streams spécifiée.

Syntaxe de la demande

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

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

name

Nom du registre.

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 32.

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

Obligatoire : oui

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

ExclusiveEndTime

Date et heure exclusives spécifiant la date à laquelle le flux se termine. Si vous ne définissez pas ce paramètre, le flux s'exécute indéfiniment jusqu'à ce que vous l'annuliez.

Le paramètre ExclusiveEndTime doit être au format date et heure ISO 8601 et en temps universel coordonné (UTC). Par exemple : 2019-06-13T21:36:34Z.

Type : Timestamp

Obligatoire : non

InclusiveStartTime

Date et heure de début incluses à partir de laquelle commence la diffusion des données de journal. Ce paramètre doit être au format date et heure ISO 8601 et au format temps universel coordonné (UTC). Par exemple : 2019-06-13T21:36:34Z.

Le paramètre InclusiveStartTime ne peut pas être dans le futur et doit être avant ExclusiveEndTime.

Si vous fournissez un paramètre InclusiveStartTime qui se trouve avant le registre CreationDateTime, QLDB l'affecte par défaut au paramètre CreationDateTime du registre.

Type : Timestamp

Obligatoire : oui

KinesisConfiguration

Paramètres de configuration de la destination Kinesis Data Streams pour votre demande de flux.

Type : objet KinesisConfiguration

Obligatoire : oui

RoleArn

Amazon Resource Name (ARN) du rôle IAM qui accorde des autorisations QLDB à un flux de journal pour écrire des enregistrements de données dans une ressource Kinesis Data Streams.

Pour transmettre un rôle à QLDB lorsque vous demandez un flux de journal, vous devez disposer des autorisations nécessaires pour effectuer l'action iam:PassRole sur la ressource de rôle IAM. Cela est obligatoire pour toutes les demandes de flux de journal.

Type : chaîne

Contraintes de longueur : longueur minimale de 20. Longueur maximale de 1600.

Obligatoire : oui

StreamName

Nom que vous souhaitez affecter au flux de journal QLDB. Les noms définis par l'utilisateur peuvent aider à identifier et à indiquer le but d'un flux.

Votre nom de flux doit être unique parmi les autres flux actifs pour un registre donné. Les contraintes relatives aux noms de flux sont les mêmes que celles relatives aux noms de registres, telles que définies dans Quotas dans Amazon QLDB dans le Manuel du développeur Amazon QLDB.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 32.

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

Obligatoire : oui

Tags

Les paires clé-valeur à ajouter sous forme de balises au flux que vous souhaitez créer. Les clés de balises sont sensibles à la casse. Les valeurs des balises distinguent les majuscules et minuscules et peuvent être nulles.

Type : mappage chaîne/chaîne

Entrées cartographiques : nombre minimum de 0 éléments. Nombre maximum de 200 éléments.

Contraintes de longueur de clé : longueur minimale de 1. Longueur maximum de 128.

Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximum de 256.

Obligatoire : non

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "StreamId": "string"
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

StreamId

L'UUID (représenté dans du texte codé en Base62) que QLDB attribue à chaque flux de journal QLDB.

Type : chaîne

Contraintes de longueur : longueur fixe de 22.

Modèle : ^[A-Za-z-0-9]+$

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

InvalidParameterException

Un ou plusieurs paramètres de la demande ne sont pas valides.

Code d’état HTTP : 400

ResourceNotFoundException

La ressource spécifiée n’existe pas.

Code d’état HTTP : 404

ResourcePreconditionNotMetException

L'opération a échoué car une condition n'était pas satisfaite à l'avance.

Code d’état HTTP : 412

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :