Skip to content

/AWS1/IF_QLD=>EXPORTJOURNALTOS3()

About ExportJournalToS3

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.

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.

Method Signature

METHODS /AWS1/IF_QLD~EXPORTJOURNALTOS3
  IMPORTING
    !IV_NAME TYPE /AWS1/QLDLEDGERNAME OPTIONAL
    !IV_INCLUSIVESTARTTIME TYPE /AWS1/QLDTIMESTAMP OPTIONAL
    !IV_EXCLUSIVEENDTIME TYPE /AWS1/QLDTIMESTAMP OPTIONAL
    !IO_S3EXPORTCONFIGURATION TYPE REF TO /AWS1/CL_QLDS3EXPORTCONF OPTIONAL
    !IV_ROLEARN TYPE /AWS1/QLDARN OPTIONAL
    !IV_OUTPUTFORMAT TYPE /AWS1/QLDOUTPUTFORMAT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qldexportjourtos3rsp
  RAISING
    /AWS1/CX_QLDRESOURCENOTFOUNDEX
    /AWS1/CX_QLDRESRCPRECONDNOTM00
    /AWS1/CX_QLDCLIENTEXC
    /AWS1/CX_QLDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/QLDLEDGERNAME /AWS1/QLDLEDGERNAME

The name of the ledger.

iv_inclusivestarttime TYPE /AWS1/QLDTIMESTAMP /AWS1/QLDTIMESTAMP

The inclusive start date and time for the range of journal contents to export.

The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.

iv_exclusiveendtime TYPE /AWS1/QLDTIMESTAMP /AWS1/QLDTIMESTAMP

The exclusive end date and time for the range of journal contents to export.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The ExclusiveEndTime must be less than or equal to the current UTC date and time.

io_s3exportconfiguration TYPE REF TO /AWS1/CL_QLDS3EXPORTCONF /AWS1/CL_QLDS3EXPORTCONF

The configuration settings of the Amazon S3 bucket destination for your export request.

iv_rolearn TYPE /AWS1/QLDARN /AWS1/QLDARN

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

  • Write objects into your Amazon S3 bucket.

  • (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.

To pass a role to QLDB when requesting a journal export, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal export requests.

Optional arguments:

iv_outputformat TYPE /AWS1/QLDOUTPUTFORMAT /AWS1/QLDOUTPUTFORMAT

The output format of your exported journal data. 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.

Default: ION_TEXT

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

RETURNING

oo_output TYPE REF TO /aws1/cl_qldexportjourtos3rsp /AWS1/CL_QLDEXPORTJOURTOS3RSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->exportjournaltos3(
  io_s3exportconfiguration = new /aws1/cl_qlds3exportconf(
    io_encryptionconfiguration = new /aws1/cl_qlds3encryptionconf(
      iv_kmskeyarn = |string|
      iv_objectencryptiontype = |string|
    )
    iv_bucket = |string|
    iv_prefix = |string|
  )
  iv_exclusiveendtime = '20150101000000.0000000'
  iv_inclusivestarttime = '20150101000000.0000000'
  iv_name = |string|
  iv_outputformat = |string|
  iv_rolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_uniqueid = lo_result->get_exportid( ).
ENDIF.