libZSservicesZSamazonka-qldbZSamazonka-qldb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.QLDB.ListLedgers

Description

Returns an array of ledger summaries that are associated with the current 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.

Synopsis

Creating a Request

data ListLedgers Source #

See: newListLedgers smart constructor.

Constructors

ListLedgers' 

Fields

  • nextToken :: Maybe Text

    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.

  • maxResults :: Maybe Natural

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

Instances

Instances details
Eq ListLedgers Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Methods

(==) :: ListLedgers -> ListLedgers -> Bool #

(/=) :: ListLedgers -> ListLedgers -> Bool #

Read ListLedgers Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Methods

readsPrec :: Int -> ReadS ListLedgers #

readList :: ReadS [ListLedgers] #

readPrec :: ReadPrec ListLedgers #

readListPrec :: ReadPrec [ListLedgers] #

Show ListLedgers Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Methods

showsPrec :: Int -> ListLedgers -> ShowS #

show :: ListLedgers -> String #

showList :: [ListLedgers] -> ShowS #

Generic ListLedgers Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Associated Types

type Rep ListLedgers :: Type -> Type #

Methods

from :: ListLedgers -> Rep ListLedgers x #

to :: Rep ListLedgers x -> ListLedgers #

NFData ListLedgers Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Methods

rnf :: ListLedgers -> () #

Hashable ListLedgers Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Methods

hashWithSalt :: Int -> ListLedgers -> Int #

hash :: ListLedgers -> Int #

AWSRequest ListLedgers Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Associated Types

type AWSResponse ListLedgers #

Methods

request :: ListLedgers -> Request ListLedgers #

response :: MonadResource m => Logger -> Service -> Proxy ListLedgers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListLedgers))) #

ToHeaders ListLedgers Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Methods

toHeaders :: ListLedgers -> [Header] #

ToPath ListLedgers Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Methods

toPath :: ListLedgers -> ByteString #

ToQuery ListLedgers Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Methods

toQuery :: ListLedgers -> QueryString #

type Rep ListLedgers Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

type Rep ListLedgers = D1 ('MetaData "ListLedgers" "Amazonka.QLDB.ListLedgers" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "ListLedgers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListLedgers Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

type AWSResponse ListLedgers = ListLedgersResponse

newListLedgers :: ListLedgers Source #

Create a value of ListLedgers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListLedgers', listLedgers_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.

$sel:maxResults:ListLedgers', listLedgers_maxResults - The maximum number of results to return in a single ListLedgers request. (The actual number of results returned might be fewer.)

Request Lenses

listLedgers_nextToken :: Lens' ListLedgers (Maybe Text) Source #

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.

listLedgers_maxResults :: Lens' ListLedgers (Maybe Natural) Source #

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

Destructuring the Response

data ListLedgersResponse Source #

See: newListLedgersResponse smart constructor.

Constructors

ListLedgersResponse' 

Fields

  • ledgers :: Maybe [LedgerSummary]

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

  • nextToken :: Maybe Text

    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.
  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListLedgersResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Methods

(==) :: ListLedgersResponse -> ListLedgersResponse -> Bool #

(/=) :: ListLedgersResponse -> ListLedgersResponse -> Bool #

Read ListLedgersResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Methods

readsPrec :: Int -> ReadS ListLedgersResponse #

readList :: ReadS [ListLedgersResponse] #

readPrec :: ReadPrec ListLedgersResponse #

readListPrec :: ReadPrec [ListLedgersResponse] #

Show ListLedgersResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Methods

showsPrec :: Int -> ListLedgersResponse -> ShowS #

show :: ListLedgersResponse -> String #

showList :: [ListLedgersResponse] -> ShowS #

Generic ListLedgersResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Associated Types

type Rep ListLedgersResponse :: Type -> Type #

Methods

from :: ListLedgersResponse -> Rep ListLedgersResponse x #

to :: Rep ListLedgersResponse x -> ListLedgersResponse #

NFData ListLedgersResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

Methods

rnf :: ListLedgersResponse -> () #

type Rep ListLedgersResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListLedgers

type Rep ListLedgersResponse = D1 ('MetaData "ListLedgersResponse" "Amazonka.QLDB.ListLedgers" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "ListLedgersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ledgers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LedgerSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListLedgersResponse Source #

Arguments

:: Int

$sel:httpStatus:ListLedgersResponse'

-> ListLedgersResponse 

Create a value of ListLedgersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ledgers:ListLedgersResponse', listLedgersResponse_ledgers - The array of ledger summaries that are associated with the current account and Region.

$sel:nextToken:ListLedgers', listLedgersResponse_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.

$sel:httpStatus:ListLedgersResponse', listLedgersResponse_httpStatus - The response's http status code.

Response Lenses

listLedgersResponse_ledgers :: Lens' ListLedgersResponse (Maybe [LedgerSummary]) Source #

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

listLedgersResponse_nextToken :: Lens' ListLedgersResponse (Maybe Text) Source #

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.

listLedgersResponse_httpStatus :: Lens' ListLedgersResponse Int Source #

The response's http status code.