QLDB / Client / describe_journal_s3_export

describe_journal_s3_export#

QLDB.Client.describe_journal_s3_export(**kwargs)#

Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.

If the export job with the given ExportId doesn’t exist, then throws ResourceNotFoundException.

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

See also: AWS API Documentation

Request Syntax

response = client.describe_journal_s3_export(
    Name='string',
    ExportId='string'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the ledger.

  • ExportId (string) –

    [REQUIRED]

    The UUID (represented in Base62-encoded text) of the journal export job to describe.

Return type:

dict

Returns:

Response Syntax

{
    'ExportDescription': {
        'LedgerName': 'string',
        'ExportId': 'string',
        'ExportCreationTime': datetime(2015, 1, 1),
        'Status': 'IN_PROGRESS'|'COMPLETED'|'CANCELLED',
        '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'
    }
}

Response Structure

  • (dict) –

    • ExportDescription (dict) –

      Information about the journal export job returned by a DescribeJournalS3Export request.

      • LedgerName (string) –

        The name of the ledger.

      • ExportId (string) –

        The UUID (represented in Base62-encoded text) of the journal export job.

      • ExportCreationTime (datetime) –

        The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

      • Status (string) –

        The current state of the journal export job.

      • InclusiveStartTime (datetime) –

        The inclusive start date and time for the range of journal contents that was specified in the original export request.

      • ExclusiveEndTime (datetime) –

        The exclusive end date and time for the range of journal contents that was specified in the original export request.

      • S3ExportConfiguration (dict) –

        The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.

        • Bucket (string) –

          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) –

          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) –

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

          • ObjectEncryptionType (string) –

            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) –

        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.

      • OutputFormat (string) –

        The output format of the exported journal data.

Exceptions

  • QLDB.Client.exceptions.ResourceNotFoundException