QLDB / Client / list_ledgers

list_ledgers#

QLDB.Client.list_ledgers(**kwargs)#

Returns all ledgers that are associated with the current Amazon Web Services account and Region.

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

See also: AWS API Documentation

Request Syntax

response = client.list_ledgers(
    MaxResults=123,
    NextToken='string'
)
Parameters:

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

  • NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Ledgers': [
        {
            'Name': 'string',
            'State': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
            'CreationDateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Ledgers (list) –

      The ledgers that are associated with the current Amazon Web Services account and Region.

      • (dict) –

        Information about a ledger, including its name, state, and when it was created.

        • Name (string) –

          The name of the ledger.

        • State (string) –

          The current status of the ledger.

        • CreationDateTime (datetime) –

          The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    • NextToken (string) –

      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.