[ aws . qldb ]

describe-journal-s3-export

Description

Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-journal-s3-export
--name <value>
--export-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--name (string)

The name of the ledger.

--export-id (string)

The unique ID of the journal export job that you want to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe a journal export job

The following describe-journal-s3-export example displays the details for the specified export job from a ledger.

aws qldb describe-journal-s3-export \
    --name myExampleLedger \
    --export-id ADR2ONPKN5LINYGb4dp7yZ

Output:

{
    "ExportDescription": {
        "S3ExportConfiguration": {
            "Bucket": "awsExampleBucket",
            "Prefix": "ledgerexport1/",
            "EncryptionConfiguration": {
                "ObjectEncryptionType": "SSE_S3"
            }
        },
        "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role",
        "Status": "COMPLETED",
        "ExportCreationTime": 1568847801.418,
        "InclusiveStartTime": 1568764800.0,
        "ExclusiveEndTime": 1568847599.0,
        "LedgerName": "myExampleLedger",
        "ExportId": "ADR2ONPKN5LINYGb4dp7yZ"
    }
}

For more information, see Exporting Your Journal in Amazon QLDB in the Amazon QLDB Developer Guide.

Output

ExportDescription -> (structure)

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

LedgerName -> (string)

The name of the ledger.

ExportId -> (string)

The unique ID of the journal export job.

ExportCreationTime -> (timestamp)

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 -> (timestamp)

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

ExclusiveEndTime -> (timestamp)

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

S3ExportConfiguration -> (structure)

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 -> (structure)

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) for a symmetric customer master key (CMK) in AWS Key Management Service (AWS KMS). Amazon QLDB does not support asymmetric CMKs.

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 master key (CMK) in AWS Key Management Service (AWS KMS) for server-side encryption of your exported data.