AWS.Tools.ManagedBlockchainQuery.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ManagedBlockchainQuery</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQAssetContractCmdlet"> <summary> Gets the information about a specific contract deployed on the blockchain. <note><ul><li><para> The Bitcoin blockchain networks do not support this operation. </para></li><li><para> Metadata is currently only available for some <c>ERC-20</c> contracts. Metadata will be available for additional contracts in the future. </para></li></ul></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQAssetContractCmdlet.ContractIdentifier_ContractAddress"> <summary> <para> <para>Container for the blockchain address about a contract.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQAssetContractCmdlet.ContractIdentifier_Network"> <summary> <para> <para>The blockchain network of the contract.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQAssetContractCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedBlockchainQuery.Model.GetAssetContractResponse). Specifying the name of a property of type Amazon.ManagedBlockchainQuery.Model.GetAssetContractResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQAssetContractListCmdlet"> <summary> Lists all the contracts for a given contract type deployed by an address (either a contract address or a wallet address). <para> The Bitcoin blockchain networks do not support this operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQAssetContractListCmdlet.ContractFilter_DeployerAddress"> <summary> <para> <para>The network address of the deployer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQAssetContractListCmdlet.ContractFilter_Network"> <summary> <para> <para>The blockchain network of the contract.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQAssetContractListCmdlet.ContractFilter_TokenStandard"> <summary> <para> <para>The container for the token standard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQAssetContractListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of contracts to list.</para><para>Default: <c>100</c></para><note><para>Even if additional results can be retrieved, the request can return less results than <c>maxResults</c> or an empty array of results.</para><para>To retrieve the next set of results, make another request with the returned <c>nextToken</c> value. The value of <c>nextToken</c> is <c>null</c> when there are no more results to return</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQAssetContractListCmdlet.NextToken"> <summary> <para> <para> The pagination token that indicates the next set of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQAssetContractListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Contracts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedBlockchainQuery.Model.ListAssetContractsResponse). Specifying the name of a property of type Amazon.ManagedBlockchainQuery.Model.ListAssetContractsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQBatchTokenBalanceCmdlet"> <summary> Gets the token balance for a batch of tokens by using the <c>BatchGetTokenBalance</c> action for every token in the request. <note><para> Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQBatchTokenBalanceCmdlet.GetTokenBalanceInput"> <summary> <para> <para>An array of <c>BatchGetTokenBalanceInputItem</c> objects whose balance is being requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQBatchTokenBalanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedBlockchainQuery.Model.BatchGetTokenBalanceResponse). Specifying the name of a property of type Amazon.ManagedBlockchainQuery.Model.BatchGetTokenBalanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQFilteredTransactionEventListCmdlet"> <summary> Lists all the transaction events for an address on the blockchain. <note><para> This operation is only supported on the Bitcoin networks. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQFilteredTransactionEventListCmdlet.ConfirmationStatusFilter_Include"> <summary> <para> <para>The container to determine whether to list results that have only 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 finality are always part of the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQFilteredTransactionEventListCmdlet.Network"> <summary> <para> <para>The blockchain network where the transaction occurred.</para><para>Valid Values: <c>BITCOIN_MAINNET</c> | <c>BITCOIN_TESTNET</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQFilteredTransactionEventListCmdlet.Sort_SortBy"> <summary> <para> <para>Container on how the results will be sorted by?</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQFilteredTransactionEventListCmdlet.Sort_SortOrder"> <summary> <para> <para>The container for the <i>sort order</i> for <c>ListFilteredTransactionEvents</c>. The <c>SortOrder</c> field only accepts the values <c>ASCENDING</c> and <c>DESCENDING</c>. Not providing <c>SortOrder</c> will default to <c>ASCENDING</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQFilteredTransactionEventListCmdlet.From_Time"> <summary> <para> <para>The container of the <c>Timestamp</c> of the blockchain instant.</para><note><para>This <c>timestamp</c> will only be recorded up to the second.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQFilteredTransactionEventListCmdlet.To_Time"> <summary> <para> <para>The container of the <c>Timestamp</c> of the blockchain instant.</para><note><para>This <c>timestamp</c> will only be recorded up to the second.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQFilteredTransactionEventListCmdlet.AddressIdentifierFilter_TransactionEventToAddress"> <summary> <para> <para>The container for the recipient address of the transaction. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQFilteredTransactionEventListCmdlet.VoutFilter_VoutSpent"> <summary> <para> <para>Specifies if the transaction output is spent or unspent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQFilteredTransactionEventListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of transaction events to list.</para><para>Default: <c>100</c></para><note><para>Even if additional results can be retrieved, the request can return less results than <c>maxResults</c> or an empty array of results.</para><para>To retrieve the next set of results, make another request with the returned <c>nextToken</c> value. The value of <c>nextToken</c> is <c>null</c> when there are no more results to return</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQFilteredTransactionEventListCmdlet.NextToken"> <summary> <para> <para>The pagination token that indicates the next set of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQFilteredTransactionEventListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Events'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedBlockchainQuery.Model.ListFilteredTransactionEventsResponse). Specifying the name of a property of type Amazon.ManagedBlockchainQuery.Model.ListFilteredTransactionEventsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceCmdlet"> <summary> Gets the balance of a specific token, including native tokens, for a given address (wallet or contract) on the blockchain. <note><para> Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceCmdlet.OwnerIdentifier_Address"> <summary> <para> <para>The contract or wallet address for the owner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceCmdlet.TokenIdentifier_ContractAddress"> <summary> <para> <para>This is the token's contract address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceCmdlet.TokenIdentifier_Network"> <summary> <para> <para>The blockchain network of the token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceCmdlet.AtBlockchainInstant_Time"> <summary> <para> <para>The container of the <c>Timestamp</c> of the blockchain instant.</para><note><para>This <c>timestamp</c> will only be recorded up to the second.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceCmdlet.TokenIdentifier_TokenId"> <summary> <para> <para>The unique identifier of the token.</para><note><para>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 <c>tokenId</c> in the 64 character hexadecimal <c>tokenid</c> format.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedBlockchainQuery.Model.GetTokenBalanceResponse). Specifying the name of a property of type Amazon.ManagedBlockchainQuery.Model.GetTokenBalanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceListCmdlet"> <summary> This action returns the following for a given blockchain network: <ul><li><para> Lists all token balances owned by an address (either a contract address or a wallet address). </para></li><li><para> Lists all token balances for all tokens created by a contract. </para></li><li><para> Lists all token balances for a given token. </para></li></ul><note><para> You must always specify the network property of the <c>tokenFilter</c> when using this operation. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceListCmdlet.OwnerFilter_Address"> <summary> <para> <para>The contract or wallet address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceListCmdlet.TokenFilter_ContractAddress"> <summary> <para> <para>This is the address of the contract.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceListCmdlet.TokenFilter_Network"> <summary> <para> <para>The blockchain network of the token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceListCmdlet.TokenFilter_TokenId"> <summary> <para> <para>The unique identifier of the token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of token balances to return.</para><para>Default: <c>100</c></para><note><para>Even if additional results can be retrieved, the request can return less results than <c>maxResults</c> or an empty array of results.</para><para>To retrieve the next set of results, make another request with the returned <c>nextToken</c> value. The value of <c>nextToken</c> is <c>null</c> when there are no more results to return</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceListCmdlet.NextToken"> <summary> <para> <para>The pagination token that indicates the next set of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTokenBalanceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TokenBalances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedBlockchainQuery.Model.ListTokenBalancesResponse). Specifying the name of a property of type Amazon.ManagedBlockchainQuery.Model.ListTokenBalancesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionCmdlet"> <summary> Gets the details of a transaction. <note><para> This action will return transaction details for all transactions that are <i>confirmed</i> on the blockchain, even if they have not reached <a href="https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality">finality</a>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionCmdlet.Network"> <summary> <para> <para>The blockchain network where the transaction occurred.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionCmdlet.TransactionHash"> <summary> <para> <para>The hash of a transaction. It is generated when a transaction is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Transaction'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedBlockchainQuery.Model.GetTransactionResponse). Specifying the name of a property of type Amazon.ManagedBlockchainQuery.Model.GetTransactionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionEventListCmdlet"> <summary> Lists all the transaction events for a transaction <note><para> This action will return transaction details for all transactions that are <i>confirmed</i> on the blockchain, even if they have not reached <a href="https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality">finality</a>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionEventListCmdlet.Network"> <summary> <para> <para>The blockchain network where the transaction events occurred.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionEventListCmdlet.TransactionHash"> <summary> <para> <para>The hash of a transaction. It is generated when a transaction is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionEventListCmdlet.TransactionId"> <summary> <para> <para>The identifier of a Bitcoin transaction. It is generated when a transaction is created.</para><note><para><c>transactionId</c> is only supported on the Bitcoin networks.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionEventListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of transaction events to list.</para><para>Default: <c>100</c></para><note><para>Even if additional results can be retrieved, the request can return less results than <c>maxResults</c> or an empty array of results.</para><para>To retrieve the next set of results, make another request with the returned <c>nextToken</c> value. The value of <c>nextToken</c> is <c>null</c> when there are no more results to return</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionEventListCmdlet.NextToken"> <summary> <para> <para>The pagination token that indicates the next set of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionEventListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Events'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedBlockchainQuery.Model.ListTransactionEventsResponse). Specifying the name of a property of type Amazon.ManagedBlockchainQuery.Model.ListTransactionEventsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionListCmdlet"> <summary> Lists all the transaction events for a transaction. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionListCmdlet.Address"> <summary> <para> <para>The address (either a contract or wallet), whose transactions are being requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionListCmdlet.ConfirmationStatusFilter_Include"> <summary> <para> <para>The container to determine whether to list results that have only 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 finality are always part of the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionListCmdlet.Network"> <summary> <para> <para>The blockchain network where the transactions occurred.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionListCmdlet.Sort_SortBy"> <summary> <para> <para>Defaults to the value <c>TRANSACTION_TIMESTAMP</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionListCmdlet.Sort_SortOrder"> <summary> <para> <para>The container for the <i>sort order</i> for <c>ListTransactions</c>. The <c>SortOrder</c> field only accepts the values <c>ASCENDING</c> and <c>DESCENDING</c>. Not providing <c>SortOrder</c> will default to <c>ASCENDING</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionListCmdlet.FromBlockchainInstant_Time"> <summary> <para> <para>The container of the <c>Timestamp</c> of the blockchain instant.</para><note><para>This <c>timestamp</c> will only be recorded up to the second.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionListCmdlet.ToBlockchainInstant_Time"> <summary> <para> <para>The container of the <c>Timestamp</c> of the blockchain instant.</para><note><para>This <c>timestamp</c> will only be recorded up to the second.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of transactions to list.</para><para>Default: <c>100</c></para><note><para>Even if additional results can be retrieved, the request can return less results than <c>maxResults</c> or an empty array of results.</para><para>To retrieve the next set of results, make another request with the returned <c>nextToken</c> value. The value of <c>nextToken</c> is <c>null</c> when there are no more results to return</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionListCmdlet.NextToken"> <summary> <para> <para>The pagination token that indicates the next set of results to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MBCQ.GetMBCQTransactionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Transactions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedBlockchainQuery.Model.ListTransactionsResponse). Specifying the name of a property of type Amazon.ManagedBlockchainQuery.Model.ListTransactionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> </members> </doc> |