@aws-sdk/client-managedblockchain-query 3.535.0 → 3.537.0

package/dist-types/models/models_0.d.ts

@@ -12,6 +12,17 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * <p>This is the container for the unique public address on the blockchain.</p>
+ * @public
+ */
+export interface AddressIdentifierFilter {
+    /**
+     * <p>The container for the recipient address of the transaction. </p>
+     * @public
+     */
+    transactionEventToAddress: string[] | undefined;
+}
 /**
  * @public
  * @enum
@@ -105,7 +116,7 @@ export interface BlockchainInstant {
     time?: Date;
 }
 /**
- * <p>The container for the identifier of the owner.</p>
+ * <p>The container for the owner identifier.</p>
  * @public
  */
 export interface OwnerIdentifier {
@@ -160,7 +171,7 @@ export interface BatchGetTokenBalanceInputItem {
      */
     tokenIdentifier: TokenIdentifier | undefined;
     /**
-     * <p>The container for the identifier of the owner.</p>
+     * <p>The container for the owner identifier.</p>
      * @public
      */
     ownerIdentifier: OwnerIdentifier | undefined;
@@ -213,7 +224,7 @@ export interface BatchGetTokenBalanceErrorItem {
      */
     tokenIdentifier?: TokenIdentifier;
     /**
-     * <p>The container for the identifier of the owner.</p>
+     * <p>The container for the owner identifier.</p>
      * @public
      */
     ownerIdentifier?: OwnerIdentifier;
@@ -244,7 +255,7 @@ export interface BatchGetTokenBalanceErrorItem {
  */
 export interface BatchGetTokenBalanceOutputItem {
     /**
-     * <p>The container for the identifier of the owner.</p>
+     * <p>The container for the owner identifier.</p>
      * @public
      */
     ownerIdentifier?: OwnerIdentifier;
@@ -297,7 +308,7 @@ export declare class InternalServerException extends __BaseException {
     readonly $fault: "server";
     $retryable: {};
     /**
-     * <p>The container of the <code>retryAfterSeconds</code> value.</p>
+     * <p>Specifies the <code>retryAfterSeconds</code> value.</p>
      * @public
      */
     retryAfterSeconds?: number;
@@ -603,7 +614,7 @@ export interface GetTokenBalanceInput {
  */
 export interface GetTokenBalanceOutput {
     /**
-     * <p>The container for the identifier of the owner.</p>
+     * <p>The container for the owner identifier.</p>
      * @public
      */
     ownerIdentifier?: OwnerIdentifier;
@@ -637,7 +648,7 @@ export interface GetTokenBalanceOutput {
  */
 export interface GetTransactionInput {
     /**
-     * <p>The hash of the transaction.  It is generated whenever a transaction is verified and added to the blockchain.</p>
+     * <p>The hash of a transaction. It is generated when a transaction is created.</p>
      * @public
      */
     transactionHash: string | undefined;
@@ -677,7 +688,7 @@ export interface Transaction {
      */
     blockHash?: string;
     /**
-     * <p>The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.</p>
+     * <p>The hash of a transaction. It is generated when a transaction is created.</p>
      * @public
      */
     transactionHash: string | undefined;
@@ -753,7 +764,7 @@ export interface Transaction {
      */
     transactionFee?: string;
     /**
-     * <p>The unique identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.</p>
+     * <p>The identifier of a Bitcoin transaction. It is generated when a transaction is created.</p>
      * @public
      */
     transactionId?: string;
@@ -794,7 +805,7 @@ export interface ListAssetContractsInput {
     nextToken?: string;
     /**
      * <p>The maximum number of contracts to list.</p>
-     *          <p>Default:<code>100</code>
+     *          <p>Default: <code>100</code>
      *          </p>
      *          <note>
      *             <p>Even if additional results can be retrieved, the request can return less
@@ -823,150 +834,124 @@ export interface ListAssetContractsOutput {
     nextToken?: string;
 }
 /**
- * <p>The container for the owner information to filter by.</p>
  * @public
+ * @enum
  */
-export interface OwnerFilter {
+export declare const ListFilteredTransactionEventsSortBy: {
     /**
-     * <p>The contract or wallet address.</p>
-     * @public
+     * Timestamp of a transaction
      */
-    address: string | undefined;
-}
+    readonly blockchainInstant: "blockchainInstant";
+};
 /**
- * <p>The container of the token filter like the contract address
- *        on a given blockchain network or a unique token identifier on a given
- *        blockchain network.</p>
- *          <note>
- *             <p>You must always specify the network property of this
- *                            container when using this operation.</p>
- *          </note>
  * @public
  */
-export interface TokenFilter {
-    /**
-     * <p>The blockchain network of the token.</p>
-     * @public
-     */
-    network: QueryNetwork | undefined;
-    /**
-     * <p>This is the address of the contract.</p>
-     * @public
-     */
-    contractAddress?: string;
-    /**
-     * <p>The unique identifier of the token.</p>
-     * @public
-     */
-    tokenId?: string;
-}
+export type ListFilteredTransactionEventsSortBy = (typeof ListFilteredTransactionEventsSortBy)[keyof typeof ListFilteredTransactionEventsSortBy];
 /**
  * @public
+ * @enum
  */
-export interface ListTokenBalancesInput {
+export declare const SortOrder: {
     /**
-     * <p>The contract or wallet address on the blockchain network by which to filter the
-     *          request. You must specify the <code>address</code> property of the <code>ownerFilter</code>
-     *          when listing balances of tokens owned by the address.</p>
-     * @public
+     * Result sorted in ascending order
      */
-    ownerFilter?: OwnerFilter;
+    readonly ASCENDING: "ASCENDING";
     /**
-     * <p>The contract address or a token identifier on the
-     *         blockchain network by which to filter the request. You must specify the <code>contractAddress</code>
-     *         property of this container when listing tokens minted by a contract.</p>
-     *          <note>
-     *             <p>You must always specify the network property of this
-     *                            container when using this operation.</p>
-     *          </note>
-     * @public
+     * Result sorted in descending order
      */
-    tokenFilter: TokenFilter | undefined;
+    readonly DESCENDING: "DESCENDING";
+};
+/**
+ * @public
+ */
+export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
+/**
+ * <p>Lists all the transaction events for an address on the blockchain.</p>
+ *          <note>
+ *             <p>This operation is only supported on the Bitcoin blockchain networks.</p>
+ *          </note>
+ * @public
+ */
+export interface ListFilteredTransactionEventsSort {
     /**
-     * <p>The pagination token that indicates the next set of results to retrieve.</p>
+     * <p>Container on how the results will be sorted by?</p>
      * @public
      */
-    nextToken?: string;
+    sortBy?: ListFilteredTransactionEventsSortBy;
     /**
-     * <p>The maximum number of token balances to return.</p>
-     *          <p>Default:<code>100</code>
-     *          </p>
-     *          <note>
-     *             <p>Even if additional results can be retrieved, the request can return less
-     *        results than <code>maxResults</code> or an empty array of results.</p>
-     *             <p>To retrieve the next set of results, make another request with the
-     *          returned <code>nextToken</code> value. The value of <code>nextToken</code> is
-     *          <code>null</code> when there are no more results to return</p>
-     *          </note>
+     * <p>The container for the <i>sort order</i> for <code>ListFilteredTransactionEvents</code>.
+     *          The <code>SortOrder</code> field only accepts the values <code>ASCENDING</code>
+     *          and <code>DESCENDING</code>. Not providing <code>SortOrder</code> will default
+     *          to <code>ASCENDING</code>.</p>
      * @public
      */
-    maxResults?: number;
+    sortOrder?: SortOrder;
 }
 /**
- * <p>The balance of the token.</p>
+ * <p>This container is used to specify a time frame.</p>
  * @public
  */
-export interface TokenBalance {
+export interface TimeFilter {
     /**
-     * <p>The container for the identifier of the owner.</p>
+     * <p>The container for time.</p>
      * @public
      */
-    ownerIdentifier?: OwnerIdentifier;
+    from?: BlockchainInstant;
     /**
-     * <p>The identifier for the token, including the unique token ID and its blockchain network.</p>
+     * <p>The container for time.</p>
      * @public
      */
-    tokenIdentifier?: TokenIdentifier;
+    to?: BlockchainInstant;
+}
+/**
+ * <p>This container specifies filtering attributes related to <code>BITCOIN_VOUT</code> event types</p>
+ * @public
+ */
+export interface VoutFilter {
     /**
-     * <p>The container of the token balance.</p>
+     * <p>Specifies if the transaction output is spent or unspent.</p>
      * @public
      */
-    balance: string | undefined;
+    voutSpent: boolean | undefined;
+}
+/**
+ * @public
+ */
+export interface ListFilteredTransactionEventsInput {
     /**
-     * <p>The time for when the TokenBalance is requested or
-     *          the current time if a time is not provided in the request.</p>
-     *          <note>
-     *             <p>This time will only be recorded up to the second.</p>
-     *          </note>
+     * <p>The blockchain network where the transaction occurred.</p>
+     *          <p>Valid Values: <code>BITCOIN_MAINNET</code> | <code>BITCOIN_TESTNET</code>
+     *          </p>
      * @public
      */
-    atBlockchainInstant: BlockchainInstant | undefined;
+    network: string | undefined;
     /**
-     * <p>The <code>Timestamp</code> of the last transaction at which the balance for the token in the wallet was updated.</p>
+     * <p>This is the unique public address on the blockchain for which the transaction events are being requested.</p>
      * @public
      */
-    lastUpdatedTime?: BlockchainInstant;
-}
-/**
- * @public
- */
-export interface ListTokenBalancesOutput {
+    addressIdentifierFilter: AddressIdentifierFilter | undefined;
     /**
-     * <p>An array of <code>TokenBalance</code> objects. Each object contains details about
-     *        the token balance.</p>
+     * <p>This container specifies the time frame for the transaction events returned in the response.</p>
      * @public
      */
-    tokenBalances: TokenBalance[] | undefined;
+    timeFilter?: TimeFilter;
     /**
-     * <p>The pagination token that indicates the next set of results to retrieve.</p>
+     * <p>This container specifies filtering attributes related to BITCOIN_VOUT event types</p>
      * @public
      */
-    nextToken?: string;
-}
-/**
- * @public
- */
-export interface ListTransactionEventsInput {
+    voutFilter?: VoutFilter;
     /**
-     * <p>The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.</p>
+     * <p>The container for the <code>ConfirmationStatusFilter</code> that filters for the <a href="https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality">
+     *                <i>finality</i>
+     *             </a> of the results.</p>
      * @public
      */
-    transactionHash: string | undefined;
+    confirmationStatusFilter?: ConfirmationStatusFilter;
     /**
-     * <p>The blockchain network where the transaction events occurred.</p>
+     * <p>The order by which the results will be sorted.</p>
      * @public
      */
-    network: QueryNetwork | undefined;
+    sort?: ListFilteredTransactionEventsSort;
     /**
      * <p>The pagination token that indicates the next set of results to retrieve.</p>
      * @public
@@ -974,7 +959,7 @@ export interface ListTransactionEventsInput {
     nextToken?: string;
     /**
      * <p>The maximum number of transaction events to list.</p>
-     *          <p>Default:<code>100</code>
+     *          <p>Default: <code>100</code>
      *          </p>
      *          <note>
      *             <p>Even if additional results can be retrieved, the request can return less
@@ -1052,7 +1037,7 @@ export interface TransactionEvent {
      */
     network: QueryNetwork | undefined;
     /**
-     * <p>The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.</p>
+     * <p>The hash of a transaction. It is generated when a transaction is created.</p>
      * @public
      */
     transactionHash: string | undefined;
@@ -1077,7 +1062,7 @@ export interface TransactionEvent {
      */
     value?: string;
     /**
-     * <p>The blockchain address. for the contract</p>
+     * <p>The blockchain address for the contract</p>
      * @public
      */
     contractAddress?: string;
@@ -1087,23 +1072,64 @@ export interface TransactionEvent {
      */
     tokenId?: string;
     /**
-     * <p>The unique identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.</p>
+     * <p>The identifier of a Bitcoin transaction. It is generated when a transaction is created.</p>
      * @public
      */
     transactionId?: string;
     /**
-     * <p>The position of the vout in the transaction output list.</p>
+     * <p>The position of the transaction output in the transaction output list.</p>
      * @public
      */
     voutIndex?: number;
+    /**
+     * <p>Specifies if the transaction output is spent or unspent. This is only returned for BITCOIN_VOUT event types.</p>
+     *          <note>
+     *             <p>This is only returned for <code>BITCOIN_VOUT</code> event types.</p>
+     *          </note>
+     * @public
+     */
+    voutSpent?: boolean;
+    /**
+     * <p>The transactionId that <i>created</i> the spent transaction output.</p>
+     *          <note>
+     *             <p>This is only returned for <code>BITCOIN_VIN</code> event types.</p>
+     *          </note>
+     * @public
+     */
+    spentVoutTransactionId?: string;
+    /**
+     * <p>The transactionHash that <i>created</i> the spent transaction output.</p>
+     *          <note>
+     *             <p>This is only returned for <code>BITCOIN_VIN</code> event types.</p>
+     *          </note>
+     * @public
+     */
+    spentVoutTransactionHash?: string;
+    /**
+     * <p>The position of the spent transaction output in the output list of the <i>creating transaction</i>.</p>
+     *          <note>
+     *             <p>This is only returned for <code>BITCOIN_VIN</code> event types.</p>
+     *          </note>
+     * @public
+     */
+    spentVoutIndex?: number;
+    /**
+     * <p>The container for time.</p>
+     * @public
+     */
+    blockchainInstant?: BlockchainInstant;
+    /**
+     * <p>This container specifies whether the transaction has reached Finality.</p>
+     * @public
+     */
+    confirmationStatus?: ConfirmationStatus;
 }
 /**
  * @public
  */
-export interface ListTransactionEventsOutput {
+export interface ListFilteredTransactionEventsOutput {
     /**
-     * <p>An array of <code>TransactionEvent</code> objects. Each object contains details
-     *          about the transaction events.</p>
+     * <p>The transaction events returned by the request.</p>
      * @public
      */
     events: TransactionEvent[] | undefined;
@@ -1114,37 +1140,209 @@ export interface ListTransactionEventsOutput {
     nextToken?: string;
 }
 /**
+ * <p>The container for the owner information to filter by.</p>
  * @public
- * @enum
  */
-export declare const ListTransactionsSortBy: {
+export interface OwnerFilter {
     /**
-     * Timestamp of a transaction
+     * <p>The contract or wallet address.</p>
+     * @public
      */
-    readonly TRANSACTION_TIMESTAMP: "TRANSACTION_TIMESTAMP";
-};
+    address: string | undefined;
+}
 /**
+ * <p>The container of the token filter like the contract address
+ *        on a given blockchain network or a unique token identifier on a given
+ *        blockchain network.</p>
+ *          <note>
+ *             <p>You must always specify the network property of this
+ *                            container when using this operation.</p>
+ *          </note>
  * @public
  */
-export type ListTransactionsSortBy = (typeof ListTransactionsSortBy)[keyof typeof ListTransactionsSortBy];
+export interface TokenFilter {
+    /**
+     * <p>The blockchain network of the token.</p>
+     * @public
+     */
+    network: QueryNetwork | undefined;
+    /**
+     * <p>This is the address of the contract.</p>
+     * @public
+     */
+    contractAddress?: string;
+    /**
+     * <p>The unique identifier of the token.</p>
+     * @public
+     */
+    tokenId?: string;
+}
 /**
  * @public
- * @enum
  */
-export declare const SortOrder: {
+export interface ListTokenBalancesInput {
     /**
-     * Result sorted in ascending order
+     * <p>The contract or wallet address on the blockchain network by which to filter the
+     *          request. You must specify the <code>address</code> property of the <code>ownerFilter</code>
+     *          when listing balances of tokens owned by the address.</p>
+     * @public
      */
-    readonly ASCENDING: "ASCENDING";
+    ownerFilter?: OwnerFilter;
     /**
-     * Result sorted in descending order
+     * <p>The contract address or a token identifier on the
+     *         blockchain network by which to filter the request. You must specify the <code>contractAddress</code>
+     *         property of this container when listing tokens minted by a contract.</p>
+     *          <note>
+     *             <p>You must always specify the network property of this
+     *                            container when using this operation.</p>
+     *          </note>
+     * @public
      */
-    readonly DESCENDING: "DESCENDING";
+    tokenFilter: TokenFilter | undefined;
+    /**
+     * <p>The pagination token that indicates the next set of results to retrieve.</p>
+     * @public
+     */
+    nextToken?: string;
+    /**
+     * <p>The maximum number of token balances to return.</p>
+     *          <p>Default: <code>100</code>
+     *          </p>
+     *          <note>
+     *             <p>Even if additional results can be retrieved, the request can return less
+     *        results than <code>maxResults</code> or an empty array of results.</p>
+     *             <p>To retrieve the next set of results, make another request with the
+     *          returned <code>nextToken</code> value. The value of <code>nextToken</code> is
+     *          <code>null</code> when there are no more results to return</p>
+     *          </note>
+     * @public
+     */
+    maxResults?: number;
+}
+/**
+ * <p>The balance of the token.</p>
+ * @public
+ */
+export interface TokenBalance {
+    /**
+     * <p>The container for the identifier of the owner.</p>
+     * @public
+     */
+    ownerIdentifier?: OwnerIdentifier;
+    /**
+     * <p>The identifier for the token, including the unique token ID and its blockchain network.</p>
+     * @public
+     */
+    tokenIdentifier?: TokenIdentifier;
+    /**
+     * <p>The container of the token balance.</p>
+     * @public
+     */
+    balance: string | undefined;
+    /**
+     * <p>The time for when the TokenBalance is requested or
+     *          the current time if a time is not provided in the request.</p>
+     *          <note>
+     *             <p>This time will only be recorded up to the second.</p>
+     *          </note>
+     * @public
+     */
+    atBlockchainInstant: BlockchainInstant | undefined;
+    /**
+     * <p>The <code>Timestamp</code> of the last transaction at which the balance for the token in the wallet was updated.</p>
+     * @public
+     */
+    lastUpdatedTime?: BlockchainInstant;
+}
+/**
+ * @public
+ */
+export interface ListTokenBalancesOutput {
+    /**
+     * <p>An array of <code>TokenBalance</code> objects. Each object contains details about
+     *        the token balance.</p>
+     * @public
+     */
+    tokenBalances: TokenBalance[] | undefined;
+    /**
+     * <p>The pagination token that indicates the next set of results to retrieve.</p>
+     * @public
+     */
+    nextToken?: string;
+}
+/**
+ * @public
+ */
+export interface ListTransactionEventsInput {
+    /**
+     * <p>The hash of a transaction. It is generated when a transaction is created.</p>
+     * @public
+     */
+    transactionHash?: string;
+    /**
+     * <p>The identifier of a Bitcoin transaction. It is generated when a transaction is created.</p>
+     *          <note>
+     *             <p>
+     *                <code>transactionId</code> is only supported on the Bitcoin networks.</p>
+     *          </note>
+     * @public
+     */
+    transactionId?: string;
+    /**
+     * <p>The blockchain network where the transaction events occurred.</p>
+     * @public
+     */
+    network: QueryNetwork | undefined;
+    /**
+     * <p>The pagination token that indicates the next set of results to retrieve.</p>
+     * @public
+     */
+    nextToken?: string;
+    /**
+     * <p>The maximum number of transaction events to list.</p>
+     *          <p>Default: <code>100</code>
+     *          </p>
+     *          <note>
+     *             <p>Even if additional results can be retrieved, the request can return less
+     *        results than <code>maxResults</code> or an empty array of results.</p>
+     *             <p>To retrieve the next set of results, make another request with the
+     *          returned <code>nextToken</code> value. The value of <code>nextToken</code> is
+     *          <code>null</code> when there are no more results to return</p>
+     *          </note>
+     * @public
+     */
+    maxResults?: number;
+}
+/**
+ * @public
+ */
+export interface ListTransactionEventsOutput {
+    /**
+     * <p>An array of <code>TransactionEvent</code> objects. Each object contains details
+     *          about the transaction events.</p>
+     * @public
+     */
+    events: TransactionEvent[] | undefined;
+    /**
+     * <p>The pagination token that indicates the next set of results to retrieve.</p>
+     * @public
+     */
+    nextToken?: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ListTransactionsSortBy: {
+    /**
+     * Timestamp of a transaction
+     */
+    readonly TRANSACTION_TIMESTAMP: "TRANSACTION_TIMESTAMP";
 };
 /**
  * @public
  */
-export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
+export type ListTransactionsSortBy = (typeof ListTransactionsSortBy)[keyof typeof ListTransactionsSortBy];
 /**
  * <p>The container for determining how the list transaction result will
  *              be sorted.</p>
@@ -1190,8 +1388,7 @@ export interface ListTransactionsInput {
      */
     toBlockchainInstant?: BlockchainInstant;
     /**
-     * <p>The order by which the results will be sorted. If <code>ASCENNDING</code> is selected, the results
-     *          will be ordered by <code>fromTime</code>. </p>
+     * <p>The order by which the results will be sorted. </p>
      * @public
      */
     sort?: ListTransactionsSort;
@@ -1202,7 +1399,7 @@ export interface ListTransactionsInput {
     nextToken?: string;
     /**
      * <p>The maximum number of transactions to list.</p>
-     *          <p>Default:<code>100</code>
+     *          <p>Default: <code>100</code>
      *          </p>
      *          <note>
      *             <p>Even if additional results can be retrieved, the request can return less
@@ -1217,7 +1414,7 @@ export interface ListTransactionsInput {
     /**
      * <p>This filter is used to include transactions in the response that haven't reached <a href="https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality">
      *                <i>finality</i>
-     *             </a>. Transactions that have reached finiality are always
+     *             </a>. Transactions that have reached finality are always
      *          part of the response.</p>
      * @public
      */
@@ -1229,7 +1426,7 @@ export interface ListTransactionsInput {
  */
 export interface TransactionOutputItem {
     /**
-     * <p>The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.</p>
+     * <p>The hash of a transaction. It is generated when a transaction is created.</p>
      * @public
      */
     transactionHash: string | undefined;