aws-sdk-managedblockchainquery 1.7.0 → 1.9.0

data/lib/aws-sdk-managedblockchainquery/types.rb

@@ -24,6 +24,20 @@ module Aws::ManagedBlockchainQuery
       include Aws::Structure
     end
 
+    # This is the container for the unique public address on the blockchain.
+    #
+    # @!attribute [rw] transaction_event_to_address
+    #   The container for the recipient address of the transaction.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/AddressIdentifierFilter AWS API Documentation
+    #
+    class AddressIdentifierFilter < Struct.new(
+      :transaction_event_to_address)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # This container contains information about an contract.
     #
     # @!attribute [rw] contract_identifier
@@ -55,14 +69,14 @@ module Aws::ManagedBlockchainQuery
     #   The container for the identifier for the token including the unique
     #   token ID and its blockchain network.
     #
-    #   <note markdown="1"> Only the native tokens BTC,ETH, and the ERC-20, ERC-721, and ERC
+    #   <note markdown="1"> Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC
     #   1155 token standards are supported.
     #
     #    </note>
     #   @return [Types::TokenIdentifier]
     #
     # @!attribute [rw] owner_identifier
-    #   The container for the identifier of the owner.
+    #   The container for the owner identifier.
     #   @return [Types::OwnerIdentifier]
     #
     # @!attribute [rw] at_blockchain_instant
@@ -113,14 +127,14 @@ module Aws::ManagedBlockchainQuery
     #   The container for the identifier for the token including the unique
     #   token ID and its blockchain network.
     #
-    #   <note markdown="1"> Only the native tokens BTC,ETH, and the ERC-20, ERC-721, and ERC
+    #   <note markdown="1"> Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC
     #   1155 token standards are supported.
     #
     #    </note>
     #   @return [Types::TokenIdentifier]
     #
     # @!attribute [rw] owner_identifier
-    #   The container for the identifier of the owner.
+    #   The container for the owner identifier.
     #   @return [Types::OwnerIdentifier]
     #
     # @!attribute [rw] at_blockchain_instant
@@ -159,14 +173,14 @@ module Aws::ManagedBlockchainQuery
     # The container for the properties of a token balance output.
     #
     # @!attribute [rw] owner_identifier
-    #   The container for the identifier of the owner.
+    #   The container for the owner identifier.
     #   @return [Types::OwnerIdentifier]
     #
     # @!attribute [rw] token_identifier
     #   The container for the identifier for the token including the unique
     #   token ID and its blockchain network.
     #
-    #   <note markdown="1"> Only the native tokens BTC,ETH, and the ERC-20, ERC-721, and ERC
+    #   <note markdown="1"> Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC
     #   1155 token standards are supported.
     #
     #    </note>
@@ -214,6 +228,31 @@ module Aws::ManagedBlockchainQuery
       include Aws::Structure
     end
 
+    # The container for the `ConfirmationStatusFilter` that filters for the
+    # [ *finality* ][1] of the results.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality
+    #
+    # @!attribute [rw] include
+    #   The container to determine whether to list results that have only
+    #   reached [ *finality* ][1]. Transactions that have reached finality
+    #   are always part of the response.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/ConfirmationStatusFilter AWS API Documentation
+    #
+    class ConfirmationStatusFilter < Struct.new(
+      :include)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The contract or wallet address by which to filter the request.
     #
     # @!attribute [rw] network
@@ -352,14 +391,14 @@ module Aws::ManagedBlockchainQuery
     end
 
     # @!attribute [rw] owner_identifier
-    #   The container for the identifier of the owner.
+    #   The container for the owner identifier.
     #   @return [Types::OwnerIdentifier]
     #
     # @!attribute [rw] token_identifier
     #   The container for the identifier for the token including the unique
     #   token ID and its blockchain network.
     #
-    #   <note markdown="1"> Only the native tokens BTC,ETH, and the ERC-20, ERC-721, and ERC
+    #   <note markdown="1"> Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC
     #   1155 token standards are supported.
     #
     #    </note>
@@ -390,8 +429,8 @@ module Aws::ManagedBlockchainQuery
     end
 
     # @!attribute [rw] transaction_hash
-    #   The hash of the transaction. It is generated whenever a transaction
-    #   is verified and added to the blockchain.
+    #   The hash of a transaction. It is generated when a transaction is
+    #   created.
     #   @return [String]
     #
     # @!attribute [rw] network
@@ -427,7 +466,7 @@ module Aws::ManagedBlockchainQuery
     #   @return [String]
     #
     # @!attribute [rw] retry_after_seconds
