List Journal Kinesis Streams For Ledger

qldb_list_journal_kinesis_streams_for_ledger

R Documentation

Returns all Amazon QLDB journal streams for a given ledger¶

Description¶

Returns all Amazon QLDB journal streams for a given ledger.

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

This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling list_journal_kinesis_streams_for_ledger multiple times.

Usage¶

qldb_list_journal_kinesis_streams_for_ledger(LedgerName, MaxResults,
  NextToken)

Arguments¶

LedgerName

[required] The name of the ledger.

MaxResults

The maximum number of results to return in a single list_journal_kinesis_streams_for_ledger request. (The actual number of results returned might be fewer.)

NextToken

A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous list_journal_kinesis_streams_for_ledger call, you should use that value as input here.

Value¶

A list with the following syntax:

list(
  Streams = list(
    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"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_journal_kinesis_streams_for_ledger(
  LedgerName = "string",
  MaxResults = 123,
  NextToken = "string"
)