Class: Aws::ManagedBlockchainQuery::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-managedblockchainquery/client.rb

Overview

An API client for ManagedBlockchainQuery. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::ManagedBlockchainQuery::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::ManagedBlockchainQuery::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ManagedBlockchainQuery::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 473

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1218
1219
1220
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 1218

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1221
1222
1223
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 1221

def errors_module
  Errors
end

Instance Method Details

#batch_get_token_balance(params = {}) ⇒ Types::BatchGetTokenBalanceOutput

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

<note markdown=“1”> Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.

</note>

Examples:

Request syntax with placeholder values


resp = client.batch_get_token_balance({
  get_token_balance_inputs: [
    {
      token_identifier: { # required
        network: "ETHEREUM_MAINNET", # required, accepts ETHEREUM_MAINNET, ETHEREUM_SEPOLIA_TESTNET, BITCOIN_MAINNET, BITCOIN_TESTNET
        contract_address: "ChainAddress",
        token_id: "QueryTokenId",
      },
      owner_identifier: { # required
        address: "ChainAddress", # required
      },
      at_blockchain_instant: {
        time: Time.now,
      },
    },
  ],
})

Response structure


resp.token_balances #=> Array
resp.token_balances[0].owner_identifier.address #=> String
resp.token_balances[0].token_identifier.network #=> String, one of "ETHEREUM_MAINNET", "ETHEREUM_SEPOLIA_TESTNET", "BITCOIN_MAINNET", "BITCOIN_TESTNET"
resp.token_balances[0].token_identifier.contract_address #=> String
resp.token_balances[0].token_identifier.token_id #=> String
resp.token_balances[0].balance #=> String
resp.token_balances[0].at_blockchain_instant.time #=> Time
resp.token_balances[0].last_updated_time.time #=> Time
resp.errors #=> Array
resp.errors[0].token_identifier.network #=> String, one of "ETHEREUM_MAINNET", "ETHEREUM_SEPOLIA_TESTNET", "BITCOIN_MAINNET", "BITCOIN_TESTNET"
resp.errors[0].token_identifier.contract_address #=> String
resp.errors[0].token_identifier.token_id #=> String
resp.errors[0].owner_identifier.address #=> String
resp.errors[0].at_blockchain_instant.time #=> Time
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String
resp.errors[0].error_type #=> String, one of "VALIDATION_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



540
541
542
543
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 540

