QLDB / Client / list_journal_s3_exports_for_ledger
list_journal_s3_exports_for_ledger#
- QLDB.Client.list_journal_s3_exports_for_ledger(**kwargs)#
Returns all journal export jobs for a specified ledger.
This action returns a maximum of
MaxResults
items, and is paginated so that you can retrieve all the items by callingListJournalS3ExportsForLedger
multiple times.This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.list_journal_s3_exports_for_ledger( Name='string', MaxResults=123, NextToken='string' )
- Parameters:
Name (string) –
[REQUIRED]
The name of the ledger.
MaxResults (integer) – The maximum number of results to return in a single
ListJournalS3ExportsForLedger
request. (The actual number of results returned might be fewer.)NextToken (string) – A pagination token, indicating that you want to retrieve the next page of results. If you received a value for
NextToken
in the response from a previousListJournalS3ExportsForLedger
call, then you should use that value as input here.
- Return type:
dict
- Returns:
Response Syntax
{ 'JournalS3Exports': [ { 'LedgerName': 'string', 'ExportId': 'string', 'ExportCreationTime': datetime(2015, 1, 1), 'Status': 'IN_PROGRESS'|'COMPLETED'|'CANCELLED', 'InclusiveStartTime': datetime(2015, 1, 1), 'ExclusiveEndTime': datetime(2015, 1, 1), 'S3ExportConfiguration': { 'Bucket': 'string', 'Prefix': 'string', 'EncryptionConfiguration': { 'ObjectEncryptionType': 'SSE_KMS'|'SSE_S3'|'NO_ENCRYPTION', 'KmsKeyArn': 'string' } }, 'RoleArn': 'string', 'OutputFormat': 'ION_BINARY'|'ION_TEXT'|'JSON' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
JournalS3Exports (list) –
The journal export jobs that are currently associated with the specified ledger.
(dict) –
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.
LedgerName (string) –
The name of the ledger.
ExportId (string) –
The UUID (represented in Base62-encoded text) of the journal export job.
ExportCreationTime (datetime) –
The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
Status (string) –
The current state of the journal export job.
InclusiveStartTime (datetime) –
The inclusive start date and time for the range of journal contents that was specified in the original export request.
ExclusiveEndTime (datetime) –
The exclusive end date and time for the range of journal contents that was specified in the original export request.
S3ExportConfiguration (dict) –
The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.
Bucket (string) –
The Amazon S3 bucket name in which a journal export job writes the journal contents.
The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.
Prefix (string) –
The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.
The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.
The following are examples of valid
Prefix
values:JournalExports-ForMyLedger/Testing/
JournalExports
My:Tests/
EncryptionConfiguration (dict) –
The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.
ObjectEncryptionType (string) –
The Amazon S3 object encryption type.
To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.
KmsKeyArn (string) –
The Amazon Resource Name (ARN) of a symmetric encryption key in Key Management Service (KMS). Amazon S3 does not support asymmetric KMS keys.
You must provide a
KmsKeyArn
if you specifySSE_KMS
as theObjectEncryptionType
.KmsKeyArn
is not required if you specifySSE_S3
as theObjectEncryptionType
.
RoleArn (string) –
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.
OutputFormat (string) –
The output format of the exported journal data.
NextToken (string) –
If
NextToken
is empty, then the last page of results has been processed and there are no more results to be retrieved.If
NextToken
is not empty, then there are more results available. To retrieve the next page of results, use the value ofNextToken
in a subsequentListJournalS3ExportsForLedger
call.