-    #   The container of the `retryAfterSeconds` value.
+    #   Specifies the `retryAfterSeconds` value.
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/InternalServerException AWS API Documentation
@@ -450,6 +489,17 @@ module Aws::ManagedBlockchainQuery
     #
     # @!attribute [rw] max_results
     #   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>
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/ListAssetContractsInput AWS API Documentation
@@ -481,6 +531,119 @@ module Aws::ManagedBlockchainQuery
       include Aws::Structure
     end
 
+    # @!attribute [rw] network
+    #   The blockchain network where the transaction occurred.
+    #
+    #   Valid Values: `BITCOIN_MAINNET` \| `BITCOIN_TESTNET`
+    #   @return [String]
+    #
+    # @!attribute [rw] address_identifier_filter
+    #   This is the unique public address on the blockchain for which the
+    #   transaction events are being requested.
+    #   @return [Types::AddressIdentifierFilter]
+    #
+    # @!attribute [rw] time_filter
+    #   This container specifies the time frame for the transaction events
+    #   returned in the response.
+    #   @return [Types::TimeFilter]
+    #
+    # @!attribute [rw] vout_filter
+    #   This container specifies filtering attributes related to
+    #   BITCOIN\_VOUT event types
+    #   @return [Types::VoutFilter]
+    #
+    # @!attribute [rw] confirmation_status_filter
+    #   The container for the `ConfirmationStatusFilter` that filters for
+    #   the [ *finality* ][1] of the results.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality
+    #   @return [Types::ConfirmationStatusFilter]
+    #
+    # @!attribute [rw] sort
+    #   The order by which the results will be sorted.
+    #   @return [Types::ListFilteredTransactionEventsSort]
+    #
+    # @!attribute [rw] next_token
+    #   The pagination token that indicates the next set of results to
+    #   retrieve.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   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>
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/ListFilteredTransactionEventsInput AWS API Documentation
+    #
+    class ListFilteredTransactionEventsInput < Struct.new(
+      :network,
+      :address_identifier_filter,
+      :time_filter,
+      :vout_filter,
+      :confirmation_status_filter,
+      :sort,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] events
+    #   The transaction events returned by the request.
+    #   @return [Array<Types::TransactionEvent>]
+    #
+    # @!attribute [rw] next_token
+    #   The pagination token that indicates the next set of results to
+    #   retrieve.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/ListFilteredTransactionEventsOutput AWS API Documentation
+    #
+    class ListFilteredTransactionEventsOutput < Struct.new(
+      :events,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Lists all the transaction events for an address on the blockchain.
+    #
+    # <note markdown="1"> This operation is only supported on the Bitcoin blockchain networks.
+    #
+    #  </note>
+    #
+    # @!attribute [rw] sort_by
+    #   Container on how the results will be sorted by?
+    #   @return [String]
+    #
+    # @!attribute [rw] sort_order
+    #   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`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/ListFilteredTransactionEventsSort AWS API Documentation
+    #
+    class ListFilteredTransactionEventsSort < Struct.new(
+      :sort_by,
+      :sort_order)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] owner_filter
     #   The contract or wallet address on the blockchain network by which to
     #   filter the request. You must specify the `address` property of the
@@ -506,6 +669,17 @@ module Aws::ManagedBlockchainQuery
     #
     # @!attribute [rw] max_results
     #   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>
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/ListTokenBalancesInput AWS API Documentation
@@ -539,8 +713,17 @@ module Aws::ManagedBlockchainQuery
     end
 
     # @!attribute [rw] transaction_hash
-    #   The hash of the transaction. It is generated whenever a transaction
-    #   is verified and added to the blockchain.
+    #   The hash of a transaction. It is generated when a transaction is
+    #   created.
+    #   @return [String]
+    #
+    # @!attribute [rw] transaction_id
+    #   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>
     #   @return [String]
     #
     # @!attribute [rw] network
@@ -555,6 +738,8 @@ module Aws::ManagedBlockchainQuery
     # @!attribute [rw] max_results
     #   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.
     #
@@ -569,6 +754,7 @@ module Aws::ManagedBlockchainQuery
     #
     class ListTransactionEventsInput < Struct.new(
       :transaction_hash,
+      :transaction_id,
       :network,
       :next_token,
       :max_results)
@@ -613,9 +799,7 @@ module Aws::ManagedBlockchainQuery
     #   @return [Types::BlockchainInstant]
     #
     # @!attribute [rw] sort
-    #   Sorts items in an ascending order if the first page starts at
-    #   `fromTime`. Sorts items in a descending order if the first page
-    #   starts at `toTime`.
+    #   The order by which the results will be sorted.
     #   @return [Types::ListTransactionsSort]
     #
     # @!attribute [rw] next_token
@@ -626,6 +810,8 @@ module Aws::ManagedBlockchainQuery
     # @!attribute [rw] max_results
     #   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.
     #
