ManagedBlockchainQuery / Paginator / ListTransactions

ListTransactions#

class ManagedBlockchainQuery.Paginator.ListTransactions#
paginator = client.get_paginator('list_transactions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ManagedBlockchainQuery.Client.list_transactions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    address='string',
    network='ETHEREUM_MAINNET'|'ETHEREUM_SEPOLIA_TESTNET'|'BITCOIN_MAINNET'|'BITCOIN_TESTNET',
    fromBlockchainInstant={
        'time': datetime(2015, 1, 1)
    },
    toBlockchainInstant={
        'time': datetime(2015, 1, 1)
    },
    sort={
        'sortBy': 'TRANSACTION_TIMESTAMP',
        'sortOrder': 'ASCENDING'|'DESCENDING'
    },
    confirmationStatusFilter={
        'include': [
            'FINAL'|'NONFINAL',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • address (string) –

    [REQUIRED]

    The address (either a contract or wallet), whose transactions are being requested.

  • network (string) –

    [REQUIRED]

    The blockchain network where the transactions occurred.

  • fromBlockchainInstant (dict) –

    The container for time.

    • time (datetime) –

      The container of the Timestamp of the blockchain instant.

      Note

      This timestamp will only be recorded up to the second.

  • toBlockchainInstant (dict) –

    The container for time.

    • time (datetime) –

      The container of the Timestamp of the blockchain instant.

      Note

      This timestamp will only be recorded up to the second.

  • sort (dict) –

    The order by which the results will be sorted.

    • sortBy (string) –

      Defaults to the value TRANSACTION_TIMESTAMP.

    • sortOrder (string) –

      The container for the sort order for ListTransactions. The SortOrder field only accepts the values ASCENDING and DESCENDING. Not providing SortOrder will default to ASCENDING.

  • confirmationStatusFilter (dict) –

    This filter is used to include transactions in the response that haven’t reached finality. Transactions that have reached finality are always part of the response.

    • include (list) – [REQUIRED]

      The container to determine whether to list results that have only reached finality. Transactions that have reached finality are always part of the response.

      • (string) –

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'transactions': [
        {
            'transactionHash': 'string',
            'transactionId': 'string',
            'network': 'ETHEREUM_MAINNET'|'ETHEREUM_SEPOLIA_TESTNET'|'BITCOIN_MAINNET'|'BITCOIN_TESTNET',
            'transactionTimestamp': datetime(2015, 1, 1),
            'confirmationStatus': 'FINAL'|'NONFINAL'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • transactions (list) –

      The array of transactions returned by the request.

      • (dict) –

        The container of the transaction output.

        • transactionHash (string) –

          The hash of a transaction. It is generated when a transaction is created.

        • transactionId (string) –

          The identifier of a Bitcoin transaction. It is generated when a transaction is created.

        • network (string) –

          The blockchain network where the transaction occurred.

        • transactionTimestamp (datetime) –

          The time when the transaction occurred.

        • confirmationStatus (string) –

          Specifies whether to list transactions that have not reached Finality.

    • NextToken (string) –

      A token to resume pagination.