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.ListJournalS3ExportsForLedger

Description

Returns an array of journal export job descriptions for a specified ledger.

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

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.

Synopsis

Creating a Request

data ListJournalS3ExportsForLedger Source #

See: newListJournalS3ExportsForLedger smart constructor.

Constructors

ListJournalS3ExportsForLedger' 

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

  • maxResults :: Maybe Natural

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

  • name :: Text

    The name of the ledger.

Instances

Instances details
Eq ListJournalS3ExportsForLedger Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

Read ListJournalS3ExportsForLedger Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

Show ListJournalS3ExportsForLedger Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

Generic ListJournalS3ExportsForLedger Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

Associated Types

type Rep ListJournalS3ExportsForLedger :: Type -> Type #

NFData ListJournalS3ExportsForLedger Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

Hashable ListJournalS3ExportsForLedger Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

AWSRequest ListJournalS3ExportsForLedger Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

ToHeaders ListJournalS3ExportsForLedger Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

ToPath ListJournalS3ExportsForLedger Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

ToQuery ListJournalS3ExportsForLedger Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

type Rep ListJournalS3ExportsForLedger Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

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

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

newListJournalS3ExportsForLedger Source #

Create a value of ListJournalS3ExportsForLedger 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:ListJournalS3ExportsForLedger', listJournalS3ExportsForLedger_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 ListJournalS3ExportsForLedger call, then you should use that value as input here.

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

$sel:name:ListJournalS3ExportsForLedger', listJournalS3ExportsForLedger_name - The name of the ledger.

Request Lenses

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

listJournalS3ExportsForLedger_maxResults :: Lens' ListJournalS3ExportsForLedger (Maybe Natural) Source #

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

Destructuring the Response

data ListJournalS3ExportsForLedgerResponse Source #

Constructors

ListJournalS3ExportsForLedgerResponse' 

Fields

  • journalS3Exports :: Maybe [JournalS3ExportDescription]

    The array of journal export job descriptions that are associated with the specified ledger.

  • nextToken :: Maybe Text
    • 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 ListJournalS3ExportsForLedger call.
  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListJournalS3ExportsForLedgerResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

Read ListJournalS3ExportsForLedgerResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

Show ListJournalS3ExportsForLedgerResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

Generic ListJournalS3ExportsForLedgerResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

NFData ListJournalS3ExportsForLedgerResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

type Rep ListJournalS3ExportsForLedgerResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3ExportsForLedger

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

newListJournalS3ExportsForLedgerResponse Source #

Create a value of ListJournalS3ExportsForLedgerResponse 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:journalS3Exports:ListJournalS3ExportsForLedgerResponse', listJournalS3ExportsForLedgerResponse_journalS3Exports - The array of journal export job descriptions that are associated with the specified ledger.

$sel:nextToken:ListJournalS3ExportsForLedger', listJournalS3ExportsForLedgerResponse_nextToken - - 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 ListJournalS3ExportsForLedger call.

$sel:httpStatus:ListJournalS3ExportsForLedgerResponse', listJournalS3ExportsForLedgerResponse_httpStatus - The response's http status code.

Response Lenses

listJournalS3ExportsForLedgerResponse_journalS3Exports :: Lens' ListJournalS3ExportsForLedgerResponse (Maybe [JournalS3ExportDescription]) Source #

The array of journal export job descriptions that are associated with the specified ledger.

listJournalS3ExportsForLedgerResponse_nextToken :: Lens' ListJournalS3ExportsForLedgerResponse (Maybe Text) Source #

  • 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 ListJournalS3ExportsForLedger call.