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

Description

Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.

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

If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException.

If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

Synopsis

Creating a Request

data DescribeJournalS3Export Source #

See: newDescribeJournalS3Export smart constructor.

Constructors

DescribeJournalS3Export' 

Fields

  • name :: Text

    The name of the ledger.

  • exportId :: Text

    The UUID (represented in Base62-encoded text) of the journal export job to describe.

Instances

Instances details
Eq DescribeJournalS3Export Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

Read DescribeJournalS3Export Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

Show DescribeJournalS3Export Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

Generic DescribeJournalS3Export Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

Associated Types

type Rep DescribeJournalS3Export :: Type -> Type #

NFData DescribeJournalS3Export Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

Methods

rnf :: DescribeJournalS3Export -> () #

Hashable DescribeJournalS3Export Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

AWSRequest DescribeJournalS3Export Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

ToHeaders DescribeJournalS3Export Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

ToPath DescribeJournalS3Export Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

ToQuery DescribeJournalS3Export Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

type Rep DescribeJournalS3Export Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

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

Defined in Amazonka.QLDB.DescribeJournalS3Export

newDescribeJournalS3Export Source #

Create a value of DescribeJournalS3Export 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:name:DescribeJournalS3Export', describeJournalS3Export_name - The name of the ledger.

$sel:exportId:DescribeJournalS3Export', describeJournalS3Export_exportId - The UUID (represented in Base62-encoded text) of the journal export job to describe.

Request Lenses

describeJournalS3Export_exportId :: Lens' DescribeJournalS3Export Text Source #

The UUID (represented in Base62-encoded text) of the journal export job to describe.

Destructuring the Response

data DescribeJournalS3ExportResponse Source #

See: newDescribeJournalS3ExportResponse smart constructor.

Constructors

DescribeJournalS3ExportResponse' 

Fields

Instances

Instances details
Eq DescribeJournalS3ExportResponse Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

Read DescribeJournalS3ExportResponse Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

Show DescribeJournalS3ExportResponse Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

Generic DescribeJournalS3ExportResponse Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

Associated Types

type Rep DescribeJournalS3ExportResponse :: Type -> Type #

NFData DescribeJournalS3ExportResponse Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

type Rep DescribeJournalS3ExportResponse Source # 
Instance details

Defined in Amazonka.QLDB.DescribeJournalS3Export

type Rep DescribeJournalS3ExportResponse = D1 ('MetaData "DescribeJournalS3ExportResponse" "Amazonka.QLDB.DescribeJournalS3Export" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "DescribeJournalS3ExportResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "exportDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JournalS3ExportDescription)))

newDescribeJournalS3ExportResponse Source #

Create a value of DescribeJournalS3ExportResponse 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:httpStatus:DescribeJournalS3ExportResponse', describeJournalS3ExportResponse_httpStatus - The response's http status code.

$sel:exportDescription:DescribeJournalS3ExportResponse', describeJournalS3ExportResponse_exportDescription - Information about the journal export job returned by a DescribeJournalS3Export request.

Response Lenses

describeJournalS3ExportResponse_exportDescription :: Lens' DescribeJournalS3ExportResponse JournalS3ExportDescription Source #

Information about the journal export job returned by a DescribeJournalS3Export request.