DescribeJournalS3Export
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.
Request Syntax
GET /ledgers/name/journal-s3-exports/exportId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- exportId
-
The UUID (represented in Base62-encoded text) of the journal export job to describe.
Length Constraints: Fixed length of 22.
Pattern:
^[A-Za-z-0-9]+$Required: Yes
- name
-
The name of the ledger.
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ExportDescription": {
"ExclusiveEndTime": number,
"ExportCreationTime": number,
"ExportId": "string",
"InclusiveStartTime": number,
"LedgerName": "string",
"OutputFormat": "string",
"RoleArn": "string",
"S3ExportConfiguration": {
"Bucket": "string",
"EncryptionConfiguration": {
"KmsKeyArn": "string",
"ObjectEncryptionType": "string"
},
"Prefix": "string"
},
"Status": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ExportDescription
-
Information about the journal export job returned by a
DescribeJournalS3Exportrequest.Type: JournalS3ExportDescription object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundException
-
The specified resource doesn't exist.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
