- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListJournalKinesisStreamsForLedgerCommand
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 ListJournalKinesisStreamsForLedger
multiple times.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QLDBClient, ListJournalKinesisStreamsForLedgerCommand } from "@aws-sdk/client-qldb"; // ES Modules import
// const { QLDBClient, ListJournalKinesisStreamsForLedgerCommand } = require("@aws-sdk/client-qldb"); // CommonJS import
const client = new QLDBClient(config);
const input = { // ListJournalKinesisStreamsForLedgerRequest
LedgerName: "STRING_VALUE", // required
MaxResults: Number("int"),
NextToken: "STRING_VALUE",
};
const command = new ListJournalKinesisStreamsForLedgerCommand(input);
const response = await client.send(command);
// { // ListJournalKinesisStreamsForLedgerResponse
// Streams: [ // JournalKinesisStreamDescriptionList
// { // JournalKinesisStreamDescription
// LedgerName: "STRING_VALUE", // required
// CreationTime: new Date("TIMESTAMP"),
// InclusiveStartTime: new Date("TIMESTAMP"),
// ExclusiveEndTime: new Date("TIMESTAMP"),
// RoleArn: "STRING_VALUE", // required
// StreamId: "STRING_VALUE", // required
// Arn: "STRING_VALUE",
// Status: "ACTIVE" || "COMPLETED" || "CANCELED" || "FAILED" || "IMPAIRED", // required
// KinesisConfiguration: { // KinesisConfiguration
// StreamArn: "STRING_VALUE", // required
// AggregationEnabled: true || false,
// },
// ErrorCause: "KINESIS_STREAM_NOT_FOUND" || "IAM_PERMISSION_REVOKED",
// StreamName: "STRING_VALUE", // required
// },
// ],
// NextToken: "STRING_VALUE",
// };
ListJournalKinesisStreamsForLedgerCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
LedgerName Required | string | undefined | The name of the ledger. |
MaxResults | number | undefined | The maximum number of results to return in a single |
NextToken | string | undefined | A pagination token, indicating that you want to retrieve the next page of results. If you received a value for |
ListJournalKinesisStreamsForLedgerCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
NextToken | string | undefined |
|
Streams | JournalKinesisStreamDescription[] | undefined | The QLDB journal streams that are currently associated with the given ledger. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InvalidParameterException | client | One or more parameters in the request aren't valid. |
ResourceNotFoundException | client | The specified resource doesn't exist. |
ResourcePreconditionNotMetException | client | The operation failed because a condition wasn't satisfied in advance. |
QLDBServiceException | Base exception class for all service exceptions from QLDB service. |