@@ -636,6 +822,16 @@ module Aws::ManagedBlockchainQuery
     #    </note>
     #   @return [Integer]
     #
+    # @!attribute [rw] confirmation_status_filter
+    #   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]: https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality
+    #   @return [Types::ConfirmationStatusFilter]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/ListTransactionsInput AWS API Documentation
     #
     class ListTransactionsInput < Struct.new(
@@ -645,7 +841,8 @@ module Aws::ManagedBlockchainQuery
       :to_blockchain_instant,
       :sort,
       :next_token,
-      :max_results)
+      :max_results,
+      :confirmation_status_filter)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -704,7 +901,7 @@ module Aws::ManagedBlockchainQuery
       include Aws::Structure
     end
 
-    # The container for the identifier of the owner.
+    # The container for the owner identifier.
     #
     # @!attribute [rw] address
     #   The contract or wallet address for the owner.
@@ -809,6 +1006,25 @@ module Aws::ManagedBlockchainQuery
       include Aws::Structure
     end
 
+    # This container is used to specify a time frame.
+    #
+    # @!attribute [rw] from
+    #   The container for time.
+    #   @return [Types::BlockchainInstant]
+    #
+    # @!attribute [rw] to
+    #   The container for time.
+    #   @return [Types::BlockchainInstant]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/TimeFilter AWS API Documentation
+    #
+    class TimeFilter < Struct.new(
+      :from,
+      :to)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The balance of the token.
     #
     # @!attribute [rw] owner_identifier
@@ -884,8 +1100,8 @@ module Aws::ManagedBlockchainQuery
     # The container for the identifier for the token including the unique
     # token ID and its blockchain network.
     #
-    # <note markdown="1"> Only the native tokens BTC,ETH, and the ERC-20, ERC-721, and ERC 1155
-    # token standards are supported.
+    # <note markdown="1"> Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC
+    # 1155 token standards are supported.
     #
     #  </note>
     #
@@ -900,10 +1116,10 @@ module Aws::ManagedBlockchainQuery
     # @!attribute [rw] token_id
     #   The unique identifier of the token.
     #
-    #   <note markdown="1"> You must specify this container with `btc` for the native BTC token,
-    #   and `eth` for the native ETH token. For all other token types you
-    #   must specify the `tokenId` in the 64 character hexadecimal `tokenid`
-    #   format.
+    #   <note markdown="1"> 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.
     #
     #    </note>
     #   @return [String]
@@ -941,8 +1157,8 @@ module Aws::ManagedBlockchainQuery
     #   @return [String]
     #
     # @!attribute [rw] transaction_hash
-    #   The hash of the transaction. It is generated whenever a transaction
-    #   is verified and added to the blockchain.
+    #   The hash of a transaction. It is generated when a transaction is
+    #   created.
     #   @return [String]
     #
     # @!attribute [rw] block_number
@@ -961,22 +1177,6 @@ module Aws::ManagedBlockchainQuery
     #   The number of transactions in the block.
     #   @return [Integer]
     #
-    # @!attribute [rw] status
-    #   The status of the transaction.
-    #
-    #   This property is deprecated. You must use the `confirmationStatus`
-    #   and the `executionStatus` properties to determine if the `status` of
-    #   the transaction is `FINAL` or `FAILED`.
-    #
-    #    * Transactions with a `status` of `FINAL` will now have the
-    #     `confirmationStatus` set to `FINAL` and the `executionStatus` set
-    #     to `SUCCEEDED`.
-    #
-    #   * Transactions with a `status` of `FAILED` will now have the
-    #     `confirmationStatus` set to `FINAL` and the `executionStatus` set
-    #     to `FAILED`.
-    #   @return [String]
-    #
     # @!attribute [rw] to
     #   The identifier of the transaction. It is generated whenever a
     #   transaction is verified and added to the blockchain.
@@ -1020,8 +1220,8 @@ module Aws::ManagedBlockchainQuery
     #   @return [String]
     #
     # @!attribute [rw] transaction_id
-    #   The unique identifier of the transaction. It is generated whenever a
-    #   transaction is verified and added to the blockchain.
+    #   The identifier of a Bitcoin transaction. It is generated when a
+    #   transaction is created.
     #   @return [String]
     #
     # @!attribute [rw] confirmation_status
@@ -1042,7 +1242,6 @@ module Aws::ManagedBlockchainQuery
       :transaction_timestamp,
       :transaction_index,
       :number_of_transactions,
-      :status,
       :to,
       :from,
       :contract_address,
@@ -1067,8 +1266,8 @@ module Aws::ManagedBlockchainQuery
     #   @return [String]
     #
     # @!attribute [rw] transaction_hash
