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.
ExportJournalToS3
Exporte le contenu d'un journal dans une plage de dates et d'heures depuis un registre vers un compartiment Amazon Simple Storage Service (Amazon S3) spécifié. Une tâche d'exportation de journal peut écrire les objets de données sous forme de texte ou de représentation binaire au format Amazon Ion, ou au format de texte JSON Lines.
Si le registre contenant le donné Name
n'existe pas, il est lancé. ResourceNotFoundException
Si le registre contenant le donné Name
est en CREATING
état, il est lancé. ResourcePreconditionNotMetException
Vous pouvez lancer jusqu'à deux demandes d'exportation de journaux simultanées pour chaque registre. Au-delà de cette limite, les demandes d'exportation de journaux sont émisesLimitExceededException
.
Syntaxe de la demande
POST /ledgers/name
/journal-s3-exports HTTP/1.1
Content-type: application/json
{
"ExclusiveEndTime": number
,
"InclusiveStartTime": number
,
"OutputFormat": "string
",
"RoleArn": "string
",
"S3ExportConfiguration": {
"Bucket": "string
",
"EncryptionConfiguration": {
"KmsKeyArn": "string
",
"ObjectEncryptionType": "string
"
},
"Prefix": "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 de fin exclusives de la gamme de contenus de journaux à exporter.
Le paramètre
ExclusiveEndTime
doit être au format date et heureISO 8601
et en temps universel coordonné (UTC). Par exemple :2019-06-13T21:36:34Z
.La valeur
ExclusiveEndTime
doit être inférieure ou égale à la date et à l'heure UTC actuelles.Type : Timestamp
Obligatoire : oui
- InclusiveStartTime
-
Date et heure de début incluses pour la gamme de contenus du journal à exporter.
Le paramètre
InclusiveStartTime
doit être au format date et heureISO 8601
et en temps universel coordonné (UTC). Par exemple :2019-06-13T21:36:34Z
.Ça
InclusiveStartTime
doit être avantExclusiveEndTime
.Si vous fournissez un
InclusiveStartTime
qui se trouve avant celui du registreCreationDateTime
, Amazon QLDB le définit par défaut sur celui du registre.CreationDateTime
Type : Timestamp
Obligatoire : oui
- OutputFormat
-
Format de sortie des données de journal exportées. Une tâche d'exportation de journal peut écrire les objets de données sous forme de texte ou de représentation binaire au format Amazon Ion, ou au format de texte JSON Lines
. Par défaut :
ION_TEXT
Au format JSON Lines, chaque bloc de journal d'un objet de données exporté est un objet JSON valide délimité par une nouvelle ligne. Vous pouvez utiliser ce format pour intégrer directement les exportations JSON à des outils d'analyse tels qu'Amazon Athena et AWS Glue parce que ces services peuvent analyser automatiquement le JSON délimité par de nouvelles lignes.
Type : chaîne
Valeurs valides :
ION_BINARY | ION_TEXT | JSON
Obligatoire : non
- RoleArn
-
Le nom de ressource Amazon (ARN) du rôle IAM qui accorde les autorisations QLDB pour une tâche d'exportation de journal permet d'effectuer les opérations suivantes :
-
Écrivez des objets dans votre compartiment Amazon S3.
-
(Facultatif) Utilisez votre clé gérée par le client dans AWS Key Management Service (AWS KMS) pour le chiffrement côté serveur de vos données exportées.
Pour transmettre un rôle à QLDB lors d'une demande d'exportation de journal, vous devez disposer des autorisations nécessaires pour effectuer
iam:PassRole
l'action sur la ressource du rôle IAM. Cela est obligatoire pour toutes les demandes d'exportation de journaux.Type : chaîne
Contraintes de longueur : longueur minimale de 20. Longueur maximale de 1600.
Obligatoire : oui
-
- S3ExportConfiguration
-
Les paramètres de configuration de la destination du compartiment Amazon S3 pour votre demande d'exportation.
Type : objet S3ExportConfiguration
Obligatoire : oui
Syntaxe de la réponse
HTTP/1.1 200
Content-type: application/json
{
"ExportId": "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.
- ExportId
-
L'UUID (représenté dans du texte codé en Base62) que QLDB attribue à chaque tâche d'exportation de journal.
Pour décrire votre demande d'exportation et vérifier l'état de la tâche, vous pouvez utiliser
ExportId
to callDescribeJournalS3Export
.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.
- 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 :