Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QLDB.ListJournalKinesisStreamsForLedger

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream.

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.

Synopsis

Creating a Request

data ListJournalKinesisStreamsForLedger Source #

See: newListJournalKinesisStreamsForLedger smart constructor.

Constructors

ListJournalKinesisStreamsForLedger'

Fields

maxResults :: Maybe Natural
The maximum number of results to return in a single ListJournalKinesisStreamsForLedger request. (The actual number of results returned might be fewer.)
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 ListJournalKinesisStreamsForLedger call, you should use that value as input here.
ledgerName :: Text
The name of the ledger.

Instances

Instances details

ToHeaders ListJournalKinesisStreamsForLedger Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Methods toHeaders :: ListJournalKinesisStreamsForLedger -> [Header] #
ToPath ListJournalKinesisStreamsForLedger Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Methods toPath :: ListJournalKinesisStreamsForLedger -> ByteString #
ToQuery ListJournalKinesisStreamsForLedger Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Methods toQuery :: ListJournalKinesisStreamsForLedger -> QueryString #
AWSRequest ListJournalKinesisStreamsForLedger Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Associated Types type AWSResponse ListJournalKinesisStreamsForLedger # Methods request :: (Service -> Service) -> ListJournalKinesisStreamsForLedger -> Request ListJournalKinesisStreamsForLedger # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListJournalKinesisStreamsForLedger -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListJournalKinesisStreamsForLedger))) #
Generic ListJournalKinesisStreamsForLedger Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Associated Types type Rep ListJournalKinesisStreamsForLedger :: Type -> Type # Methods from :: ListJournalKinesisStreamsForLedger -> Rep ListJournalKinesisStreamsForLedger x # to :: Rep ListJournalKinesisStreamsForLedger x -> ListJournalKinesisStreamsForLedger #
Read ListJournalKinesisStreamsForLedger Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Methods readsPrec :: Int -> ReadS ListJournalKinesisStreamsForLedger # readList :: ReadS [ListJournalKinesisStreamsForLedger] # readPrec :: ReadPrec ListJournalKinesisStreamsForLedger # readListPrec :: ReadPrec [ListJournalKinesisStreamsForLedger] #
Show ListJournalKinesisStreamsForLedger Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Methods showsPrec :: Int -> ListJournalKinesisStreamsForLedger -> ShowS # show :: ListJournalKinesisStreamsForLedger -> String # showList :: [ListJournalKinesisStreamsForLedger] -> ShowS #
NFData ListJournalKinesisStreamsForLedger Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Methods rnf :: ListJournalKinesisStreamsForLedger -> () #
Eq ListJournalKinesisStreamsForLedger Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Methods (==) :: ListJournalKinesisStreamsForLedger -> ListJournalKinesisStreamsForLedger -> Bool # (/=) :: ListJournalKinesisStreamsForLedger -> ListJournalKinesisStreamsForLedger -> Bool #
Hashable ListJournalKinesisStreamsForLedger Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Methods hashWithSalt :: Int -> ListJournalKinesisStreamsForLedger -> Int # hash :: ListJournalKinesisStreamsForLedger -> Int #
type AWSResponse ListJournalKinesisStreamsForLedger Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger type AWSResponse ListJournalKinesisStreamsForLedger = ListJournalKinesisStreamsForLedgerResponse
type Rep ListJournalKinesisStreamsForLedger Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger type Rep ListJournalKinesisStreamsForLedger = D1 ('MetaData "ListJournalKinesisStreamsForLedger" "Amazonka.QLDB.ListJournalKinesisStreamsForLedger" "amazonka-qldb-2.0-GHDpAUfL5Gp5EFIat3BpxK" 'False) (C1 ('MetaCons "ListJournalKinesisStreamsForLedger'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ledgerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListJournalKinesisStreamsForLedger Source #

Arguments

:: Text	`ListJournalKinesisStreamsForLedger`
-> ListJournalKinesisStreamsForLedger

Create a value of ListJournalKinesisStreamsForLedger 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:maxResults:ListJournalKinesisStreamsForLedger', listJournalKinesisStreamsForLedger_maxResults - The maximum number of results to return in a single ListJournalKinesisStreamsForLedger request. (The actual number of results returned might be fewer.)

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

ListJournalKinesisStreamsForLedger, listJournalKinesisStreamsForLedger_ledgerName - The name of the ledger.

Request Lenses

listJournalKinesisStreamsForLedger_maxResults :: Lens' ListJournalKinesisStreamsForLedger (Maybe Natural) Source #

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

listJournalKinesisStreamsForLedger_nextToken :: Lens' ListJournalKinesisStreamsForLedger (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 ListJournalKinesisStreamsForLedger call, you should use that value as input here.

listJournalKinesisStreamsForLedger_ledgerName :: Lens' ListJournalKinesisStreamsForLedger Text Source #

The name of the ledger.

Destructuring the Response

data ListJournalKinesisStreamsForLedgerResponse Source #

See: newListJournalKinesisStreamsForLedgerResponse smart constructor.

Constructors

ListJournalKinesisStreamsForLedgerResponse'

Fields

nextToken :: Maybe Text
- If NextToken is empty, the last page of results has been processed and there are no more results to be retrieved.
- If NextToken is not empty, more results are available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalKinesisStreamsForLedger call.
streams :: Maybe [JournalKinesisStreamDescription]
The array of QLDB journal stream descriptors that are associated with the given ledger.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListJournalKinesisStreamsForLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Associated Types type Rep ListJournalKinesisStreamsForLedgerResponse :: Type -> Type # Methods from :: ListJournalKinesisStreamsForLedgerResponse -> Rep ListJournalKinesisStreamsForLedgerResponse x # to :: Rep ListJournalKinesisStreamsForLedgerResponse x -> ListJournalKinesisStreamsForLedgerResponse #
Read ListJournalKinesisStreamsForLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Methods readsPrec :: Int -> ReadS ListJournalKinesisStreamsForLedgerResponse # readList :: ReadS [ListJournalKinesisStreamsForLedgerResponse] # readPrec :: ReadPrec ListJournalKinesisStreamsForLedgerResponse # readListPrec :: ReadPrec [ListJournalKinesisStreamsForLedgerResponse] #
Show ListJournalKinesisStreamsForLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Methods showsPrec :: Int -> ListJournalKinesisStreamsForLedgerResponse -> ShowS # show :: ListJournalKinesisStreamsForLedgerResponse -> String # showList :: [ListJournalKinesisStreamsForLedgerResponse] -> ShowS #
NFData ListJournalKinesisStreamsForLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Methods rnf :: ListJournalKinesisStreamsForLedgerResponse -> () #
Eq ListJournalKinesisStreamsForLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger Methods (==) :: ListJournalKinesisStreamsForLedgerResponse -> ListJournalKinesisStreamsForLedgerResponse -> Bool # (/=) :: ListJournalKinesisStreamsForLedgerResponse -> ListJournalKinesisStreamsForLedgerResponse -> Bool #
type Rep ListJournalKinesisStreamsForLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.ListJournalKinesisStreamsForLedger type Rep ListJournalKinesisStreamsForLedgerResponse = D1 ('MetaData "ListJournalKinesisStreamsForLedgerResponse" "Amazonka.QLDB.ListJournalKinesisStreamsForLedger" "amazonka-qldb-2.0-GHDpAUfL5Gp5EFIat3BpxK" 'False) (C1 ('MetaCons "ListJournalKinesisStreamsForLedgerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "streams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JournalKinesisStreamDescription])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListJournalKinesisStreamsForLedgerResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListJournalKinesisStreamsForLedgerResponse'`
-> ListJournalKinesisStreamsForLedgerResponse

Create a value of ListJournalKinesisStreamsForLedgerResponse 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:

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

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

$sel:streams:ListJournalKinesisStreamsForLedgerResponse', listJournalKinesisStreamsForLedgerResponse_streams - The array of QLDB journal stream descriptors that are associated with the given ledger.

$sel:httpStatus:ListJournalKinesisStreamsForLedgerResponse', listJournalKinesisStreamsForLedgerResponse_httpStatus - The response's http status code.

Response Lenses

listJournalKinesisStreamsForLedgerResponse_nextToken :: Lens' ListJournalKinesisStreamsForLedgerResponse (Maybe Text) Source #

If NextToken is empty, the last page of results has been processed and there are no more results to be retrieved.
If NextToken is not empty, more results are available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalKinesisStreamsForLedger call.

listJournalKinesisStreamsForLedgerResponse_streams :: Lens' ListJournalKinesisStreamsForLedgerResponse (Maybe [JournalKinesisStreamDescription]) Source #

The array of QLDB journal stream descriptors that are associated with the given ledger.

listJournalKinesisStreamsForLedgerResponse_httpStatus :: Lens' ListJournalKinesisStreamsForLedgerResponse Int Source #

The response's http status code.