| 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.ExportJournalToS3
Description
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.
In JSON Lines format, each journal block in the exported data object is a valid JSON object that is delimited by a newline. You can use this format to easily integrate JSON exports with analytics tools such as Glue and Amazon Athena because these services can parse newline-delimited JSON automatically. For more information about the format, see JSON Lines.
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' {}
- newExportJournalToS3 :: Text -> UTCTime -> UTCTime -> S3ExportConfiguration -> Text -> ExportJournalToS3
- exportJournalToS3_outputFormat :: Lens' ExportJournalToS3 (Maybe OutputFormat)
- 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
| |
Instances
Arguments
| :: Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> S3ExportConfiguration | |
| -> Text | |
| -> 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:
ExportJournalToS3, exportJournalToS3_outputFormat - The output format of your exported journal data. If this parameter is
not specified, the exported data defaults to ION_TEXT format.
ExportJournalToS3, exportJournalToS3_name - The name of the ledger.
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.
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.
ExportJournalToS3, exportJournalToS3_s3ExportConfiguration - The configuration settings of the Amazon S3 bucket destination for your
export request.
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 managed key in Key Management Service (KMS) for server-side encryption of your exported data.
To pass a role to QLDB when requesting a journal export, you must have
permissions to perform the iam:PassRole action on the IAM role
resource. This is required for all journal export requests.
Request Lenses
exportJournalToS3_outputFormat :: Lens' ExportJournalToS3 (Maybe OutputFormat) Source #
The output format of your exported journal data. If this parameter is
not specified, the exported data defaults to ION_TEXT format.
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 managed key in Key Management Service (KMS) for server-side encryption of your exported data.
To pass a role to QLDB when requesting a journal export, you must have
permissions to perform the iam:PassRole action on the IAM role
resource. This is required for all journal export requests.
Destructuring the Response
data ExportJournalToS3Response Source #
See: newExportJournalToS3Response smart constructor.
Constructors
| ExportJournalToS3Response' | |
Fields
| |
Instances
newExportJournalToS3Response Source #
Arguments
| :: Int | |
| -> Text | |
| -> 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.
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.