Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
ExportJournalToS3
Exporta el contenido del diario en un intervalo de fechas y horas de un libro mayor a un bucket de Amazon Simple Storage Service (Amazon S3) especificado. Un trabajo de exportación del diario puede escribir los objetos de datos en el formato de texto o binario de Amazon Ion, o en el formato de texto JSON Lines.
Si el libro mayor con el Name
dado no existe, devuelve ResourceNotFoundException
.
Si el estado del libro mayor con el Name
dado es CREATING
, devuelve ResourcePreconditionNotMetException
.
Puede iniciar hasta dos solicitudes de exportación de diarios simultáneas para cada libro mayor. Más allá de este límite, las solicitudes de exportación del diario devuelven LimitExceededException
.
Sintaxis de la solicitud
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
"
}
}
Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- name
-
El nombre de contabilidad.
Limitaciones de longitud: longitud mínima de 1 carácter. La longitud máxima es de 32 caracteres.
Patrón:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$
Obligatorio: sí
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- ExclusiveEndTime
-
La fecha y hora de finalización exclusivas del rango de contenidos del diario que desea exportar.
La
ExclusiveEndTime
debe estar en formato de fecha y horaISO 8601
y en hora universal coordinada (UTC). Por ejemplo:2019-06-13T21:36:34Z
.La
ExclusiveEndTime
debe ser menor o igual que la fecha y hora UTC actuales.Tipo: marca temporal
Obligatorio: sí
- InclusiveStartTime
-
La fecha y hora de inicio inclusivas del rango de contenidos del diario que desea exportar.
La
InclusiveStartTime
debe estar en formato de fecha y horaISO 8601
y en hora universal coordinada (UTC). Por ejemplo:2019-06-13T21:36:34Z
.La
InclusiveStartTime
debe ser anterior aExclusiveEndTime
.Si proporciona una
InclusiveStartTime
anterior a laCreationDateTime
del libro mayor, Amazon QLDB la asigna de manera predeterminada a laCreationDateTime
del libro mayor.Tipo: marca temporal
Obligatorio: sí
- OutputFormat
-
El formato de salida de los datos de su diario exportado. Un trabajo de exportación del diario puede escribir los objetos de datos en el formato de texto o binario de Amazon Ion, o en el formato de texto JSON Lines.
Predeterminado:
ION_TEXT
En el formato de JSON Lines, cada bloque del diario de un objeto de datos exportado es un objeto JSON válido que está delimitado por saltos de línea. Puede usar este formato para integrar directamente las exportaciones de JSON con herramientas de análisis como Amazon Athena y AWS Glue porque estos servicios pueden analizar automáticamente el JSON delimitado por saltos de línea.
Tipo: cadena
Valores válidos:
ION_BINARY | ION_TEXT | JSON
Obligatorio: no
- RoleArn
-
El nombre de recurso de Amazon (ARN) del rol de IAM que concede permisos a QLDB para que los trabajos de exportación de diarios hagan lo siguiente:
-
Escribe objetos en un bucket de Amazon S3.
-
(Opcional) Utilice su clave gestionada por el cliente AWS Key Management Service (AWS KMS) para cifrar los datos exportados en el servidor.
Para transferir un rol a QLDB al solicitar una exportación de diario, debe tener permisos para realizar la acción
iam:PassRole
en el recurso de rol de IAM. Esto es necesario para todas las solicitudes de exportación de diarios.Tipo: cadena
Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 1600 caracteres.
Obligatorio: sí
-
- S3ExportConfiguration
-
Los ajustes de la configuración del bucket de Amazon S3 de destino de su solicitud de exportación.
Tipo: objeto S3ExportConfiguration
Obligatorio: sí
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"ExportId": "string"
}
Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- ExportId
-
El UUID (representado en texto codificado en Base62) que QLDB asigna a cada trabajo de exportación de diario.
Para describir su solicitud de exportación y comprobar el estado del trabajo, puede utilizar
ExportId
para llamar aDescribeJournalS3Export
.Tipo: cadena
Limitaciones de longitud: longitud fija de 22.
Patrón:
^[A-Za-z-0-9]+$
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- ResourceNotFoundException
-
El recurso especificado no existe.
Código de estado HTTP: 404
- ResourcePreconditionNotMetException
-
La operación ha fallado porque no se ha cumplido una condición previa.
Código de estado HTTP: 412
Véase también
Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: