{ "version":"2.0", "metadata":{ "apiVersion":"2023-05-04", "endpointPrefix":"managedblockchain-query", "jsonVersion":"1.1", "protocol":"rest-json", "ripServiceName":"chainquery", "serviceFullName":"Amazon Managed Blockchain Query", "serviceId":"ManagedBlockchain Query", "signatureVersion":"v4", "signingName":"managedblockchain-query", "uid":"managedblockchain-query-2023-05-04" }, "operations":{ "BatchGetTokenBalance":{ "name":"BatchGetTokenBalance", "http":{ "method":"POST", "requestUri":"/batch-get-token-balance", "responseCode":200 }, "input":{"shape":"BatchGetTokenBalanceInput"}, "output":{"shape":"BatchGetTokenBalanceOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Gets the token balance for a batch of tokens by using the BatchGetTokenBalance action for every token in the request.

Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.

" }, "GetAssetContract":{ "name":"GetAssetContract", "http":{ "method":"POST", "requestUri":"/get-asset-contract", "responseCode":200 }, "input":{"shape":"GetAssetContractInput"}, "output":{"shape":"GetAssetContractOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Gets the information about a specific contract deployed on the blockchain.

" }, "GetTokenBalance":{ "name":"GetTokenBalance", "http":{ "method":"POST", "requestUri":"/get-token-balance", "responseCode":200 }, "input":{"shape":"GetTokenBalanceInput"}, "output":{"shape":"GetTokenBalanceOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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 and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.

" }, "GetTransaction":{ "name":"GetTransaction", "http":{ "method":"POST", "requestUri":"/get-transaction", "responseCode":200 }, "input":{"shape":"GetTransactionInput"}, "output":{"shape":"GetTransactionOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Gets the details of a transaction.

This action will return transaction details for all transactions that are confirmed on the blockchain, even if they have not reached finality.

" }, "ListAssetContracts":{ "name":"ListAssetContracts", "http":{ "method":"POST", "requestUri":"/list-asset-contracts", "responseCode":200 }, "input":{"shape":"ListAssetContractsInput"}, "output":{"shape":"ListAssetContractsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Lists all the contracts for a given contract type deployed by an address (either a contract address or a wallet address).

The Bitcoin blockchain networks do not support this operation.

" }, "ListFilteredTransactionEvents":{ "name":"ListFilteredTransactionEvents", "http":{ "method":"POST", "requestUri":"/list-filtered-transaction-events", "responseCode":200 }, "input":{"shape":"ListFilteredTransactionEventsInput"}, "output":{"shape":"ListFilteredTransactionEventsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Lists all the transaction events for an address on the blockchain.

This operation is only supported on the Bitcoin networks.

" }, "ListTokenBalances":{ "name":"ListTokenBalances", "http":{ "method":"POST", "requestUri":"/list-token-balances", "responseCode":200 }, "input":{"shape":"ListTokenBalancesInput"}, "output":{"shape":"ListTokenBalancesOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

This action returns the following for a given blockchain network:

You must always specify the network property of the tokenFilter when using this operation.

" }, "ListTransactionEvents":{ "name":"ListTransactionEvents", "http":{ "method":"POST", "requestUri":"/list-transaction-events", "responseCode":200 }, "input":{"shape":"ListTransactionEventsInput"}, "output":{"shape":"ListTransactionEventsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Lists all the transaction events for a transaction

This action will return transaction details for all transactions that are confirmed on the blockchain, even if they have not reached finality.

" }, "ListTransactions":{ "name":"ListTransactions", "http":{ "method":"POST", "requestUri":"/list-transactions", "responseCode":200 }, "input":{"shape":"ListTransactionsInput"}, "output":{"shape":"ListTransactionsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Lists all the transaction events for a transaction.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The container for the exception message.

" } }, "documentation":"

The Amazon Web Services account doesn’t have access to this resource.

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AddressIdentifierFilter":{ "type":"structure", "required":["transactionEventToAddress"], "members":{ "transactionEventToAddress":{ "shape":"AddressIdentifierFilterTransactionEventToAddressList", "documentation":"

The container for the recipient address of the transaction.

" } }, "documentation":"

This is the container for the unique public address on the blockchain.

" }, "AddressIdentifierFilterTransactionEventToAddressList":{ "type":"list", "member":{"shape":"ChainAddress"}, "max":1, "min":1 }, "AssetContract":{ "type":"structure", "required":[ "contractIdentifier", "tokenStandard", "deployerAddress" ], "members":{ "contractIdentifier":{ "shape":"ContractIdentifier", "documentation":"

The container for the contract identifier containing its blockchain network and address.

" }, "tokenStandard":{ "shape":"QueryTokenStandard", "documentation":"

The token standard of the contract.

" }, "deployerAddress":{ "shape":"ChainAddress", "documentation":"

The address of the contract deployer.

" } }, "documentation":"

This container contains information about an contract.

" }, "AssetContractList":{ "type":"list", "member":{"shape":"AssetContract"}, "max":250, "min":0 }, "BatchGetTokenBalanceErrorItem":{ "type":"structure", "required":[ "errorCode", "errorMessage", "errorType" ], "members":{ "tokenIdentifier":{"shape":"TokenIdentifier"}, "ownerIdentifier":{"shape":"OwnerIdentifier"}, "atBlockchainInstant":{"shape":"BlockchainInstant"}, "errorCode":{ "shape":"String", "documentation":"

The error code associated with the error.

" }, "errorMessage":{ "shape":"String", "documentation":"

The message associated with the error.

" }, "errorType":{ "shape":"ErrorType", "documentation":"

The type of error.

" } }, "documentation":"

Error generated from a failed BatchGetTokenBalance request.

" }, "BatchGetTokenBalanceErrors":{ "type":"list", "member":{"shape":"BatchGetTokenBalanceErrorItem"}, "max":10, "min":0 }, "BatchGetTokenBalanceInput":{ "type":"structure", "members":{ "getTokenBalanceInputs":{ "shape":"GetTokenBalanceInputList", "documentation":"

An array of BatchGetTokenBalanceInputItem objects whose balance is being requested.

" } } }, "BatchGetTokenBalanceInputItem":{ "type":"structure", "required":[ "tokenIdentifier", "ownerIdentifier" ], "members":{ "tokenIdentifier":{"shape":"TokenIdentifier"}, "ownerIdentifier":{"shape":"OwnerIdentifier"}, "atBlockchainInstant":{"shape":"BlockchainInstant"} }, "documentation":"

The container for the input for getting a token balance.

" }, "BatchGetTokenBalanceOutput":{ "type":"structure", "required":[ "tokenBalances", "errors" ], "members":{ "tokenBalances":{ "shape":"BatchGetTokenBalanceOutputList", "documentation":"

An array of BatchGetTokenBalanceOutputItem objects returned by the response.

" }, "errors":{ "shape":"BatchGetTokenBalanceErrors", "documentation":"

An array of BatchGetTokenBalanceErrorItem objects returned from the request.

" } } }, "BatchGetTokenBalanceOutputItem":{ "type":"structure", "required":[ "balance", "atBlockchainInstant" ], "members":{ "ownerIdentifier":{"shape":"OwnerIdentifier"}, "tokenIdentifier":{"shape":"TokenIdentifier"}, "balance":{ "shape":"String", "documentation":"

The container for the token balance.

" }, "atBlockchainInstant":{"shape":"BlockchainInstant"}, "lastUpdatedTime":{"shape":"BlockchainInstant"} }, "documentation":"

The container for the properties of a token balance output.

" }, "BatchGetTokenBalanceOutputList":{ "type":"list", "member":{"shape":"BatchGetTokenBalanceOutputItem"}, "max":10, "min":0 }, "BlockHash":{ "type":"string", "pattern":"(0x[A-Fa-f0-9]{64}|[A-Fa-f0-9]{64})" }, "BlockchainInstant":{ "type":"structure", "members":{ "time":{ "shape":"Timestamp", "documentation":"

The container of the Timestamp of the blockchain instant.

This timestamp will only be recorded up to the second.

" } }, "documentation":"

The container for time.

" }, "Boolean":{ "type":"boolean", "box":true }, "ChainAddress":{ "type":"string", "pattern":"[-A-Za-z0-9]{13,74}" }, "ConfirmationStatus":{ "type":"string", "enum":[ "FINAL", "NONFINAL" ] }, "ConfirmationStatusFilter":{ "type":"structure", "required":["include"], "members":{ "include":{ "shape":"ConfirmationStatusIncludeList", "documentation":"

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

" } }, "documentation":"

The container for the ConfirmationStatusFilter that filters for the finality of the results.

" }, "ConfirmationStatusIncludeList":{ "type":"list", "member":{"shape":"ConfirmationStatus"}, "min":1 }, "ContractFilter":{ "type":"structure", "required":[ "network", "tokenStandard", "deployerAddress" ], "members":{ "network":{ "shape":"QueryNetwork", "documentation":"

The blockchain network of the contract.

" }, "tokenStandard":{ "shape":"QueryTokenStandard", "documentation":"

The container for the token standard.

" }, "deployerAddress":{ "shape":"ChainAddress", "documentation":"

The network address of the deployer.

" } }, "documentation":"

The contract or wallet address by which to filter the request.

" }, "ContractIdentifier":{ "type":"structure", "required":[ "network", "contractAddress" ], "members":{ "network":{ "shape":"QueryNetwork", "documentation":"

The blockchain network of the contract.

" }, "contractAddress":{ "shape":"ChainAddress", "documentation":"

Container for the blockchain address about a contract.

" } }, "documentation":"

Container for the blockchain address and network information about a contract.

" }, "ContractMetadata":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the token contract.

" }, "symbol":{ "shape":"String", "documentation":"

The symbol of the token contract.

" }, "decimals":{ "shape":"Integer", "documentation":"

The decimals used by the token contract.

" } }, "documentation":"

The metadata of the contract.

" }, "ErrorType":{ "type":"string", "enum":[ "VALIDATION_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION" ] }, "ExceptionMessage":{ "type":"string", "min":1 }, "ExecutionStatus":{ "type":"string", "enum":[ "FAILED", "SUCCEEDED" ] }, "GetAssetContractInput":{ "type":"structure", "required":["contractIdentifier"], "members":{ "contractIdentifier":{ "shape":"ContractIdentifier", "documentation":"

Contains the blockchain address and network information about the contract.

" } } }, "GetAssetContractOutput":{ "type":"structure", "required":[ "contractIdentifier", "tokenStandard", "deployerAddress" ], "members":{ "contractIdentifier":{ "shape":"ContractIdentifier", "documentation":"

Contains the blockchain address and network information about the contract.

" }, "tokenStandard":{ "shape":"QueryTokenStandard", "documentation":"

The token standard of the contract requested.

" }, "deployerAddress":{ "shape":"ChainAddress", "documentation":"

The address of the deployer of contract.

" }, "metadata":{"shape":"ContractMetadata"} } }, "GetTokenBalanceInput":{ "type":"structure", "required":[ "tokenIdentifier", "ownerIdentifier" ], "members":{ "tokenIdentifier":{ "shape":"TokenIdentifier", "documentation":"

The container for the identifier for the token, including the unique token ID and its blockchain network.

" }, "ownerIdentifier":{ "shape":"OwnerIdentifier", "documentation":"

The container for the identifier for the owner.

" }, "atBlockchainInstant":{ "shape":"BlockchainInstant", "documentation":"

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.

" } } }, "GetTokenBalanceInputList":{ "type":"list", "member":{"shape":"BatchGetTokenBalanceInputItem"}, "max":10, "min":1 }, "GetTokenBalanceOutput":{ "type":"structure", "required":[ "balance", "atBlockchainInstant" ], "members":{ "ownerIdentifier":{"shape":"OwnerIdentifier"}, "tokenIdentifier":{"shape":"TokenIdentifier"}, "balance":{ "shape":"String", "documentation":"

The container for the token balance.

" }, "atBlockchainInstant":{"shape":"BlockchainInstant"}, "lastUpdatedTime":{"shape":"BlockchainInstant"} } }, "GetTransactionInput":{ "type":"structure", "required":["network"], "members":{ "transactionHash":{ "shape":"QueryTransactionHash", "documentation":"

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

" }, "transactionId":{ "shape":"QueryTransactionId", "documentation":"

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

transactionId is only supported on the Bitcoin networks.

" }, "network":{ "shape":"QueryNetwork", "documentation":"

The blockchain network where the transaction occurred.

" } } }, "GetTransactionOutput":{ "type":"structure", "required":["transaction"], "members":{ "transaction":{ "shape":"Transaction", "documentation":"

Contains the details of the transaction.

" } } }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The container for the exception message.

" }, "retryAfterSeconds":{ "shape":"Integer", "documentation":"

Specifies the retryAfterSeconds value.

", "location":"header", "locationName":"Retry-After" } }, "documentation":"

The request processing has failed because of an internal error in the service.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "ListAssetContractsInput":{ "type":"structure", "required":["contractFilter"], "members":{ "contractFilter":{ "shape":"ContractFilter", "documentation":"

Contains the filter parameter for the request.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" }, "maxResults":{ "shape":"ListAssetContractsInputMaxResultsInteger", "documentation":"

The maximum number of contracts to list.

Default: 100

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

" } } }, "ListAssetContractsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":250, "min":1 }, "ListAssetContractsOutput":{ "type":"structure", "required":["contracts"], "members":{ "contracts":{ "shape":"AssetContractList", "documentation":"

An array of contract objects that contain the properties for each contract.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } } }, "ListFilteredTransactionEventsInput":{ "type":"structure", "required":[ "network", "addressIdentifierFilter" ], "members":{ "network":{ "shape":"String", "documentation":"

The blockchain network where the transaction occurred.

Valid Values: BITCOIN_MAINNET | BITCOIN_TESTNET

" }, "addressIdentifierFilter":{ "shape":"AddressIdentifierFilter", "documentation":"

This is the unique public address on the blockchain for which the transaction events are being requested.

" }, "timeFilter":{ "shape":"TimeFilter", "documentation":"

This container specifies the time frame for the transaction events returned in the response.

" }, "voutFilter":{ "shape":"VoutFilter", "documentation":"

This container specifies filtering attributes related to BITCOIN_VOUT event types

" }, "confirmationStatusFilter":{"shape":"ConfirmationStatusFilter"}, "sort":{ "shape":"ListFilteredTransactionEventsSort", "documentation":"

The order by which the results will be sorted.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" }, "maxResults":{ "shape":"ListFilteredTransactionEventsInputMaxResultsInteger", "documentation":"

The maximum number of transaction events to list.

Default: 100

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

" } } }, "ListFilteredTransactionEventsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":250, "min":1 }, "ListFilteredTransactionEventsOutput":{ "type":"structure", "required":["events"], "members":{ "events":{ "shape":"TransactionEventList", "documentation":"

The transaction events returned by the request.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } } }, "ListFilteredTransactionEventsSort":{ "type":"structure", "members":{ "sortBy":{ "shape":"ListFilteredTransactionEventsSortBy", "documentation":"

Container on how the results will be sorted by?

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

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

" } }, "documentation":"

Lists all the transaction events for an address on the blockchain.

This operation is only supported on the Bitcoin blockchain networks.

" }, "ListFilteredTransactionEventsSortBy":{ "type":"string", "enum":["blockchainInstant"] }, "ListTokenBalancesInput":{ "type":"structure", "required":["tokenFilter"], "members":{ "ownerFilter":{ "shape":"OwnerFilter", "documentation":"

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.

" }, "tokenFilter":{ "shape":"TokenFilter", "documentation":"

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.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" }, "maxResults":{ "shape":"ListTokenBalancesInputMaxResultsInteger", "documentation":"

The maximum number of token balances to return.

Default: 100

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

" } } }, "ListTokenBalancesInputMaxResultsInteger":{ "type":"integer", "box":true, "max":250, "min":1 }, "ListTokenBalancesOutput":{ "type":"structure", "required":["tokenBalances"], "members":{ "tokenBalances":{ "shape":"TokenBalanceList", "documentation":"

An array of TokenBalance objects. Each object contains details about the token balance.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } } }, "ListTransactionEventsInput":{ "type":"structure", "required":["network"], "members":{ "transactionHash":{ "shape":"QueryTransactionHash", "documentation":"

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

" }, "transactionId":{ "shape":"QueryTransactionId", "documentation":"

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

transactionId is only supported on the Bitcoin networks.

" }, "network":{ "shape":"QueryNetwork", "documentation":"

The blockchain network where the transaction events occurred.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" }, "maxResults":{ "shape":"ListTransactionEventsInputMaxResultsInteger", "documentation":"

The maximum number of transaction events to list.

Default: 100

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

" } } }, "ListTransactionEventsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":250, "min":1 }, "ListTransactionEventsOutput":{ "type":"structure", "required":["events"], "members":{ "events":{ "shape":"TransactionEventList", "documentation":"

An array of TransactionEvent objects. Each object contains details about the transaction events.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } } }, "ListTransactionsInput":{ "type":"structure", "required":[ "address", "network" ], "members":{ "address":{ "shape":"ChainAddress", "documentation":"

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

" }, "network":{ "shape":"QueryNetwork", "documentation":"

The blockchain network where the transactions occurred.

" }, "fromBlockchainInstant":{"shape":"BlockchainInstant"}, "toBlockchainInstant":{"shape":"BlockchainInstant"}, "sort":{ "shape":"ListTransactionsSort", "documentation":"

The order by which the results will be sorted.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" }, "maxResults":{ "shape":"ListTransactionsInputMaxResultsInteger", "documentation":"

The maximum number of transactions to list.

Default: 100

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

" }, "confirmationStatusFilter":{ "shape":"ConfirmationStatusFilter", "documentation":"

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.

" } } }, "ListTransactionsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":250, "min":1 }, "ListTransactionsOutput":{ "type":"structure", "required":["transactions"], "members":{ "transactions":{ "shape":"TransactionOutputList", "documentation":"

The array of transactions returned by the request.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } } }, "ListTransactionsSort":{ "type":"structure", "members":{ "sortBy":{ "shape":"ListTransactionsSortBy", "documentation":"

Defaults to the value TRANSACTION_TIMESTAMP.

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

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.

" } }, "documentation":"

The container for determining how the list transaction result will be sorted.

" }, "ListTransactionsSortBy":{ "type":"string", "enum":["TRANSACTION_TIMESTAMP"] }, "Long":{ "type":"long", "box":true }, "NextToken":{ "type":"string", "max":131070, "min":0 }, "OwnerFilter":{ "type":"structure", "required":["address"], "members":{ "address":{ "shape":"ChainAddress", "documentation":"

The contract or wallet address.

" } }, "documentation":"

The container for the owner information to filter by.

" }, "OwnerIdentifier":{ "type":"structure", "required":["address"], "members":{ "address":{ "shape":"ChainAddress", "documentation":"

The contract or wallet address for the owner.

" } }, "documentation":"

The container for the owner identifier.

" }, "QueryNetwork":{ "type":"string", "enum":[ "ETHEREUM_MAINNET", "ETHEREUM_SEPOLIA_TESTNET", "BITCOIN_MAINNET", "BITCOIN_TESTNET" ] }, "QueryTokenId":{ "type":"string", "pattern":"[a-zA-Z0-9]{1,66}" }, "QueryTokenStandard":{ "type":"string", "enum":[ "ERC20", "ERC721", "ERC1155" ] }, "QueryTransactionEventType":{ "type":"string", "enum":[ "ERC20_TRANSFER", "ERC20_MINT", "ERC20_BURN", "ERC20_DEPOSIT", "ERC20_WITHDRAWAL", "ERC721_TRANSFER", "ERC1155_TRANSFER", "BITCOIN_VIN", "BITCOIN_VOUT", "INTERNAL_ETH_TRANSFER", "ETH_TRANSFER" ] }, "QueryTransactionHash":{ "type":"string", "pattern":"(0x[A-Fa-f0-9]{64}|[A-Fa-f0-9]{64})" }, "QueryTransactionId":{ "type":"string", "pattern":"(0x[A-Fa-f0-9]{64}|[A-Fa-f0-9]{64})" }, "QuotaCode":{"type":"string"}, "ResourceId":{"type":"string"}, "ResourceNotFoundException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The container for the exception message.

" }, "resourceId":{ "shape":"ResourceId", "documentation":"

The resourceId of the resource that caused the exception.

" }, "resourceType":{ "shape":"ResourceType", "documentation":"

The resourceType of the resource that caused the exception.

" } }, "documentation":"

The resource was not found.

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResourceType":{ "type":"string", "enum":["collection"] }, "ServiceCode":{"type":"string"}, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType", "serviceCode", "quotaCode" ], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The container for the exception message.

" }, "resourceId":{ "shape":"ResourceId", "documentation":"

The resourceId of the resource that caused the exception.

" }, "resourceType":{ "shape":"ResourceType", "documentation":"

The resourceType of the resource that caused the exception.

" }, "serviceCode":{ "shape":"ServiceCode", "documentation":"

The container for the serviceCode.

" }, "quotaCode":{ "shape":"QuotaCode", "documentation":"

The container for the quotaCode.

" } }, "documentation":"

The service quota has been exceeded for this resource.

", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "SortOrder":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "String":{"type":"string"}, "ThrottlingException":{ "type":"structure", "required":[ "message", "serviceCode", "quotaCode" ], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The container for the exception message.

" }, "serviceCode":{ "shape":"ServiceCode", "documentation":"

The container for the serviceCode.

" }, "quotaCode":{ "shape":"QuotaCode", "documentation":"

The container for the quotaCode.

" }, "retryAfterSeconds":{ "shape":"Integer", "documentation":"

The container of the retryAfterSeconds value.

", "location":"header", "locationName":"Retry-After" } }, "documentation":"

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.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":true} }, "TimeFilter":{ "type":"structure", "members":{ "from":{"shape":"BlockchainInstant"}, "to":{"shape":"BlockchainInstant"} }, "documentation":"

This container is used to specify a time frame.

" }, "Timestamp":{"type":"timestamp"}, "TokenBalance":{ "type":"structure", "required":[ "balance", "atBlockchainInstant" ], "members":{ "ownerIdentifier":{ "shape":"OwnerIdentifier", "documentation":"

The container for the identifier of the owner.

" }, "tokenIdentifier":{ "shape":"TokenIdentifier", "documentation":"

The identifier for the token, including the unique token ID and its blockchain network.

" }, "balance":{ "shape":"String", "documentation":"

The container of the token balance.

" }, "atBlockchainInstant":{ "shape":"BlockchainInstant", "documentation":"

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.

" }, "lastUpdatedTime":{ "shape":"BlockchainInstant", "documentation":"

The Timestamp of the last transaction at which the balance for the token in the wallet was updated.

" } }, "documentation":"

The balance of the token.

" }, "TokenBalanceList":{ "type":"list", "member":{"shape":"TokenBalance"}, "max":250, "min":0 }, "TokenFilter":{ "type":"structure", "required":["network"], "members":{ "network":{ "shape":"QueryNetwork", "documentation":"

The blockchain network of the token.

" }, "contractAddress":{ "shape":"ChainAddress", "documentation":"

This is the address of the contract.

" }, "tokenId":{ "shape":"QueryTokenId", "documentation":"

The unique identifier of the token.

" } }, "documentation":"

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.

" }, "TokenIdentifier":{ "type":"structure", "required":["network"], "members":{ "network":{ "shape":"QueryNetwork", "documentation":"

The blockchain network of the token.

" }, "contractAddress":{ "shape":"ChainAddress", "documentation":"

This is the token's contract address.

" }, "tokenId":{ "shape":"QueryTokenId", "documentation":"

The unique identifier of the token.

For native tokens, use the 3 character abbreviation that best matches your token. For example, btc for Bitcoin, eth for Ether, etc. For all other token types you must specify the tokenId in the 64 character hexadecimal tokenid format.

" } }, "documentation":"

The container for the identifier for the token including the unique token ID and its blockchain network.

Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.

" }, "Transaction":{ "type":"structure", "required":[ "network", "transactionHash", "transactionTimestamp", "transactionIndex", "numberOfTransactions", "to" ], "members":{ "network":{ "shape":"QueryNetwork", "documentation":"

The blockchain network where the transaction occurred.

" }, "blockHash":{ "shape":"BlockHash", "documentation":"

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.

" }, "transactionHash":{ "shape":"QueryTransactionHash", "documentation":"

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

" }, "blockNumber":{ "shape":"String", "documentation":"

The block number in which the transaction is recorded.

" }, "transactionTimestamp":{ "shape":"Timestamp", "documentation":"

The Timestamp of the transaction.

" }, "transactionIndex":{ "shape":"Long", "documentation":"

The index of the transaction within a blockchain.

" }, "numberOfTransactions":{ "shape":"Long", "documentation":"

The number of transactions in the block.

" }, "to":{ "shape":"ChainAddress", "documentation":"

The identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.

" }, "from":{ "shape":"ChainAddress", "documentation":"

The initiator of the transaction. It is either in the form a public key or a contract address.

" }, "contractAddress":{ "shape":"ChainAddress", "documentation":"

The blockchain address for the contract.

" }, "gasUsed":{ "shape":"String", "documentation":"

The amount of gas used for the transaction.

" }, "cumulativeGasUsed":{ "shape":"String", "documentation":"

The amount of gas used up to the specified point in the block.

" }, "effectiveGasPrice":{ "shape":"String", "documentation":"

The effective gas price.

" }, "signatureV":{ "shape":"Integer", "documentation":"

The signature of the transaction. The Z coordinate of a point V.

" }, "signatureR":{ "shape":"String", "documentation":"

The signature of the transaction. The X coordinate of a point R.

" }, "signatureS":{ "shape":"String", "documentation":"

The signature of the transaction. The Y coordinate of a point S.

" }, "transactionFee":{ "shape":"String", "documentation":"

The transaction fee.

" }, "transactionId":{ "shape":"String", "documentation":"

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

" }, "confirmationStatus":{ "shape":"ConfirmationStatus", "documentation":"

Specifies whether the transaction has reached Finality.

" }, "executionStatus":{ "shape":"ExecutionStatus", "documentation":"

Identifies whether the transaction has succeeded or failed.

" } }, "documentation":"

There are two possible types of transactions used for this data type:

" }, "TransactionEvent":{ "type":"structure", "required":[ "network", "transactionHash", "eventType" ], "members":{ "network":{ "shape":"QueryNetwork", "documentation":"

The blockchain network where the transaction occurred.

" }, "transactionHash":{ "shape":"QueryTransactionHash", "documentation":"

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

" }, "eventType":{ "shape":"QueryTransactionEventType", "documentation":"

The type of transaction event.

" }, "from":{ "shape":"ChainAddress", "documentation":"

The wallet address initiating the transaction. It can either be a public key or a contract.

" }, "to":{ "shape":"ChainAddress", "documentation":"

The wallet address receiving the transaction. It can either be a public key or a contract.

" }, "value":{ "shape":"String", "documentation":"

The value that was transacted.

" }, "contractAddress":{ "shape":"ChainAddress", "documentation":"

The blockchain address for the contract

" }, "tokenId":{ "shape":"QueryTokenId", "documentation":"

The unique identifier for the token involved in the transaction.

" }, "transactionId":{ "shape":"String", "documentation":"

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

" }, "voutIndex":{ "shape":"Integer", "documentation":"

The position of the transaction output in the transaction output list.

" }, "voutSpent":{ "shape":"Boolean", "documentation":"

Specifies if the transaction output is spent or unspent. This is only returned for BITCOIN_VOUT event types.

This is only returned for BITCOIN_VOUT event types.

" }, "spentVoutTransactionId":{ "shape":"String", "documentation":"

The transactionId that created the spent transaction output.

This is only returned for BITCOIN_VIN event types.

" }, "spentVoutTransactionHash":{ "shape":"String", "documentation":"

The transactionHash that created the spent transaction output.

This is only returned for BITCOIN_VIN event types.

" }, "spentVoutIndex":{ "shape":"Integer", "documentation":"

The position of the spent transaction output in the output list of the creating transaction.

This is only returned for BITCOIN_VIN event types.

" }, "blockchainInstant":{"shape":"BlockchainInstant"}, "confirmationStatus":{ "shape":"ConfirmationStatus", "documentation":"

This container specifies whether the transaction has reached Finality.

" } }, "documentation":"

The container for the properties of a transaction event.

" }, "TransactionEventList":{ "type":"list", "member":{"shape":"TransactionEvent"}, "max":250, "min":0 }, "TransactionOutputItem":{ "type":"structure", "required":[ "transactionHash", "network", "transactionTimestamp" ], "members":{ "transactionHash":{ "shape":"QueryTransactionHash", "documentation":"

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

" }, "transactionId":{ "shape":"QueryTransactionId", "documentation":"

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

" }, "network":{ "shape":"QueryNetwork", "documentation":"

The blockchain network where the transaction occurred.

" }, "transactionTimestamp":{ "shape":"Timestamp", "documentation":"

The time when the transaction occurred.

" }, "confirmationStatus":{ "shape":"ConfirmationStatus", "documentation":"

Specifies whether to list transactions that have not reached Finality.

" } }, "documentation":"

The container of the transaction output.

" }, "TransactionOutputList":{ "type":"list", "member":{"shape":"TransactionOutputItem"}, "max":250, "min":0 }, "ValidationException":{ "type":"structure", "required":[ "message", "reason" ], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The container for the exception message.

" }, "reason":{ "shape":"ValidationExceptionReason", "documentation":"

The container for the reason for the exception

" }, "fieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"

The container for the fieldList of the exception.

" } }, "documentation":"

The resource passed is invalid.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "name", "message" ], "members":{ "name":{ "shape":"String", "documentation":"

The name of the field that triggered the ValidationException.

" }, "message":{ "shape":"String", "documentation":"

The ValidationException message.

" } }, "documentation":"

The resource passed is invalid.

" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "unknownOperation", "cannotParse", "fieldValidationFailed", "other" ] }, "VoutFilter":{ "type":"structure", "required":["voutSpent"], "members":{ "voutSpent":{ "shape":"Boolean", "documentation":"

Specifies if the transaction output is spent or unspent.

" } }, "documentation":"

This container specifies filtering attributes related to BITCOIN_VOUT event types

" } }, "documentation":"

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.

" }