|
| 1 | +// smithy-typescript generated code |
| 2 | +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; |
| 3 | +import { getSerdePlugin } from "@smithy/middleware-serde"; |
| 4 | +import { Command as $Command } from "@smithy/smithy-client"; |
| 5 | +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; |
| 6 | + |
| 7 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 8 | +import { |
| 9 | + ManagedBlockchainQueryClientResolvedConfig, |
| 10 | + ServiceInputTypes, |
| 11 | + ServiceOutputTypes, |
| 12 | +} from "../ManagedBlockchainQueryClient"; |
| 13 | +import { ListFilteredTransactionEventsInput, ListFilteredTransactionEventsOutput } from "../models/models_0"; |
| 14 | +import { |
| 15 | + de_ListFilteredTransactionEventsCommand, |
| 16 | + se_ListFilteredTransactionEventsCommand, |
| 17 | +} from "../protocols/Aws_restJson1"; |
| 18 | + |
| 19 | +/** |
| 20 | + * @public |
| 21 | + */ |
| 22 | +export { __MetadataBearer, $Command }; |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The input for {@link ListFilteredTransactionEventsCommand}. |
| 27 | + */ |
| 28 | +export interface ListFilteredTransactionEventsCommandInput extends ListFilteredTransactionEventsInput {} |
| 29 | +/** |
| 30 | + * @public |
| 31 | + * |
| 32 | + * The output of {@link ListFilteredTransactionEventsCommand}. |
| 33 | + */ |
| 34 | +export interface ListFilteredTransactionEventsCommandOutput |
| 35 | + extends ListFilteredTransactionEventsOutput, |
| 36 | + __MetadataBearer {} |
| 37 | + |
| 38 | +/** |
| 39 | + * <p>Lists all the transaction events for an address on the blockchain.</p> |
| 40 | + * <note> |
| 41 | + * <p>This operation is only supported on the Bitcoin networks.</p> |
| 42 | + * </note> |
| 43 | + * @example |
| 44 | + * Use a bare-bones client and the command you need to make an API call. |
| 45 | + * ```javascript |
| 46 | + * import { ManagedBlockchainQueryClient, ListFilteredTransactionEventsCommand } from "@aws-sdk/client-managedblockchain-query"; // ES Modules import |
| 47 | + * // const { ManagedBlockchainQueryClient, ListFilteredTransactionEventsCommand } = require("@aws-sdk/client-managedblockchain-query"); // CommonJS import |
| 48 | + * const client = new ManagedBlockchainQueryClient(config); |
| 49 | + * const input = { // ListFilteredTransactionEventsInput |
| 50 | + * network: "STRING_VALUE", // required |
| 51 | + * addressIdentifierFilter: { // AddressIdentifierFilter |
| 52 | + * transactionEventToAddress: [ // ChainAddresses // required |
| 53 | + * "STRING_VALUE", |
| 54 | + * ], |
| 55 | + * }, |
| 56 | + * timeFilter: { // TimeFilter |
| 57 | + * from: { // BlockchainInstant |
| 58 | + * time: new Date("TIMESTAMP"), |
| 59 | + * }, |
| 60 | + * to: { |
| 61 | + * time: new Date("TIMESTAMP"), |
| 62 | + * }, |
| 63 | + * }, |
| 64 | + * voutFilter: { // VoutFilter |
| 65 | + * voutSpent: true || false, // required |
| 66 | + * }, |
| 67 | + * confirmationStatusFilter: { // ConfirmationStatusFilter |
| 68 | + * include: [ // ConfirmationStatusIncludeList // required |
| 69 | + * "STRING_VALUE", |
| 70 | + * ], |
| 71 | + * }, |
| 72 | + * sort: { // ListFilteredTransactionEventsSort |
| 73 | + * sortBy: "STRING_VALUE", |
| 74 | + * sortOrder: "STRING_VALUE", |
| 75 | + * }, |
| 76 | + * nextToken: "STRING_VALUE", |
| 77 | + * maxResults: Number("int"), |
| 78 | + * }; |
| 79 | + * const command = new ListFilteredTransactionEventsCommand(input); |
| 80 | + * const response = await client.send(command); |
| 81 | + * // { // ListFilteredTransactionEventsOutput |
| 82 | + * // events: [ // TransactionEventList // required |
| 83 | + * // { // TransactionEvent |
| 84 | + * // network: "STRING_VALUE", // required |
| 85 | + * // transactionHash: "STRING_VALUE", // required |
| 86 | + * // eventType: "STRING_VALUE", // required |
| 87 | + * // from: "STRING_VALUE", |
| 88 | + * // to: "STRING_VALUE", |
| 89 | + * // value: "STRING_VALUE", |
| 90 | + * // contractAddress: "STRING_VALUE", |
| 91 | + * // tokenId: "STRING_VALUE", |
| 92 | + * // transactionId: "STRING_VALUE", |
| 93 | + * // voutIndex: Number("int"), |
| 94 | + * // voutSpent: true || false, |
| 95 | + * // spentVoutTransactionId: "STRING_VALUE", |
| 96 | + * // spentVoutTransactionHash: "STRING_VALUE", |
| 97 | + * // spentVoutIndex: Number("int"), |
| 98 | + * // blockchainInstant: { // BlockchainInstant |
| 99 | + * // time: new Date("TIMESTAMP"), |
| 100 | + * // }, |
| 101 | + * // confirmationStatus: "STRING_VALUE", |
| 102 | + * // }, |
| 103 | + * // ], |
| 104 | + * // nextToken: "STRING_VALUE", |
| 105 | + * // }; |
| 106 | + * |
| 107 | + * ``` |
| 108 | + * |
| 109 | + * @param ListFilteredTransactionEventsCommandInput - {@link ListFilteredTransactionEventsCommandInput} |
| 110 | + * @returns {@link ListFilteredTransactionEventsCommandOutput} |
| 111 | + * @see {@link ListFilteredTransactionEventsCommandInput} for command's `input` shape. |
| 112 | + * @see {@link ListFilteredTransactionEventsCommandOutput} for command's `response` shape. |
| 113 | + * @see {@link ManagedBlockchainQueryClientResolvedConfig | config} for ManagedBlockchainQueryClient's `config` shape. |
| 114 | + * |
| 115 | + * @throws {@link AccessDeniedException} (client fault) |
| 116 | + * <p>The Amazon Web Services account doesn’t have access to this resource. </p> |
| 117 | + * |
| 118 | + * @throws {@link InternalServerException} (server fault) |
| 119 | + * <p>The request processing has failed because of an internal error in the service.</p> |
| 120 | + * |
| 121 | + * @throws {@link ServiceQuotaExceededException} (client fault) |
| 122 | + * <p>The service quota has been exceeded for this resource.</p> |
| 123 | + * |
| 124 | + * @throws {@link ThrottlingException} (client fault) |
| 125 | + * <p>The request or operation couldn't be performed because a service is throttling |
| 126 | + * requests. The most common source of throttling errors is when you create resources |
| 127 | + * that exceed your service limit for this resource type. Request a limit increase or |
| 128 | + * delete unused resources, if possible.</p> |
| 129 | + * |
| 130 | + * @throws {@link ValidationException} (client fault) |
| 131 | + * <p>The resource passed is invalid.</p> |
| 132 | + * |
| 133 | + * @throws {@link ManagedBlockchainQueryServiceException} |
| 134 | + * <p>Base exception class for all service exceptions from ManagedBlockchainQuery service.</p> |
| 135 | + * |
| 136 | + * @public |
| 137 | + */ |
| 138 | +export class ListFilteredTransactionEventsCommand extends $Command |
| 139 | + .classBuilder< |
| 140 | + ListFilteredTransactionEventsCommandInput, |
| 141 | + ListFilteredTransactionEventsCommandOutput, |
| 142 | + ManagedBlockchainQueryClientResolvedConfig, |
| 143 | + ServiceInputTypes, |
| 144 | + ServiceOutputTypes |
| 145 | + >() |
| 146 | + .ep({ |
| 147 | + ...commonParams, |
| 148 | + }) |
| 149 | + .m(function (this: any, Command: any, cs: any, config: ManagedBlockchainQueryClientResolvedConfig, o: any) { |
| 150 | + return [ |
| 151 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 152 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 153 | + ]; |
| 154 | + }) |
| 155 | + .s("TietonChainQueryService", "ListFilteredTransactionEvents", {}) |
| 156 | + .n("ManagedBlockchainQueryClient", "ListFilteredTransactionEventsCommand") |
| 157 | + .f(void 0, void 0) |
| 158 | + .ser(se_ListFilteredTransactionEventsCommand) |
| 159 | + .de(de_ListFilteredTransactionEventsCommand) |
| 160 | + .build() {} |
0 commit comments