Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.QLDB.ExportJournalToS3

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format.

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

If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException.

You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException.

Synopsis

data ExportJournalToS3 = ExportJournalToS3' {
- name :: Text
- inclusiveStartTime :: POSIX
- exclusiveEndTime :: POSIX
- s3ExportConfiguration :: S3ExportConfiguration
- roleArn :: Text
}
newExportJournalToS3 :: Text -> UTCTime -> UTCTime -> S3ExportConfiguration -> Text -> ExportJournalToS3
exportJournalToS3_name :: Lens' ExportJournalToS3 Text
exportJournalToS3_inclusiveStartTime :: Lens' ExportJournalToS3 UTCTime
exportJournalToS3_exclusiveEndTime :: Lens' ExportJournalToS3 UTCTime
exportJournalToS3_s3ExportConfiguration :: Lens' ExportJournalToS3 S3ExportConfiguration
exportJournalToS3_roleArn :: Lens' ExportJournalToS3 Text
data ExportJournalToS3Response = ExportJournalToS3Response' {
- httpStatus :: Int
- exportId :: Text
}
newExportJournalToS3Response :: Int -> Text -> ExportJournalToS3Response
exportJournalToS3Response_httpStatus :: Lens' ExportJournalToS3Response Int
exportJournalToS3Response_exportId :: Lens' ExportJournalToS3Response Text

Creating a Request

data ExportJournalToS3 Source #

See: newExportJournalToS3 smart constructor.

Constructors

ExportJournalToS3'

Fields

