Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListTransactions

Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.

This operation can help you identify uncommitted transactions or to get information about transactions.

Request Syntax


{
   "CatalogId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "StatusFilter": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CatalogId

The catalog for which to list transactions. Defaults to the account ID of the caller.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

MaxResults

The maximum number of transactions to return in a single call.

Type: Integer

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

Required: No

NextToken

A continuation token if this is not the first call to retrieve transactions.

Type: String

Length Constraints: Maximum length of 4096.

Required: No

StatusFilter

A filter indicating the status of transactions to return. Options are ALL | COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is ALL.

Type: String

Valid Values: ALL | COMPLETED | ACTIVE | COMMITTED | ABORTED

Required: No

Response Syntax


{
   "NextToken": "string",
   "Transactions": [ 
      { 
         "TransactionEndTime": number,
         "TransactionId": "string",
         "TransactionStartTime": number,
         "TransactionStatus": "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.

NextToken

A continuation token indicating whether additional data is available.

Type: String

Length Constraints: Maximum length of 4096.

Transactions

A list of transactions. The record for each transaction is a TransactionDescription object.

Type: Array of TransactionDescription objects

Errors

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

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400