Amazon Managed Blockchain (AMB) Query provides you with convenient access to multi-blockchain network data, which makes it easier for you to extract contextual data related to blockchain activity. You can use AMB Query to read data from public blockchain networks, such as Bitcoin Mainnet and Ethereum Mainnet. You can also get information such as the current and historical balances of addresses, or you can get a list of blockchain transactions for a given time period. Additionally, you can get details of a given transaction, such as transaction events, which you can further analyze or use in business logic for your applications.
', 'operations' => [ 'BatchGetTokenBalance' => 'Gets the token balance for a batch of tokens by using the GetTokenBalance action for every token in the request.
Only the native tokens BTC,ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.
Gets the balance of a specific token, including native tokens, for a given address (wallet or contract) on the blockchain.
Only the native tokens BTC,ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.
Get the details of a transaction.
', 'ListTokenBalances' => 'This action returns the following for a given a blockchain network:
Lists all token balances owned by an address (either a contact address or a wallet address).
Lists all token balances for all tokens created by a contract.
Lists all token balances for a given token.
You must always specify the network property of the tokenFilter when using this operation.
An array of TransactionEvent objects. Each object contains details about the transaction event.
Lists all of the transactions on a given wallet address or to a specific contract.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'The Amazon Web Services account doesn’t have access to this resource.
', 'refs' => [], ], 'BatchGetTokenBalanceErrorItem' => [ 'base' => 'Error generated from a failed BatchGetTokenBalance request.
An array of BatchGetTokenBalanceErrorItem objects returned from the request.
The container for the input for getting a token balance.
', 'refs' => [ 'GetTokenBalanceInputList$member' => NULL, ], ], 'BatchGetTokenBalanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetTokenBalanceOutputItem' => [ 'base' => 'The container for the properties of a token balance output.
', 'refs' => [ 'BatchGetTokenBalanceOutputList$member' => NULL, ], ], 'BatchGetTokenBalanceOutputList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTokenBalanceOutput$tokenBalances' => 'An array of BatchGetTokenBalanceOutputItem objects returned by the response.
The block hash is a unique identifier for a block. It is a fixed-size string that is calculated by using the information in the block. The block hash is used to verify the integrity of the data in the block.
', ], ], 'BlockchainInstant' => [ 'base' => 'The container for time.
', 'refs' => [ 'BatchGetTokenBalanceErrorItem$atBlockchainInstant' => NULL, 'BatchGetTokenBalanceInputItem$atBlockchainInstant' => NULL, 'BatchGetTokenBalanceOutputItem$atBlockchainInstant' => NULL, 'BatchGetTokenBalanceOutputItem$lastUpdatedTime' => NULL, 'GetTokenBalanceInput$atBlockchainInstant' => 'The time for when the TokenBalance is requested or the current time if a time is not provided in the request.
This time will only be recorded up to the second.
The time for when the TokenBalance is requested or the current time if a time is not provided in the request.
This time will only be recorded up to the second.
The timestamp of the last transaction at which the balance for the token in the wallet was updated.
The address (either a contract or wallet), whose transactions are being requested.
', 'OwnerFilter$address' => 'The contract or wallet address.
', 'OwnerIdentifier$address' => 'The contract or wallet address for the owner.
', 'TokenFilter$contractAddress' => 'This is the address of the contract.
', 'TokenIdentifier$contractAddress' => 'This is the token\'s contract address.
', 'Transaction$to' => 'The identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
', 'Transaction$from' => 'The initiator of the transaction. It is either in the form a public key or a contract address.
', 'Transaction$contractAddress' => 'The blockchain address for the contract.
', 'TransactionEvent$from' => 'The wallet address initiating the transaction. It can either be a public key or a contract.
', 'TransactionEvent$to' => 'The wallet address receiving the transaction. It can either be a public key or a contract.
', 'TransactionEvent$contractAddress' => 'The blockchain address. for the contract
', ], ], 'ErrorType' => [ 'base' => NULL, 'refs' => [ 'BatchGetTokenBalanceErrorItem$errorType' => 'The type of error.
', ], ], 'ExceptionMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => 'The container for the exception message.
', 'InternalServerException$message' => 'The container for the exception message.
', 'ResourceNotFoundException$message' => 'The container for the exception message.
', 'ServiceQuotaExceededException$message' => 'The container for the exception message.
', 'ThrottlingException$message' => 'The container for the exception message.
', 'ValidationException$message' => 'The container for the exception message.
', ], ], 'GetTokenBalanceInput' => [ 'base' => NULL, 'refs' => [], ], 'GetTokenBalanceInputList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTokenBalanceInput$getTokenBalanceInputs' => 'An array of GetTokenBalanceInput objects whose balance is being requested.
The container of the retryAfterSeconds value.
The container of the retryAfterSeconds value.
The signature of the transaction. The Z coordinate of a point V.
', 'TransactionEvent$voutIndex' => 'The position of the vout in the transaction output list.
', ], ], 'InternalServerException' => [ 'base' => 'The request processing has failed because of an internal error in the service.
', 'refs' => [], ], 'ListTokenBalancesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTokenBalancesInputMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListTokenBalancesInput$maxResults' => 'The maximum number of token balances to return.
', ], ], 'ListTokenBalancesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTransactionEventsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTransactionEventsInputMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListTransactionEventsInput$maxResults' => 'The maximum number of transaction events to list.
Even if additional results can be retrieved, the request can return less results than maxResults or an empty array of results.
To retrieve the next set of results, make another request with the returned nextToken value. The value of nextToken is null when there are no more results to return
The maximum number of transactions to list.
Even if additional results can be retrieved, the request can return less results than maxResults or an empty array of results.
To retrieve the next set of results, make another request with the returned nextToken value. The value of nextToken is null when there are no more results to return
The container for determining how the list transaction result will be sorted.
', 'refs' => [ 'ListTransactionsInput$sort' => 'Sorts items in an ascending order if the first page starts at fromTime. Sorts items in a descending order if the first page starts at toTime.
Defaults to the value TRANSACTION_TIMESTAMP.
The index of the transaction within a blockchain.
', 'Transaction$numberOfTransactions' => 'The number of transactions in the block.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListTokenBalancesInput$nextToken' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListTokenBalancesOutput$nextToken' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListTransactionEventsInput$nextToken' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListTransactionEventsOutput$nextToken' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListTransactionsInput$nextToken' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListTransactionsOutput$nextToken' => 'The pagination token that indicates the next set of results to retrieve.
', ], ], 'OwnerFilter' => [ 'base' => 'The container for the owner information to filter by.
', 'refs' => [ 'ListTokenBalancesInput$ownerFilter' => 'The contract or wallet address on the blockchain network by which to filter the request. You must specify the address property of the ownerFilter when listing balances of tokens owned by the address.
The container for the identifier of the owner.
', 'refs' => [ 'BatchGetTokenBalanceErrorItem$ownerIdentifier' => NULL, 'BatchGetTokenBalanceInputItem$ownerIdentifier' => NULL, 'BatchGetTokenBalanceOutputItem$ownerIdentifier' => NULL, 'GetTokenBalanceInput$ownerIdentifier' => 'The container for the identifier for the owner.
', 'GetTokenBalanceOutput$ownerIdentifier' => NULL, 'TokenBalance$ownerIdentifier' => 'The container for the identifier of the owner.
', ], ], 'QueryNetwork' => [ 'base' => NULL, 'refs' => [ 'GetTransactionInput$network' => 'The blockchain network where the transaction occurred.
', 'ListTransactionEventsInput$network' => 'The blockchain network where the transaction events occurred.
', 'ListTransactionsInput$network' => 'The blockchain network where the transactions occurred.
', 'TokenFilter$network' => 'The blockchain network of the token.
', 'TokenIdentifier$network' => 'The blockchain network of the token.
', 'Transaction$network' => 'The blockchain network where the transaction occured.
', 'TransactionEvent$network' => 'The blockchain network where the transaction occurred.
', 'TransactionOutputItem$network' => 'The blockchain network where the transaction occurred.
', ], ], 'QueryTokenId' => [ 'base' => NULL, 'refs' => [ 'TokenFilter$tokenId' => 'The unique identifier of the token.
', 'TokenIdentifier$tokenId' => 'The unique identifier of the token.
', 'TransactionEvent$tokenId' => 'The unique identifier for the token involved in the transaction.
', ], ], 'QueryTransactionEventType' => [ 'base' => NULL, 'refs' => [ 'TransactionEvent$eventType' => 'The type of transaction event.
', ], ], 'QueryTransactionHash' => [ 'base' => NULL, 'refs' => [ 'GetTransactionInput$transactionHash' => 'The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
', 'ListTransactionEventsInput$transactionHash' => 'The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
', 'Transaction$transactionHash' => 'The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
', 'TransactionEvent$transactionHash' => 'The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
', 'TransactionOutputItem$transactionHash' => 'The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
', ], ], 'QueryTransactionStatus' => [ 'base' => NULL, 'refs' => [ 'Transaction$status' => 'The status of the transaction.
', ], ], 'QuotaCode' => [ 'base' => NULL, 'refs' => [ 'ServiceQuotaExceededException$quotaCode' => 'The container for the quotaCode.
The container for the quotaCode.
The resourceId of the resource that caused the exception.
The resourceId of the resource that caused the exception.
The resource was not found.
', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceNotFoundException$resourceType' => 'The resourceType of the resource that caused the exception.
The resourceType of the resource that caused the exception.
The container for the serviceCode.
The container for the serviceCode.
The service quota has been exceeded for this resource.
', 'refs' => [], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListTransactionsSort$sortOrder' => '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.
The error code associated with the error.
', 'BatchGetTokenBalanceErrorItem$errorMessage' => 'The message associated with the error.
', 'BatchGetTokenBalanceOutputItem$balance' => 'The container for the token balance.
', 'GetTokenBalanceOutput$balance' => 'The container for the token balance.
', 'TokenBalance$balance' => 'The container of the token balance.
', 'Transaction$blockNumber' => 'The block number in which the transaction is recorded.
', 'Transaction$gasUsed' => 'The amount of gas used for the transaction.
', 'Transaction$cumulativeGasUsed' => 'The amount of gas used up to the specified point in the block.
', 'Transaction$effectiveGasPrice' => 'The effective gas price.
', 'Transaction$signatureR' => 'The signature of the transaction. The X coordinate of a point R.
', 'Transaction$signatureS' => 'The signature of the transaction. The Y coordinate of a point S.
', 'Transaction$transactionFee' => 'The transaction fee.
', 'Transaction$transactionId' => 'The unique identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
', 'TransactionEvent$value' => 'The value that was transacted.
', 'TransactionEvent$transactionId' => 'The unique identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
', 'ValidationExceptionField$name' => 'The name of the field that triggered the ValidationException.
The ValidationException message.
The request or operation couldn\'t be performed because a service is throttling requests. The most common source of throttling errors is when you create resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources, if possible.
', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'BlockchainInstant$time' => 'The container of the Timestamp of the blockchain instant.
This timestamp will only be recorded up to the second.
The Timestamp of the transaction.
The time when the transaction occurred.
', ], ], 'TokenBalance' => [ 'base' => 'The balance of the token.
', 'refs' => [ 'TokenBalanceList$member' => NULL, ], ], 'TokenBalanceList' => [ 'base' => NULL, 'refs' => [ 'ListTokenBalancesOutput$tokenBalances' => 'An array of TokenBalance objects. Each object contains details about the token balance.
The container of the token filter like the contract address on a given blockchain network or a unique token identifier on a given blockchain network.
You must always specify the network property of this container when using this operation.
The contract address or a token identifier on the blockchain network by which to filter the request. You must specify the contractAddress property of this container when listing tokens minted by a contract.
You must always specify the network property of this container when using this operation.
The container for the identifier for the token including the unique token ID and its blockchain network.
Only the native tokens BTC,ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.
The container for the identifier for the token, including the unique token ID and its blockchain network.
', 'GetTokenBalanceOutput$tokenIdentifier' => NULL, 'TokenBalance$tokenIdentifier' => 'The identifier for the token, including the unique token ID and its blockchain network.
', ], ], 'Transaction' => [ 'base' => 'There are two possible types of transactions used for this data type:
A Bitcoin transaction is a movement of BTC from one address to another.
An Ethereum transaction refers to an action initiated by an externally owned account, which is an account managed by a human, not a contract. For example, if Bob sends Alice 1 ETH, Bob\'s account must be debited and Alice\'s must be credited. This state-changing action occurs within a transaction.
Contains the details of the transaction.
', ], ], 'TransactionEvent' => [ 'base' => 'The container for the properties of a transaction event.
', 'refs' => [ 'TransactionEventList$member' => NULL, ], ], 'TransactionEventList' => [ 'base' => NULL, 'refs' => [ 'ListTransactionEventsOutput$events' => 'An array of TransactionEvent objects. Each object contains details about the transaction events.
The container of the transaction output.
', 'refs' => [ 'TransactionOutputList$member' => NULL, ], ], 'TransactionOutputList' => [ 'base' => NULL, 'refs' => [ 'ListTransactionsOutput$transactions' => 'The array of transactions returned by the request.
', ], ], 'ValidationException' => [ 'base' => 'The resource passed is invalid.
', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => 'The resource passed is invalid.
', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => NULL, 'refs' => [ 'ValidationException$fieldList' => 'The container for the fieldList of the exception.
The container for the reason for the exception
', ], ], ],];