-    #   The hash of the transaction. It is generated whenever a transaction
-    #   is verified and added to the blockchain.
+    #   The hash of a transaction. It is generated when a transaction is
+    #   created.
     #   @return [String]
     #
     # @!attribute [rw] event_type
@@ -1090,7 +1289,7 @@ module Aws::ManagedBlockchainQuery
     #   @return [String]
     #
     # @!attribute [rw] contract_address
-    #   The blockchain address. for the contract
+    #   The blockchain address for the contract
     #   @return [String]
     #
     # @!attribute [rw] token_id
@@ -1098,14 +1297,58 @@ module Aws::ManagedBlockchainQuery
     #   @return [String]
     #
     # @!attribute [rw] transaction_id
-    #   The unique identifier of the transaction. It is generated whenever a
-    #   transaction is verified and added to the blockchain.
+    #   The identifier of a Bitcoin transaction. It is generated when a
+    #   transaction is created.
     #   @return [String]
     #
     # @!attribute [rw] vout_index
-    #   The position of the vout in the transaction output list.
+    #   The position of the transaction output in the transaction output
+    #   list.
     #   @return [Integer]
     #
+    # @!attribute [rw] vout_spent
+    #   Specifies if the transaction output is spent or unspent. This is
+    #   only returned for BITCOIN\_VOUT event types.
+    #
+    #   <note markdown="1"> This is only returned for `BITCOIN_VOUT` event types.
+    #
+    #    </note>
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] spent_vout_transaction_id
+    #   The transactionId that *created* the spent transaction output.
+    #
+    #   <note markdown="1"> This is only returned for `BITCOIN_VIN` event types.
+    #
+    #    </note>
+    #   @return [String]
+    #
+    # @!attribute [rw] spent_vout_transaction_hash
+    #   The transactionHash that *created* the spent transaction output.
+    #
+    #   <note markdown="1"> This is only returned for `BITCOIN_VIN` event types.
+    #
+    #    </note>
+    #   @return [String]
+    #
+    # @!attribute [rw] spent_vout_index
+    #   The position of the spent transaction output in the output list of
+    #   the *creating transaction*.
+    #
+    #   <note markdown="1"> This is only returned for `BITCOIN_VIN` event types.
+    #
+    #    </note>
+    #   @return [Integer]
+    #
+    # @!attribute [rw] blockchain_instant
+    #   The container for time.
+    #   @return [Types::BlockchainInstant]
+    #
+    # @!attribute [rw] confirmation_status
+    #   This container specifies whether the transaction has reached
+    #   Finality.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/TransactionEvent AWS API Documentation
     #
     class TransactionEvent < Struct.new(
@@ -1118,7 +1361,13 @@ module Aws::ManagedBlockchainQuery
       :contract_address,
       :token_id,
       :transaction_id,
-      :vout_index)
+      :vout_index,
+      :vout_spent,
+      :spent_vout_transaction_id,
+      :spent_vout_transaction_hash,
+      :spent_vout_index,
+      :blockchain_instant,
+      :confirmation_status)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1126,8 +1375,8 @@ module Aws::ManagedBlockchainQuery
     # The container of the transaction output.
     #
     # @!attribute [rw] transaction_hash
-    #   The hash of the transaction. It is generated whenever a transaction
-    #   is verified and added to the blockchain.
+    #   The hash of a transaction. It is generated when a transaction is
+    #   created.
     #   @return [String]
     #
     # @!attribute [rw] network
@@ -1138,12 +1387,18 @@ module Aws::ManagedBlockchainQuery
     #   The time when the transaction occurred.
     #   @return [Time]
     #
+    # @!attribute [rw] confirmation_status
+    #   Specifies whether to list transactions that have not reached
+    #   Finality.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/TransactionOutputItem AWS API Documentation
     #
     class TransactionOutputItem < Struct.new(
       :transaction_hash,
       :network,
-      :transaction_timestamp)
+      :transaction_timestamp,
+      :confirmation_status)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1191,5 +1446,20 @@ module Aws::ManagedBlockchainQuery
       include Aws::Structure
     end
 
+    # This container specifies filtering attributes related to
+    # `BITCOIN_VOUT` event types
+    #
+    # @!attribute [rw] vout_spent
+    #   Specifies if the transaction output is spent or unspent.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/managedblockchain-query-2023-05-04/VoutFilter AWS API Documentation
+    #
+    class VoutFilter < Struct.new(
+      :vout_spent)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
   end
 end

data/lib/aws-sdk-managedblockchainquery.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-managedblockchainquery/customizations'
 # @!group service
 module Aws::ManagedBlockchainQuery
 
-  GEM_VERSION = '1.7.0'
+  GEM_VERSION = '1.9.0'
 
 end