LakeFormation / Client / list_transactions

list_transactions#

LakeFormation.Client.list_transactions(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_transactions(
    CatalogId='string',
    StatusFilter='ALL'|'COMPLETED'|'ACTIVE'|'COMMITTED'|'ABORTED',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • CatalogId (string) – The catalog for which to list transactions. Defaults to the account ID of the caller.

  • StatusFilter (string) – A filter indicating the status of transactions to return. Options are ALL | COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is ALL.

  • MaxResults (integer) – The maximum number of transactions to return in a single call.

  • NextToken (string) – A continuation token if this is not the first call to retrieve transactions.

Return type:

dict

Returns:

Response Syntax

{
    'Transactions': [
        {
            'TransactionId': 'string',
            'TransactionStatus': 'ACTIVE'|'COMMITTED'|'ABORTED'|'COMMIT_IN_PROGRESS',
            'TransactionStartTime': datetime(2015, 1, 1),
            'TransactionEndTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Transactions (list) –

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

      • (dict) –

        A structure that contains information about a transaction.

        • TransactionId (string) –

          The ID of the transaction.

        • TransactionStatus (string) –

          A status of ACTIVE, COMMITTED, or ABORTED.

        • TransactionStartTime (datetime) –

          The time when the transaction started.

        • TransactionEndTime (datetime) –

          The time when the transaction committed or aborted, if it is not currently active.

    • NextToken (string) –

      A continuation token indicating whether additional data is available.

Exceptions

  • LakeFormation.Client.exceptions.InvalidInputException

  • LakeFormation.Client.exceptions.InternalServiceException

  • LakeFormation.Client.exceptions.OperationTimeoutException