Post ledgersnamejournal s3 exports

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14208295.3 KB

Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.

In JSON Lines format, each journal block in the exported data object is a valid JSON object that is delimited by a newline. You can use this format to easily integrate JSON exports with analytics tools such as Glue and Amazon Athena because these services can parse newline-delimited JSON automatically. For more information about the format, see JSON Lines.

If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException.

You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException.

post/ledgers/{name}/journal-s3-exports

Path parameters

namestring required

The name of the ledger.

Request body

InclusiveStartTimestring date-time required

The inclusive start date and time for the range of journal contents to export. The <code>InclusiveStartTime</code> must be in <code>ISO 8601</code> date and time format and in Universal Coordinated Time (UTC). For example: <code>2019-06-13T21:36:34Z</code>. The <code>InclusiveStartTime</code> must be before <code>ExclusiveEndTime</code>. If you provide an <code>InclusiveStartTime</code> that is before the ledger's <code>CreationDateTime</code>, Amazon QLDB defaults it to the ledger's <code>CreationDateTime</code>.

ExclusiveEndTimestring date-time required

The exclusive end date and time for the range of journal contents to export. The <code>ExclusiveEndTime</code> must be in <code>ISO 8601</code> date and time format and in Universal Coordinated Time (UTC). For example: <code>2019-06-13T21:36:34Z</code>. The <code>ExclusiveEndTime</code> must be less than or equal to the current UTC date and time.

RoleArnstring required

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following: <ul> <li> Write objects into your Amazon Simple Storage Service (Amazon S3) bucket. </li> <li> (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data. </li> </ul> To pass a role to QLDB when requesting a journal export, you must have permissions to perform the <code>iam:PassRole</code> action on the IAM role resource. This is required for all journal export requests.

OutputFormat'ION_BINARY' | 'ION_TEXT' | 'JSON'

The output format of your exported journal data. If this parameter is not specified, the exported data defaults to <code>ION_TEXT</code> format.

Response

Success

ExportIdstring required

The UUID (represented in Base62-encoded text) that QLDB assigns to each journal export job. To describe your export request and check the status of the job, you can use <code>ExportId</code> to call <code>DescribeJournalS3Export</code>.