Describe Journal S3 Export

qldb_describe_journal_s3_export

R Documentation

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

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.

Usage

qldb_describe_journal_s3_export(Name, ExportId)

Arguments

Name

[required] The name of the ledger.

ExportId

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

Value

A list with the following syntax:

list(
  ExportDescription = list(
    LedgerName = "string",
    ExportId = "string",
    ExportCreationTime = as.POSIXct(
      "2015-01-01"
    ),
    Status = "IN_PROGRESS"|"COMPLETED"|"CANCELLED",
    InclusiveStartTime = as.POSIXct(
      "2015-01-01"
    ),
    ExclusiveEndTime = as.POSIXct(
      "2015-01-01"
    ),
    S3ExportConfiguration = list(
      Bucket = "string",
      Prefix = "string",
      EncryptionConfiguration = list(
        ObjectEncryptionType = "SSE_KMS"|"SSE_S3"|"NO_ENCRYPTION",
        KmsKeyArn = "string"
      )
    ),
    RoleArn = "string",
    OutputFormat = "ION_BINARY"|"ION_TEXT"|"JSON"
  )
)

Request syntax

svc$describe_journal_s3_export(
  Name = "string",
  ExportId = "string"
)