Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListJournalS3ExportsForLedger

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 calling ListJournalS3ExportsForLedger multiple times.

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.

Request Syntax


GET /ledgers/name/journal-s3-exports?max_results=MaxResults&next_token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return in a single ListJournalS3ExportsForLedger request. (The actual number of results returned might be fewer.)

Valid Range: Minimum value of 1. Maximum value of 100.

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

NextToken

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 previous ListJournalS3ExportsForLedger call, then you should use that value as input here.

Length Constraints: Minimum length of 4. Maximum length of 1024.

Pattern: ^[A-Za-z-0-9+/=]+$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "JournalS3Exports": [ 
      { 
         "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"
      }
   ],
   "NextToken": "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.

JournalS3Exports

The journal export jobs that are currently associated with the specified ledger.

Type: Array of JournalS3ExportDescription objects

NextToken

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 of NextToken in a subsequent ListJournalS3ExportsForLedger call.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

Pattern: ^[A-Za-z-0-9+/=]+$

Errors

For information about the errors that are common to all actions, see Common Errors.