Struct Client 

pub struct Client { /* private fields */ }

Client for Amazon Managed Blockchain Query

Client for invoking operations on Amazon Managed Blockchain Query. Each operation on Amazon Managed Blockchain Query is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_managedblockchainquery::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_managedblockchainquery::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the GetTransaction operation has a Client::get_transaction, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.get_transaction()
    .transaction_hash("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn batch_get_token_balance(&self) -> BatchGetTokenBalanceFluentBuilder

Constructs a fluent builder for the BatchGetTokenBalance operation.

• The fluent builder is configurable:
  • get_token_balance_inputs(BatchGetTokenBalanceInputItem) / set_get_token_balance_inputs(Option<Vec::<BatchGetTokenBalanceInputItem>>):
    required: false
    

    An array of BatchGetTokenBalanceInputItem objects whose balance is being requested.

    
    
• On success, responds with BatchGetTokenBalanceOutput with field(s):
  • token_balances(Vec::<BatchGetTokenBalanceOutputItem>):

    An array of BatchGetTokenBalanceOutputItem objects returned by the response.

  • errors(Vec::<BatchGetTokenBalanceErrorItem>):

    An array of BatchGetTokenBalanceErrorItem objects returned from the request.

• On failure, responds with SdkError<BatchGetTokenBalanceError>

impl Client

pub fn get_asset_contract(&self) -> GetAssetContractFluentBuilder

Constructs a fluent builder for the GetAssetContract operation.

• The fluent builder is configurable:
  • contract_identifier(ContractIdentifier) / set_contract_identifier(Option<ContractIdentifier>):
    required: true
    

    Contains the blockchain address and network information about the contract.

    
    
• On success, responds with GetAssetContractOutput with field(s):
  • contract_identifier(Option<ContractIdentifier>):

    Contains the blockchain address and network information about the contract.

  • token_standard(QueryTokenStandard):

    The token standard of the contract requested.

  • deployer_address(String):

    The address of the deployer of contract.

  • metadata(Option<ContractMetadata>):

    The metadata of the contract.

• On failure, responds with SdkError<GetAssetContractError>

impl Client

pub fn get_token_balance(&self) -> GetTokenBalanceFluentBuilder

Constructs a fluent builder for the GetTokenBalance operation.

• The fluent builder is configurable:
  • token_identifier(TokenIdentifier) / set_token_identifier(Option<TokenIdentifier>):
    required: true
    

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

    
    
  • owner_identifier(OwnerIdentifier) / set_owner_identifier(Option<OwnerIdentifier>):
    required: true
    

    The container for the identifier for the owner.

    
    
  • at_blockchain_instant(BlockchainInstant) / set_at_blockchain_instant(Option<BlockchainInstant>):
    required: false
    

    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.

    
    
• On success, responds with GetTokenBalanceOutput with field(s):
  • owner_identifier(Option<OwnerIdentifier>):

    The container for the owner identifier.

  • token_identifier(Option<TokenIdentifier>):

    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.

  • balance(String):

    The container for the token balance.

  • at_blockchain_instant(Option<BlockchainInstant>):

    The container for time.

  • last_updated_time(Option<BlockchainInstant>):

    The container for time.

• On failure, responds with SdkError<GetTokenBalanceError>

impl Client

pub fn get_transaction(&self) -> GetTransactionFluentBuilder

Constructs a fluent builder for the GetTransaction operation.

• The fluent builder is configurable:
  • transaction_hash(impl Into<String>) / set_transaction_hash(Option<String>):
    required: false
    

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

    
    
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: false
    

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

    transactionId is only supported on the Bitcoin networks.

    
    
  • network(QueryNetwork) / set_network(Option<QueryNetwork>):
    required: true
    

    The blockchain network where the transaction occurred.

    
    
• On success, responds with GetTransactionOutput with field(s):
  • transaction(Option<Transaction>):

    Contains the details of the transaction.

• On failure, responds with SdkError<GetTransactionError>

impl Client

pub fn list_asset_contracts(&self) -> ListAssetContractsFluentBuilder

Constructs a fluent builder for the ListAssetContracts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • contract_filter(ContractFilter) / set_contract_filter(Option<ContractFilter>):
    required: true
    

    Contains the filter parameter for the request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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

    
    
• On success, responds with ListAssetContractsOutput with field(s):
  • contracts(Vec::<AssetContract>):

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

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListAssetContractsError>

impl Client

pub fn list_filtered_transaction_events( &self, ) -> ListFilteredTransactionEventsFluentBuilder

Constructs a fluent builder for the ListFilteredTransactionEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • network(impl Into<String>) / set_network(Option<String>):
    required: true
    

    The blockchain network where the transaction occurred.

    Valid Values: BITCOIN_MAINNET | BITCOIN_TESTNET

    
    
  • address_identifier_filter(AddressIdentifierFilter) / set_address_identifier_filter(Option<AddressIdentifierFilter>):
    required: true
    

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

    
    
  • time_filter(TimeFilter) / set_time_filter(Option<TimeFilter>):
    required: false
    

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

    
    
  • vout_filter(VoutFilter) / set_vout_filter(Option<VoutFilter>):
    required: false
    

    This container specifies filtering attributes related to BITCOIN_VOUT event types

    
    
  • confirmation_status_filter(ConfirmationStatusFilter) / set_confirmation_status_filter(Option<ConfirmationStatusFilter>):
    required: false
    

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

    
    
  • sort(ListFilteredTransactionEventsSort) / set_sort(Option<ListFilteredTransactionEventsSort>):
    required: false
    

    The order by which the results will be sorted.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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

    
    
• On success, responds with ListFilteredTransactionEventsOutput with field(s):
  • events(Vec::<TransactionEvent>):

    The transaction events returned by the request.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListFilteredTransactionEventsError>

impl Client

pub fn list_token_balances(&self) -> ListTokenBalancesFluentBuilder

Constructs a fluent builder for the ListTokenBalances operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • owner_filter(OwnerFilter) / set_owner_filter(Option<OwnerFilter>):
    required: false
    

    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.

    
    
  • token_filter(TokenFilter) / set_token_filter(Option<TokenFilter>):
    required: true
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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

    
    
• On success, responds with ListTokenBalancesOutput with field(s):
  • token_balances(Vec::<TokenBalance>):

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

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListTokenBalancesError>

impl Client

pub fn list_transaction_events(&self) -> ListTransactionEventsFluentBuilder

Constructs a fluent builder for the ListTransactionEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • transaction_hash(impl Into<String>) / set_transaction_hash(Option<String>):
    required: false
    

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

    
    
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: false
    

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

    transactionId is only supported on the Bitcoin networks.

    
    
  • network(QueryNetwork) / set_network(Option<QueryNetwork>):
    required: true
    

    The blockchain network where the transaction events occurred.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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

    
    
• On success, responds with ListTransactionEventsOutput with field(s):
  • events(Vec::<TransactionEvent>):

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

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListTransactionEventsError>

impl Client

pub fn list_transactions(&self) -> ListTransactionsFluentBuilder

Constructs a fluent builder for the ListTransactions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • address(impl Into<String>) / set_address(Option<String>):
    required: true
    

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

    
    
  • network(QueryNetwork) / set_network(Option<QueryNetwork>):
    required: true
    

    The blockchain network where the transactions occurred.

    
    
  • from_blockchain_instant(BlockchainInstant) / set_from_blockchain_instant(Option<BlockchainInstant>):
    required: false
    

    The container for time.

    
    
  • to_blockchain_instant(BlockchainInstant) / set_to_blockchain_instant(Option<BlockchainInstant>):
    required: false
    

    The container for time.

    
    
  • sort(ListTransactionsSort) / set_sort(Option<ListTransactionsSort>):
    required: false
    

    The order by which the results will be sorted.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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

    
    
  • confirmation_status_filter(ConfirmationStatusFilter) / set_confirmation_status_filter(Option<ConfirmationStatusFilter>):
    required: false
    

    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.

    
    
• On success, responds with ListTransactionsOutput with field(s):
  • transactions(Vec::<TransactionOutputItem>):

    The array of transactions returned by the request.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListTransactionsError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.