ExportJournalToS3 - Amazon Quantum Ledger Database (Amazon QLDB)

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 dentro de un intervalo de fecha y hora de un libro de contabilidad a un bucket de Amazon Simple Storage Service (Amazon S3) especificado. Un trabajo de exportación de diarios puede escribir los objetos de datos en representación de texto o binaria del formato Amazon Ion o en formato de texto JSON Lines.

Si el libro mayor con lo dadoName no existe, entonces lanzaResourceNotFoundException.

Si el libro mayor con lo dadoName está enCREATING estado, entonces lanzaResourcePreconditionNotMetException.

Puede iniciar hasta dos solicitudes de exportación de diarios simultáneas para cada libro mayor. Más allá de este límite, se descartan las solicitudes de exportación de revistasLimitExceededException.

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. 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 de la gama de contenidos de la revista que se va a exportar.

El ExclusiveEndTime debe estar en formato de fecha y hora ISO 8601 y en hora universal coordinada (UTC). Por ejemplo:2019-06-13T21:36:34Z.

ExclusiveEndTimeDebe ser menor o igual que la fecha y hora UTC actuales.

Tipo: Timestamp

Obligatorio: sí

InclusiveStartTime

Fecha y hora de inicio inclusivas del rango de contenido de diario que se exportará.

El InclusiveStartTime debe estar en formato de fecha y hora ISO 8601 y en hora universal coordinada (UTC). Por ejemplo:2019-06-13T21:36:34Z.

InclusiveStartTimeDebe ser antesExclusiveEndTime.

Si proporciona unInclusiveStartTime que sea anterior a la de contabilidadCreationDateTime, Amazon QLDB lo asigna por defecto a la de contabilidadCreationDateTime.

Tipo: Timestamp

Obligatorio: sí

OutputFormat

El formato de salida de los datos del diario exportados. Un trabajo de exportación de diarios puede escribir los objetos de datos en representación de texto o binaria del formato Amazon Ion o en formato de texto JSON Lines.

Valor predeterminado: ION_TEXT

En formato JSON Lines, cada bloque de diario de un objeto de datos exportado es un objeto JSON válido que está delimitado por una nueva línea. Puede utilizar este formato para integrar directamente las exportaciones de JSON con herramientas de análisis como Amazon Athena yAWS Glue porque estos servicios pueden analizar automáticamente el JSON delimitado por nuevas líneas.

Tipo: String

Valores válidos: ION_BINARY | ION_TEXT | JSON

Obligatorio: no

RoleArn

El nombre de recurso de Amazon (ARN) del rol de IAM que concede a QLDB permisos para un trabajo de exportación de diario realiza lo siguiente:

  • Escribe objetos en tu bucket de Amazon S3.

  • (Opcional) Utilice su clave administrada por el cliente inAWS Key Management Service (AWS KMS) para cifrar los datos exportados en el lado del servidor.

Para transferir un rol a QLDB al solicitar la exportación, debe tener permisos para realizar laiam:PassRole acción en el recurso de rol de IAM. Esto es necesario para todas las solicitudes de exportación de diario.

Tipo: String

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 destino del bucket de Amazon S3 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 el texto codificado en Base62) que QLDB asigna a cada trabajo de exportación de revistas.

Para describir su solicitud de exportación y comprobar el estado del trabajo, puede utilizar la función deExportId llamarDescribeJournalS3Export.

Tipo: String

Limitaciones de longitud: longitud fija de 22 caracteres.

Patrón: ^[A-Za-z-0-9]+$

Errores

Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.

ResourceNotFoundException

El recurso especificado no existe.

Código de estado HTTP: 404

ResourcePreconditionNotMetException

La operación falló porque no se cumplió una condición de antemano.

Código de estado HTTP: 412

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: