Skip to content
AWS for Query.Farm

aws.qldb.describe_journal_s3_export

Example SQL Queries

SELECT * FROM
aws.qldb.describe_journal_s3_export
WHERE
"name" = 'VALUE'
AND "export_id" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
export_id Required Input Column

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

VARCHAR
name Required Input Column

The name of the ledger.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
export_description

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

STRUCT(
    "ledger_name" VARCHAR,
    "export_id" VARCHAR,
    "export_creation_time" TIMESTAMP_S,
    "status" VARCHAR,
    "inclusive_start_time" TIMESTAMP_S,
    "exclusive_end_time" TIMESTAMP_S,
    "s3_export_configuration" STRUCT(
        "bucket" VARCHAR,
        "prefix" VARCHAR,
        "encryption_configuration" STRUCT(
            "object_encryption_type" VARCHAR,
            "kms_key_arn" VARCHAR
        )
    ),
    "role_arn" VARCHAR,
    "output_format" VARCHAR
)
Show child fields
export_description.exclusive_end_time

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

export_description.export_creation_time

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

export_description.export_id

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

export_description.inclusive_start_time

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

export_description.ledger_name

The name of the ledger.

export_description.output_format

The output format of the exported journal data.

export_description.role_arn

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.

export_description.s3_export_configuration

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

Show child fields
export_description.s3_export_configuration.bucket

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.

export_description.s3_export_configuration.encryption_configuration

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

Show child fields
export_description.s3_export_configuration.encryption_configuration.kms_key_arn

The Amazon Resource Name (ARN) of a symmetric encryption 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.

export_description.s3_export_configuration.encryption_configuration.object_encryption_type

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.

export_description.s3_export_configuration.prefix

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/

export_description.status

The current state of the journal export job.