def batch_get_token_balance(params = {}, options = {})
  req = build_request(:batch_get_token_balance, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 1191

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::ManagedBlockchainQuery')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-managedblockchainquery'
  context[:gem_version] = '1.37.0'
  Seahorse::Client::Request.new(handlers, context)
end

#get_asset_contract(params = {}) ⇒ Types::GetAssetContractOutput

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

<note markdown=“1”> * 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.

</note>

Examples:

Request syntax with placeholder values


resp = client.get_asset_contract({
  contract_identifier: { # required
    network: "ETHEREUM_MAINNET", # required, accepts ETHEREUM_MAINNET, ETHEREUM_SEPOLIA_TESTNET, BITCOIN_MAINNET, BITCOIN_TESTNET
    contract_address: "ChainAddress", # required
  },
})

Response structure


resp.contract_identifier.network #=> String, one of "ETHEREUM_MAINNET", "ETHEREUM_SEPOLIA_TESTNET", "BITCOIN_MAINNET", "BITCOIN_TESTNET"
resp.contract_identifier.contract_address #=> String
resp.token_standard #=> String, one of "ERC20", "ERC721", "ERC1155"
resp.deployer_address #=> String
resp.metadata.name #=> String
resp.metadata.symbol #=> String
resp.metadata.decimals #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contract_identifier (required, Types::ContractIdentifier) —

    Contains the blockchain address and network information about the contract.

Returns:

See Also:



589
590
591
592
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 589

def get_asset_contract(params = {}, options = {})
  req = build_request(:get_asset_contract, params)
  req.send_request(options)
end

#get_token_balance(params = {}) ⇒ Types::GetTokenBalanceOutput

Gets the balance of a specific token, including native tokens, for a given address (wallet or contract) on the blockchain.

<note markdown=“1”> Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.

</note>

Examples:

Request syntax with placeholder values


resp = client.get_token_balance({
  token_identifier: { # required
    network: "ETHEREUM_MAINNET", # required, accepts ETHEREUM_MAINNET, ETHEREUM_SEPOLIA_TESTNET, BITCOIN_MAINNET, BITCOIN_TESTNET
    contract_address: "ChainAddress",
    token_id: "QueryTokenId",
  },
  owner_identifier: { # required
    address: "ChainAddress", # required
  },
  at_blockchain_instant: {
    time: Time.now,
  },
})

Response structure


resp.owner_identifier.address #=> String
resp.token_identifier.network #=> String, one of "ETHEREUM_MAINNET", "ETHEREUM_SEPOLIA_TESTNET", "BITCOIN_MAINNET", "BITCOIN_TESTNET"
resp.token_identifier.contract_address #=> String
resp.token_identifier.token_id #=> String
resp.balance #=> String
resp.at_blockchain_instant.time #=> Time
resp.last_updated_time.time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :token_identifier (required, Types::TokenIdentifier) —

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

  • :owner_identifier (required, Types::OwnerIdentifier) —

    The container for the identifier for the owner.

  • :at_blockchain_instant (Types::BlockchainInstant) —

    The time for when the TokenBalance is requested or the current time if a time is not provided in the request.

    <note markdown=“1”> This time will only be recorded up to the second.

    </note>

Returns:

See Also:



655
656
657
658
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 655

def get_token_balance(params = {}, options = {})
  req = build_request(:get_token_balance, params)
  req.send_request(options)
end

#get_transaction(params = {}) ⇒ Types::GetTransactionOutput

Gets the details of a transaction.

<note markdown=“1”> This action will return transaction details for all transactions that are confirmed on the blockchain, even if they have not reached [finality].

</note>

[1]: docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality

Examples:

Request syntax with placeholder values


resp = client.get_transaction({
  transaction_hash: "QueryTransactionHash",
  transaction_id: "QueryTransactionId",
  network: "ETHEREUM_MAINNET", # required, accepts ETHEREUM_MAINNET, ETHEREUM_SEPOLIA_TESTNET, BITCOIN_MAINNET, BITCOIN_TESTNET
})

Response structure


resp.transaction.network #=> String, one of "ETHEREUM_MAINNET", "ETHEREUM_SEPOLIA_TESTNET", "BITCOIN_MAINNET", "BITCOIN_TESTNET"
resp.transaction.block_hash #=> String
resp.transaction.transaction_hash #=> String
resp.transaction.block_number #=> String
resp.transaction.transaction_timestamp #=> Time
resp.transaction.transaction_index #=> Integer
resp.transaction.number_of_transactions #=> Integer
resp.transaction.to #=> String
resp.transaction.from #=> String
resp.transaction.contract_address #=> String
resp.transaction.gas_used #=> String
resp.transaction.cumulative_gas_used #=> String
resp.transaction.effective_gas_price #=> String
resp.transaction.signature_v #=> Integer
resp.transaction.signature_r #=> String
resp.transaction.signature_s #=> String
resp.transaction.transaction_fee #=> String
resp.transaction.transaction_id #=> String
resp.transaction.confirmation_status #=> String, one of "FINAL", "NONFINAL"
resp.transaction.execution_status #=> String, one of "FAILED", "SUCCEEDED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transaction_hash (String) —

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

  • :transaction_id (String) —

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

    <note markdown=“1”> ‘transactionId` is only supported on the Bitcoin networks.

    </note>
  • :network (required, String) —

    The blockchain network where the transaction occurred.

Returns:

See Also:



726
727
728
729
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 726

def get_transaction(params = {}, options = {})
  req = build_request(:get_transaction, params)
  req.send_request(options)
end

#list_asset_contracts(params = {}) ⇒ Types::ListAssetContractsOutput

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_asset_contracts({
  contract_filter: { # required
    network: "ETHEREUM_MAINNET", # required, accepts ETHEREUM_MAINNET, ETHEREUM_SEPOLIA_TESTNET, BITCOIN_MAINNET, BITCOIN_TESTNET
    token_standard: "ERC20", # required, accepts ERC20, ERC721, ERC1155
    deployer_address: "ChainAddress", # required
  },
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.contracts #=> Array
resp.contracts[0].contract_identifier.network #=> String, one of "ETHEREUM_MAINNET", "ETHEREUM_SEPOLIA_TESTNET", "BITCOIN_MAINNET", "BITCOIN_TESTNET"
resp.contracts[0].contract_identifier.contract_address #=> String
resp.contracts[0].token_standard #=> String, one of "ERC20", "ERC721", "ERC1155"
resp.contracts[0].deployer_address #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contract_filter (required, Types::ContractFilter) —

    Contains the filter parameter for the request.

  • :next_token (String) —

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

  • :max_results (Integer) —

    The maximum number of contracts to list.

    Default: ‘100`

    <note markdown=“1”> 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

    </note>

Returns:

See Also:



789
790
791
792
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 789

def list_asset_contracts(params = {}, options = {})
  req = build_request(:list_asset_contracts, params)
  req.send_request(options)
end

#list_filtered_transaction_events(params = {}) ⇒ Types::ListFilteredTransactionEventsOutput

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

<note markdown=“1”> This operation is only supported on the Bitcoin networks.

</note>

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_filtered_transaction_events({
  network: "String", # required
  address_identifier_filter: { # required
    transaction_event_to_address: ["ChainAddress"], # required
  },
  time_filter: {
    from: {
      time: Time.now,
    },
    to: {
      time: Time.now,
    },
  },
  vout_filter: {
    vout_spent: false, # required
  },
  confirmation_status_filter: {
    include: ["FINAL"], # required, accepts FINAL, NONFINAL
  },
  sort: {
    sort_by: "blockchainInstant", # accepts blockchainInstant
    sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.events #=> Array
resp.events[0].network #=> String, one of "ETHEREUM_MAINNET", "ETHEREUM_SEPOLIA_TESTNET", "BITCOIN_MAINNET", "BITCOIN_TESTNET"
resp.events[0].transaction_hash #=> String
resp.events[0].event_type #=> String, one of "ERC20_TRANSFER", "ERC20_MINT", "ERC20_BURN", "ERC20_DEPOSIT", "ERC20_WITHDRAWAL", "ERC721_TRANSFER", "ERC1155_TRANSFER", "BITCOIN_VIN", "BITCOIN_VOUT", "INTERNAL_ETH_TRANSFER", "ETH_TRANSFER"
resp.events[0].from #=> String
resp.events[0].to #=> String
resp.events[0].value #=> String
resp.events[0].contract_address #=> String
resp.events[0].token_id #=> String
resp.events[0].transaction_id #=> String
resp.events[0].vout_index #=> Integer
resp.events[0].vout_spent #=> Boolean
resp.events[0].spent_vout_transaction_id #=> String
resp.events[0].spent_vout_transaction_hash #=> String
resp.events[0].spent_vout_index #=> Integer
resp.events[0].blockchain_instant.time #=> Time
resp.events[0].confirmation_status #=> String, one of "FINAL", "NONFINAL"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network (required, String) —

    The blockchain network where the transaction occurred.

    Valid Values: ‘BITCOIN_MAINNET` | `BITCOIN_TESTNET`

  • :address_identifier_filter (required, Types::AddressIdentifierFilter) —

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

  • :time_filter (Types::TimeFilter) —

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

  • :vout_filter (Types::VoutFilter) —

    This container specifies filtering attributes related to BITCOIN_VOUT event types

  • :confirmation_status_filter (Types::ConfirmationStatusFilter) —

    The container for the ‘ConfirmationStatusFilter` that filters for the

    finality ][1

    of the results.

    [1]: docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality

  • :sort (Types::ListFilteredTransactionEventsSort) —

    The order by which the results will be sorted.

  • :next_token (String) —

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

  • :max_results (Integer) —

    The maximum number of transaction events to list.

    Default: ‘100`

    <note markdown=“1”> 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

    </note>

Returns:

See Also:



907
908
909
910
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 907

def list_filtered_transaction_events(params = {}, options = {})
  req = build_request(:list_filtered_transaction_events, params)
  req.send_request(options)
end

#list_token_balances(params = {}) ⇒ Types::ListTokenBalancesOutput

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.

<note markdown=“1”> You must always specify the network property of the ‘tokenFilter` when using this operation.

</note>

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_token_balances({
  owner_filter: {
    address: "ChainAddress", # required
  },
  token_filter: { # required
    network: "ETHEREUM_MAINNET", # required, accepts ETHEREUM_MAINNET, ETHEREUM_SEPOLIA_TESTNET, BITCOIN_MAINNET, BITCOIN_TESTNET
    contract_address: "ChainAddress",
    token_id: "QueryTokenId",
  },
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.token_balances #=> Array
resp.token_balances[0].owner_identifier.address #=> String
resp.token_balances[0].token_identifier.network #=> String, one of "ETHEREUM_MAINNET", "ETHEREUM_SEPOLIA_TESTNET", "BITCOIN_MAINNET", "BITCOIN_TESTNET"
resp.token_balances[0].token_identifier.contract_address #=> String
resp.token_balances[0].token_identifier.token_id #=> String
resp.token_balances[0].balance #=> String
resp.token_balances[0].at_blockchain_instant.time #=> Time
resp.token_balances[0].last_updated_time.time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :owner_filter (Types::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.

  • :token_filter (required, Types::TokenFilter) —

    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.

    <note markdown=“1”> You must always specify the network property of this container when using this operation.

    </note>
  • :next_token (String) —

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

  • :max_results (Integer) —

    The maximum number of token balances to return.

    Default: ‘100`

    <note markdown=“1”> 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

    </note>

Returns:

See Also:



997
998
999
1000
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 997

def list_token_balances(params = {}, options = {})
  req = build_request(:list_token_balances, params)
  req.send_request(options)
end

#list_transaction_events(params = {}) ⇒ Types::ListTransactionEventsOutput

Lists all the transaction events for a transaction

<note markdown=“1”> This action will return transaction details for all transactions that are confirmed on the blockchain, even if they have not reached [finality].

</note>

[1]: docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_transaction_events({
  transaction_hash: "QueryTransactionHash",
  transaction_id: "QueryTransactionId",
  network: "ETHEREUM_MAINNET", # required, accepts ETHEREUM_MAINNET, ETHEREUM_SEPOLIA_TESTNET, BITCOIN_MAINNET, BITCOIN_TESTNET
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.events #=> Array
resp.events[0].network #=> String, one of "ETHEREUM_MAINNET", "ETHEREUM_SEPOLIA_TESTNET", "BITCOIN_MAINNET", "BITCOIN_TESTNET"
resp.events[0].transaction_hash #=> String
resp.events[0].event_type #=> String, one of "ERC20_TRANSFER", "ERC20_MINT", "ERC20_BURN", "ERC20_DEPOSIT", "ERC20_WITHDRAWAL", "ERC721_TRANSFER", "ERC1155_TRANSFER", "BITCOIN_VIN", "BITCOIN_VOUT", "INTERNAL_ETH_TRANSFER", "ETH_TRANSFER"
resp.events[0].from #=> String
resp.events[0].to #=> String
resp.events[0].value #=> String
resp.events[0].contract_address #=> String
resp.events[0].token_id #=> String
resp.events[0].transaction_id #=> String
resp.events[0].vout_index #=> Integer
resp.events[0].vout_spent #=> Boolean
resp.events[0].spent_vout_transaction_id #=> String
resp.events[0].spent_vout_transaction_hash #=> String
resp.events[0].spent_vout_index #=> Integer
resp.events[0].blockchain_instant.time #=> Time
resp.events[0].confirmation_status #=> String, one of "FINAL", "NONFINAL"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :transaction_hash (String) —

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

  • :transaction_id (String) —

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

    <note markdown=“1”> ‘transactionId` is only supported on the Bitcoin networks.

    </note>
  • :network (required, String) —

    The blockchain network where the transaction events occurred.

  • :next_token (String) —

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

  • :max_results (Integer) —

    The maximum number of transaction events to list.

    Default: ‘100`

    <note markdown=“1”> 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

    </note>

Returns:

See Also:



1089
1090
1091
1092
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 1089

def list_transaction_events(params = {}, options = {})
  req = build_request(:list_transaction_events, params)
  req.send_request(options)
end

#list_transactions(params = {}) ⇒ Types::ListTransactionsOutput

Lists all the transaction events for a transaction.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_transactions({
  address: "ChainAddress", # required
  network: "ETHEREUM_MAINNET", # required, accepts ETHEREUM_MAINNET, ETHEREUM_SEPOLIA_TESTNET, BITCOIN_MAINNET, BITCOIN_TESTNET
  from_blockchain_instant: {
    time: Time.now,
  },
  to_blockchain_instant: {
    time: Time.now,
  },
  sort: {
    sort_by: "TRANSACTION_TIMESTAMP", # accepts TRANSACTION_TIMESTAMP
    sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
  next_token: "NextToken",
  max_results: 1,
  confirmation_status_filter: {
    include: ["FINAL"], # required, accepts FINAL, NONFINAL
  },
})

Response structure


resp.transactions #=> Array
resp.transactions[0].transaction_hash #=> String
resp.transactions[0].transaction_id #=> String
resp.transactions[0].network #=> String, one of "ETHEREUM_MAINNET", "ETHEREUM_SEPOLIA_TESTNET", "BITCOIN_MAINNET", "BITCOIN_TESTNET"
resp.transactions[0].transaction_timestamp #=> Time
resp.transactions[0].confirmation_status #=> String, one of "FINAL", "NONFINAL"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :address (required, String) —

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

  • :network (required, String) —

    The blockchain network where the transactions occurred.

  • :from_blockchain_instant (Types::BlockchainInstant) —

    The container for time.

  • :to_blockchain_instant (Types::BlockchainInstant) —

    The container for time.

  • :sort (Types::ListTransactionsSort) —

    The order by which the results will be sorted.

  • :next_token (String) —

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

  • :max_results (Integer) —

    The maximum number of transactions to list.

    Default: ‘100`

    <note markdown=“1”> 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

    </note>
  • :confirmation_status_filter (Types::ConfirmationStatusFilter) —

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

    [1]: docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality

Returns:

See Also:



1182
1183
1184
1185
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 1182

def list_transactions(params = {}, options = {})
  req = build_request(:list_transactions, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1211
1212
1213
 
# File 'lib/aws-sdk-managedblockchainquery/client.rb', line 1211

def waiter_names
  []
end