name :: Text
The name of the ledger.
inclusiveStartTime :: POSIX
The inclusive start date and time for the range of journal contents to export.
The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.
The InclusiveStartTime must be before ExclusiveEndTime.
If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.
exclusiveEndTime :: POSIX
The exclusive end date and time for the range of journal contents to export.
The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.
The ExclusiveEndTime must be less than or equal to the current UTC date and time.
s3ExportConfiguration :: S3ExportConfiguration
The configuration settings of the Amazon S3 bucket destination for your export request.
roleArn :: Text
The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:
- Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.
- (Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side encryption of your exported data.

Instances

Instances details

Eq ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 Methods (==) :: ExportJournalToS3 -> ExportJournalToS3 -> Bool # (/=) :: ExportJournalToS3 -> ExportJournalToS3 -> Bool #
Read ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 Methods readsPrec :: Int -> ReadS ExportJournalToS3 # readList :: ReadS [ExportJournalToS3] # readPrec :: ReadPrec ExportJournalToS3 # readListPrec :: ReadPrec [ExportJournalToS3] #
Show ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 Methods showsPrec :: Int -> ExportJournalToS3 -> ShowS # show :: ExportJournalToS3 -> String # showList :: [ExportJournalToS3] -> ShowS #
Generic ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 Associated Types type Rep ExportJournalToS3 :: Type -> Type # Methods from :: ExportJournalToS3 -> Rep ExportJournalToS3 x # to :: Rep ExportJournalToS3 x -> ExportJournalToS3 #
NFData ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 Methods rnf :: ExportJournalToS3 -> () #
Hashable ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 Methods hashWithSalt :: Int -> ExportJournalToS3 -> Int # hash :: ExportJournalToS3 -> Int #
ToJSON ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 Methods toJSON :: ExportJournalToS3 -> Value # toEncoding :: ExportJournalToS3 -> Encoding # toJSONList :: [ExportJournalToS3] -> Value # toEncodingList :: [ExportJournalToS3] -> Encoding #
AWSRequest ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 Associated Types type AWSResponse ExportJournalToS3 # Methods request :: ExportJournalToS3 -> Request ExportJournalToS3 # response :: MonadResource m => Logger -> Service -> Proxy ExportJournalToS3 -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ExportJournalToS3))) #
ToHeaders ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 Methods toHeaders :: ExportJournalToS3 -> [Header] #
ToPath ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 Methods toPath :: ExportJournalToS3 -> ByteString #
ToQuery ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 Methods toQuery :: ExportJournalToS3 -> QueryString #
type Rep ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 type Rep ExportJournalToS3 = D1 ('MetaData "ExportJournalToS3" "Amazonka.QLDB.ExportJournalToS3" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "ExportJournalToS3'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "inclusiveStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :: (S1 ('MetaSel ('Just "exclusiveEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "s3ExportConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3ExportConfiguration) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ExportJournalToS3 Source #
Instance details Defined in Amazonka.QLDB.ExportJournalToS3 type AWSResponse ExportJournalToS3 = ExportJournalToS3Response

newExportJournalToS3 Source #

Arguments

:: Text	`$sel:name:ExportJournalToS3'`
-> UTCTime	`$sel:inclusiveStartTime:ExportJournalToS3'`
-> UTCTime	`$sel:exclusiveEndTime:ExportJournalToS3'`
-> S3ExportConfiguration	`$sel:s3ExportConfiguration:ExportJournalToS3'`
-> Text	`$sel:roleArn:ExportJournalToS3'`
-> ExportJournalToS3

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

$sel:inclusiveStartTime:ExportJournalToS3', exportJournalToS3_inclusiveStartTime - The inclusive start date and time for the range of journal contents to export.

The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.

$sel:exclusiveEndTime:ExportJournalToS3', exportJournalToS3_exclusiveEndTime - The exclusive end date and time for the range of journal contents to export.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The ExclusiveEndTime must be less than or equal to the current UTC date and time.

$sel:s3ExportConfiguration:ExportJournalToS3', exportJournalToS3_s3ExportConfiguration - The configuration settings of the Amazon S3 bucket destination for your export request.

$sel:roleArn:ExportJournalToS3', exportJournalToS3_roleArn - The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.
(Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side encryption of your exported data.

Request Lenses

exportJournalToS3_name :: Lens' ExportJournalToS3 Text Source #

The name of the ledger.

exportJournalToS3_inclusiveStartTime :: Lens' ExportJournalToS3 UTCTime Source #

The inclusive start date and time for the range of journal contents to export.

The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.

exportJournalToS3_exclusiveEndTime :: Lens' ExportJournalToS3 UTCTime Source #

The exclusive end date and time for the range of journal contents to export.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The ExclusiveEndTime must be less than or equal to the current UTC date and time.

exportJournalToS3_s3ExportConfiguration :: Lens' ExportJournalToS3 S3ExportConfiguration Source #

The configuration settings of the Amazon S3 bucket destination for your export request.

exportJournalToS3_roleArn :: Lens' ExportJournalToS3 Text Source #

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.
(Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side encryption of your exported data.

Destructuring the Response

data ExportJournalToS3Response Source #

See: newExportJournalToS3Response smart constructor.

Constructors

ExportJournalToS3Response'
Fields httpStatus :: Int The response's http status code. exportId :: Text The UUID (represented in Base62-encoded text) that QLDB assigns to each journal export job. To describe your export request and check the status of the job, you can use `ExportId` to call `DescribeJournalS3Export`.

Instances

Instances details

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

newExportJournalToS3Response Source #

Arguments

:: Int	`$sel:httpStatus:ExportJournalToS3Response'`
-> Text	`$sel:exportId:ExportJournalToS3Response'`
-> ExportJournalToS3Response

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

$sel:exportId:ExportJournalToS3Response', exportJournalToS3Response_exportId - The UUID (represented in Base62-encoded text) that QLDB assigns to each journal export job.

To describe your export request and check the status of the job, you can use ExportId to call DescribeJournalS3Export.

Response Lenses

exportJournalToS3Response_httpStatus :: Lens' ExportJournalToS3Response Int Source #

The response's http status code.

exportJournalToS3Response_exportId :: Lens' ExportJournalToS3Response Text Source #

The UUID (represented in Base62-encoded text) that QLDB assigns to each journal export job.

To describe your export request and check the status of the job, you can use ExportId to call DescribeJournalS3Export.