QLDB / Client / export_journal_to_s3

export_journal_to_s3#

QLDB.Client.export_journal_to_s3(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.export_journal_to_s3(
    Name='string',
    InclusiveStartTime=datetime(2015, 1, 1),
    ExclusiveEndTime=datetime(2015, 1, 1),
    S3ExportConfiguration={
        'Bucket': 'string',
        'Prefix': 'string',
        'EncryptionConfiguration': {
            'ObjectEncryptionType': 'SSE_KMS'|'SSE_S3'|'NO_ENCRYPTION',
            'KmsKeyArn': 'string'
        }
    },
    RoleArn='string',
    OutputFormat='ION_BINARY'|'ION_TEXT'|'JSON'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the ledger.

  • InclusiveStartTime (datetime) –

    [REQUIRED]

    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.

  • ExclusiveEndTime (datetime) –

    [REQUIRED]

    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.

  • S3ExportConfiguration (dict) –

    [REQUIRED]

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

    • Bucket (string) – [REQUIRED]

      The Amazon S3 bucket name in which a journal export job writes the journal contents.

      The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.

    • Prefix (string) – [REQUIRED]

      The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.

      The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.

      The following are examples of valid Prefix values:

      • JournalExports-ForMyLedger/Testing/

      • JournalExports

      • My:Tests/

    • EncryptionConfiguration (dict) – [REQUIRED]

      The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.

      • ObjectEncryptionType (string) – [REQUIRED]

        The Amazon S3 object encryption type.

        To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.

      • KmsKeyArn (string) –

        The Amazon Resource Name (ARN) of a symmetric key in Key Management Service (KMS). Amazon S3 does not support asymmetric KMS keys.

        You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType.

        KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType.

  • RoleArn (string) –

    [REQUIRED]

    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 Simple Storage Service (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.

  • OutputFormat (string) – The output format of your exported journal data. If this parameter is not specified, the exported data defaults to ION_TEXT format.

Return type:

dict

Returns:

Response Syntax

{
    'ExportId': 'string'
}

Response Structure

  • (dict) –

    • ExportId (string) –

      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 ExportId to call DescribeJournalS3Export.

Exceptions

  • QLDB.Client.exceptions.ResourceNotFoundException

  • QLDB.Client.exceptions.ResourcePreconditionNotMetException