Amazon Quantum Ledger Database (Amazon QLDB)
Developer Guide

ListLedgers

Returns an array of ledger summaries that are associated with the current AWS account and Region.

This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.

Request Syntax

GET /ledgers?max_results=MaxResults&next_token=NextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

MaxResults

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

Valid Range: Minimum value of 1. Maximum value of 100.

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 ListLedgers call, then you should use that value as input here.

Length Constraints: Minimum length of 4. Maximum length of 1024.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Ledgers": [ { "CreationDateTime": number, "Name": "string", "State": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Ledgers

The array of ledger summaries that are associated with the current AWS account and Region.

Type: Array of LedgerSummary objects

NextToken

A pagination token, indicating whether there are more results available:

  • If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved.

  • If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListLedgers call.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

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

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

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