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 mayor a un bucket de Amazon Simple Storage Service (Amazon S3) especificado. Un trabajo de exportación de asientos puede escribir los objetos de datos en la representación de texto o binaria del formato Amazon Ion, o enLíneas de JSONformato de texto.

En formato JSON Lines, cada bloque de diario del objeto de datos exportado es un objeto JSON válido que está delimitado por una nueva línea. Puede utilizar este formato para integrar fácilmente las exportaciones JSON con herramientas analíticas comoAWS Gluey Amazon Athena porque estos servicios pueden analizar automáticamente JSON delimitados por nueva línea. Para obtener más información sobre el formato, consulteLíneas de JSON.

Si el libro mayor con el dadoNameNo existe, luego lanzaResourceNotFoundException.

Si el libro mayor con el dadoNameestá enCREATINGstatus, luego lanzaResourcePreconditionNotMetException.

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

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.

Restricciones 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 para el rango de contenido de diario que se 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.

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

Type: Marca temporal

Obligatorio: Sí

InclusiveStartTime

La fecha y hora de inicio inclusivas para el 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.

LaInclusiveStartTimedebe ser antesExclusiveEndTime.

Si proporciona unInclusiveStartTimees decir, antes de que el libro mayorCreationDateTime, Amazon QLDB lo establece por defecto en el libro mayorCreationDateTime.

Type: Marca temporal

Obligatorio: Sí

OutputFormat

Formato de salida de los datos de diario exportados. Si no se especifica este parámetro, los datos exportados por defecto sonION_TEXTformato.

Type: 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 a QLDB permisos para que un trabajo de exportación de diario haga lo siguiente:

  • Escriba objetos en el bucket de Amazon Simple Storage Service (Amazon S3)

  • (Opcional) Utilice la clave administrada por el cliente enAWS Key Management Service(AWS KMS) para el cifrado del lado del servidor de los datos exportados.

Para transferir un rol a QLDB al solicitar la exportación de diario, debe tener permisos para realizariam:PassRoleacción sobre el recurso de rol de IAM. Esto es obligatorio para todas las solicitudes de exportación de asientos.

Type: Cadena

Restricciones de longitud: Longitud mínima de 20. La longitud máxima es de 1600 caracteres.

Obligatorio: Sí

S3ExportConfiguration

La configuración del destino del bucket de Amazon S3 para la 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

UUID (representado en texto codificado en Base62) que QLDB asigna a cada trabajo de exportación de asientos.

Para describir la solicitud de exportación y comprobar el estado del trabajo, puede utilizarExportIdLlamar aDescribeJournalS3Export.

Type: Cadena

Restricciones de longitud: Longitud fija de 22 caracteres.

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

Errores

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

ResourceNotFoundException

El recurso especificado no existe.

Código de estado HTTP: 404

ResourcePreconditionNotMetException

La operación ha fallado porque una condición no se cumplió por adelantado.

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: