amazonka-qldb-2.0: Amazon QLDB SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.QLDB.ListJournalS3Exports

Description

Returns an array of journal export job descriptions for 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 ListJournalS3Exports 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 ListJournalS3Exports Source #

See: newListJournalS3Exports smart constructor.

Constructors

ListJournalS3Exports' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of results to return in a single ListJournalS3Exports 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 ListJournalS3Exports call, then you should use that value as input here.

Instances

Instances details
ToHeaders ListJournalS3Exports Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Methods

toHeaders :: ListJournalS3Exports -> [Header] #

ToPath ListJournalS3Exports Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Methods

toPath :: ListJournalS3Exports -> ByteString #

ToQuery ListJournalS3Exports Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Methods

toQuery :: ListJournalS3Exports -> QueryString #

AWSRequest ListJournalS3Exports Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Associated Types

type AWSResponse ListJournalS3Exports #

Methods

request :: (Service -> Service) -> ListJournalS3Exports -> Request ListJournalS3Exports #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListJournalS3Exports -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListJournalS3Exports))) #

Generic ListJournalS3Exports Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Associated Types

type Rep ListJournalS3Exports :: Type -> Type #

Methods

from :: ListJournalS3Exports -> Rep ListJournalS3Exports x #

to :: Rep ListJournalS3Exports x -> ListJournalS3Exports #

Read ListJournalS3Exports Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Methods

readsPrec :: Int -> ReadS ListJournalS3Exports #

readList :: ReadS [ListJournalS3Exports] #

readPrec :: ReadPrec ListJournalS3Exports #

readListPrec :: ReadPrec [ListJournalS3Exports] #

Show ListJournalS3Exports Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Methods

showsPrec :: Int -> ListJournalS3Exports -> ShowS #

show :: ListJournalS3Exports -> String #

showList :: [ListJournalS3Exports] -> ShowS #

NFData ListJournalS3Exports Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Methods

rnf :: ListJournalS3Exports -> () #

Eq ListJournalS3Exports Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Methods

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

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

Hashable ListJournalS3Exports Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Methods

hashWithSalt :: Int -> ListJournalS3Exports -> Int #

hash :: ListJournalS3Exports -> Int #

type AWSResponse ListJournalS3Exports Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

type AWSResponse ListJournalS3Exports = ListJournalS3ExportsResponse
type Rep ListJournalS3Exports Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

type Rep ListJournalS3Exports = D1 ('MetaData "ListJournalS3Exports" "Amazonka.QLDB.ListJournalS3Exports" "amazonka-qldb-2.0-GHDpAUfL5Gp5EFIat3BpxK" 'False) (C1 ('MetaCons "ListJournalS3Exports'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListJournalS3Exports :: ListJournalS3Exports Source #

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

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

Request Lenses

listJournalS3Exports_maxResults :: Lens' ListJournalS3Exports (Maybe Natural) Source #

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

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

Destructuring the Response

data ListJournalS3ExportsResponse Source #

See: newListJournalS3ExportsResponse smart constructor.

Constructors

ListJournalS3ExportsResponse' 

Fields

  • journalS3Exports :: Maybe [JournalS3ExportDescription]

    The array of journal export job descriptions for all ledgers that are associated with the current Amazon Web Services account and Region.

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

    The response's http status code.

Instances

Instances details
Generic ListJournalS3ExportsResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Associated Types

type Rep ListJournalS3ExportsResponse :: Type -> Type #

Methods

from :: ListJournalS3ExportsResponse -> Rep ListJournalS3ExportsResponse x #

to :: Rep ListJournalS3ExportsResponse x -> ListJournalS3ExportsResponse #

Read ListJournalS3ExportsResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Methods

readsPrec :: Int -> ReadS ListJournalS3ExportsResponse #

readList :: ReadS [ListJournalS3ExportsResponse] #

readPrec :: ReadPrec ListJournalS3ExportsResponse #

readListPrec :: ReadPrec [ListJournalS3ExportsResponse] #

Show ListJournalS3ExportsResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Methods

showsPrec :: Int -> ListJournalS3ExportsResponse -> ShowS #

show :: ListJournalS3ExportsResponse -> String #

showList :: [ListJournalS3ExportsResponse] -> ShowS #

NFData ListJournalS3ExportsResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Methods

rnf :: ListJournalS3ExportsResponse -> () #

Eq ListJournalS3ExportsResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

Methods

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

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

type Rep ListJournalS3ExportsResponse Source # 
Instance details

Defined in Amazonka.QLDB.ListJournalS3Exports

type Rep ListJournalS3ExportsResponse = D1 ('MetaData "ListJournalS3ExportsResponse" "Amazonka.QLDB.ListJournalS3Exports" "amazonka-qldb-2.0-GHDpAUfL5Gp5EFIat3BpxK" 'False) (C1 ('MetaCons "ListJournalS3ExportsResponse'" '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))))

newListJournalS3ExportsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListJournalS3ExportsResponse'

-> ListJournalS3ExportsResponse 

Create a value of ListJournalS3ExportsResponse 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:ListJournalS3ExportsResponse', listJournalS3ExportsResponse_journalS3Exports - The array of journal export job descriptions for all ledgers that are associated with the current Amazon Web Services account and Region.

ListJournalS3Exports, listJournalS3ExportsResponse_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 ListJournalS3Exports call.

$sel:httpStatus:ListJournalS3ExportsResponse', listJournalS3ExportsResponse_httpStatus - The response's http status code.

Response Lenses

listJournalS3ExportsResponse_journalS3Exports :: Lens' ListJournalS3ExportsResponse (Maybe [JournalS3ExportDescription]) Source #

The array of journal export job descriptions for all ledgers that are associated with the current Amazon Web Services account and Region.

listJournalS3ExportsResponse_nextToken :: Lens' ListJournalS3ExportsResponse (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 ListJournalS3Exports call.

listJournalS3ExportsResponse_httpStatus :: Lens' ListJournalS3ExportsResponse Int Source #

The response's http status code.