JournalS3ExportDescription - Amazon Quantum Ledger Database (Amazon QLDB)

JournalS3ExportDescription

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.

Contents

ExclusiveEndTime

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

Type: Timestamp

Required: Yes

ExportCreationTime

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

Type: Timestamp

Required: Yes

ExportId

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

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^[A-Za-z-0-9]+$

Required: Yes

InclusiveStartTime

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

Type: Timestamp

Required: Yes

LedgerName

The name of the ledger.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Required: Yes

OutputFormat

The output format of the exported journal data.

Type: String

Valid Values: ION_BINARY | ION_TEXT | JSON

Required: No

RoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

Required: Yes

S3ExportConfiguration

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

Type: S3ExportConfiguration object

Required: Yes

Status

The current state of the journal export job.

Type: String

Valid Values: IN_PROGRESS | COMPLETED | CANCELLED

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: