Amazon QLDB · Schema
ExportJournalToS3Request
ExportJournalToS3Request schema from Amazon QLDB API
BlockchainDatabaseLedger
Properties
| Name | Type | Description |
|---|---|---|
| InclusiveStartTime | object | |
| ExclusiveEndTime | object | |
| S3ExportConfiguration | object | |
| RoleArn | object | |
| OutputFormat | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-qldb/refs/heads/main/json-schema/amazon-qldb-export-journal-to-s3request-schema.json",
"title": "ExportJournalToS3Request",
"description": "ExportJournalToS3Request schema from Amazon QLDB API",
"type": "object",
"properties": {
"InclusiveStartTime": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "<p>The inclusive start date and time for the range of journal contents to export.</p> <p>The <code>InclusiveStartTime</code> must be in <code>ISO 8601</code> date and time format and in Universal Coordinated Time (UTC). For example: <code>2019-06-13T21:36:34Z</code>.</p> <p>The <code>InclusiveStartTime</code> must be before <code>ExclusiveEndTime</code>.</p> <p>If you provide an <code>InclusiveStartTime</code> that is before the ledger's <code>CreationDateTime</code>, Amazon QLDB defaults it to the ledger's <code>CreationDateTime</code>.</p>"
}
]
},
"ExclusiveEndTime": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "<p>The exclusive end date and time for the range of journal contents to export.</p> <p>The <code>ExclusiveEndTime</code> must be in <code>ISO 8601</code> date and time format and in Universal Coordinated Time (UTC). For example: <code>2019-06-13T21:36:34Z</code>.</p> <p>The <code>ExclusiveEndTime</code> must be less than or equal to the current UTC date and time.</p>"
}
]
},
"S3ExportConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/S3ExportConfiguration"
},
{
"description": "The configuration settings of the Amazon S3 bucket destination for your export request."
}
]
},
"RoleArn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "<p>The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:</p> <ul> <li> <p>Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.</p> </li> <li> <p>(Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.</p> </li> </ul> <p>To pass a role to QLDB when requesting a journal export, you must have permissions to perform the <code>iam:PassRole</code> action on the IAM role resource. This is required for all journal export requests.</p>"
}
]
},
"OutputFormat": {
"allOf": [
{
"$ref": "#/components/schemas/OutputFormat"
},
{
"description": "The output format of your exported journal data. If this parameter is not specified, the exported data defaults to <code>ION_TEXT</code> format."
}
]
}
},
"required": [
"InclusiveStartTime",
"ExclusiveEndTime",
"S3ExportConfiguration",
"RoleArn"
]
}