com.amazonaws.services.managedblockchainquery

Interface AmazonManagedBlockchainQuery

All Known Subinterfaces:

AmazonManagedBlockchainQueryAsync

All Known Implementing Classes:

AbstractAmazonManagedBlockchainQuery, AbstractAmazonManagedBlockchainQueryAsync, AmazonManagedBlockchainQueryAsyncClient, AmazonManagedBlockchainQueryClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonManagedBlockchainQuery

Interface for accessing Amazon Managed Blockchain Query.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonManagedBlockchainQuery instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
BatchGetTokenBalanceResult	batchGetTokenBalance(BatchGetTokenBalanceRequest batchGetTokenBalanceRequest) Gets the token balance for a batch of tokens by using the BatchGetTokenBalance action for every token in the request.
GetAssetContractResult	getAssetContract(GetAssetContractRequest getAssetContractRequest) Gets the information about a specific contract deployed on the blockchain.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetTokenBalanceResult	getTokenBalance(GetTokenBalanceRequest getTokenBalanceRequest) Gets the balance of a specific token, including native tokens, for a given address (wallet or contract) on the blockchain.
GetTransactionResult	getTransaction(GetTransactionRequest getTransactionRequest) Gets the details of a transaction.
ListAssetContractsResult	listAssetContracts(ListAssetContractsRequest listAssetContractsRequest) Lists all the contracts for a given contract type deployed by an address (either a contract address or a wallet address).
ListFilteredTransactionEventsResult	listFilteredTransactionEvents(ListFilteredTransactionEventsRequest listFilteredTransactionEventsRequest) Lists all the transaction events for an address on the blockchain.
ListTokenBalancesResult	listTokenBalances(ListTokenBalancesRequest listTokenBalancesRequest) This action returns the following for a given blockchain network:
ListTransactionEventsResult	listTransactionEvents(ListTransactionEventsRequest listTransactionEventsRequest) Lists all the transaction events for a transaction
ListTransactionsResult	listTransactions(ListTransactionsRequest listTransactionsRequest) Lists all the transaction events for a transaction.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

batchGetTokenBalance

BatchGetTokenBalanceResult batchGetTokenBalance(BatchGetTokenBalanceRequest batchGetTokenBalanceRequest)

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.

Parameters:

batchGetTokenBalanceRequest -

Returns:

Result of the BatchGetTokenBalance operation returned by the service.

Throws:

ThrottlingException - 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.

ValidationException - The resource passed is invalid.

ResourceNotFoundException - The resource was not found.

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

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

ServiceQuotaExceededException - The service quota has been exceeded for this resource.

See Also:

AWS API Documentation

getAssetContract

GetAssetContractResult getAssetContract(GetAssetContractRequest getAssetContractRequest)

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

• The Bitcoin blockchain networks do not support this operation.

• Metadata is currently only available for some ERC-20 contracts. Metadata will be available for additional contracts in the future.

Parameters:

getAssetContractRequest -

Returns:

Result of the GetAssetContract operation returned by the service.

Throws:

ThrottlingException - 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.

ValidationException - The resource passed is invalid.

ResourceNotFoundException - The resource was not found.

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

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

ServiceQuotaExceededException - The service quota has been exceeded for this resource.

See Also:

AWS API Documentation

getTokenBalance

GetTokenBalanceResult getTokenBalance(GetTokenBalanceRequest getTokenBalanceRequest)

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.

Parameters:

getTokenBalanceRequest -

Returns:

Result of the GetTokenBalance operation returned by the service.

Throws:

ThrottlingException - 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.

ValidationException - The resource passed is invalid.

ResourceNotFoundException - The resource was not found.

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

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

ServiceQuotaExceededException - The service quota has been exceeded for this resource.

See Also:

AWS API Documentation

getTransaction

GetTransactionResult getTransaction(GetTransactionRequest getTransactionRequest)

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.

Parameters:

getTransactionRequest -

Returns:

Result of the GetTransaction operation returned by the service.

Throws:

ThrottlingException - 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.

ValidationException - The resource passed is invalid.

ResourceNotFoundException - The resource was not found.

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

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

ServiceQuotaExceededException - The service quota has been exceeded for this resource.

See Also:

AWS API Documentation

listAssetContracts

ListAssetContractsResult listAssetContracts(ListAssetContractsRequest listAssetContractsRequest)

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.

Parameters:

listAssetContractsRequest -

Returns:

Result of the ListAssetContracts operation returned by the service.

Throws:

ThrottlingException - 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.

ValidationException - The resource passed is invalid.

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

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

ServiceQuotaExceededException - The service quota has been exceeded for this resource.

See Also:

AWS API Documentation

listFilteredTransactionEvents

ListFilteredTransactionEventsResult listFilteredTransactionEvents(ListFilteredTransactionEventsRequest listFilteredTransactionEventsRequest)

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

This operation is only supported on the Bitcoin networks.

Parameters:

listFilteredTransactionEventsRequest -

Returns:

Result of the ListFilteredTransactionEvents operation returned by the service.

Throws:

ThrottlingException - 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.

ValidationException - The resource passed is invalid.

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

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

ServiceQuotaExceededException - The service quota has been exceeded for this resource.

See Also:

AWS API Documentation

listTokenBalances

ListTokenBalancesResult listTokenBalances(ListTokenBalancesRequest listTokenBalancesRequest)

This action returns the following for a given blockchain network:

• Lists all token balances owned by an address (either a contract 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.

Parameters:

listTokenBalancesRequest -

Returns:

Result of the ListTokenBalances operation returned by the service.

Throws:

ThrottlingException - 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.

ValidationException - The resource passed is invalid.

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

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

ServiceQuotaExceededException - The service quota has been exceeded for this resource.

See Also:

AWS API Documentation

listTransactionEvents

ListTransactionEventsResult listTransactionEvents(ListTransactionEventsRequest listTransactionEventsRequest)

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.

Parameters:

listTransactionEventsRequest -

Returns:

Result of the ListTransactionEvents operation returned by the service.

Throws:

ThrottlingException - 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.

ValidationException - The resource passed is invalid.

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

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

ServiceQuotaExceededException - The service quota has been exceeded for this resource.

See Also:

AWS API Documentation

listTransactions

ListTransactionsResult listTransactions(ListTransactionsRequest listTransactionsRequest)

Lists all the transaction events for a transaction.

Parameters:

listTransactionsRequest -

Returns:

Result of the ListTransactions operation returned by the service.

Throws:

ThrottlingException - 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.

ValidationException - The resource passed is invalid.

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

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

ServiceQuotaExceededException - The service quota has been exceeded for this resource.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.