Describe Journal Kinesis Stream

qldb_describe_journal_kinesis_stream

R Documentation

Returns detailed information about a given Amazon QLDB journal stream

Description

Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request.

This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.

Usage

qldb_describe_journal_kinesis_stream(LedgerName, StreamId)

Arguments

LedgerName

[required] The name of the ledger.

StreamId

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

Value

A list with the following syntax:

list(
  Stream = list(
    LedgerName = "string",
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    InclusiveStartTime = as.POSIXct(
      "2015-01-01"
    ),
    ExclusiveEndTime = as.POSIXct(
      "2015-01-01"
    ),
    RoleArn = "string",
    StreamId = "string",
    Arn = "string",
    Status = "ACTIVE"|"COMPLETED"|"CANCELED"|"FAILED"|"IMPAIRED",
    KinesisConfiguration = list(
      StreamArn = "string",
      AggregationEnabled = TRUE|FALSE
    ),
    ErrorCause = "KINESIS_STREAM_NOT_FOUND"|"IAM_PERMISSION_REVOKED",
    StreamName = "string"
  )
)

Request syntax

svc$describe_journal_kinesis_stream(
  LedgerName = "string",
  StreamId = "string"
)