|
| 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 { ListFileTransferResultsRequest, ListFileTransferResultsResponse } from "../models/models_0"; |
| 9 | +import { de_ListFileTransferResultsCommand, se_ListFileTransferResultsCommand } from "../protocols/Aws_json1_1"; |
| 10 | +import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient"; |
| 11 | + |
| 12 | +/** |
| 13 | + * @public |
| 14 | + */ |
| 15 | +export type { __MetadataBearer }; |
| 16 | +export { $Command }; |
| 17 | +/** |
| 18 | + * @public |
| 19 | + * |
| 20 | + * The input for {@link ListFileTransferResultsCommand}. |
| 21 | + */ |
| 22 | +export interface ListFileTransferResultsCommandInput extends ListFileTransferResultsRequest {} |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The output of {@link ListFileTransferResultsCommand}. |
| 27 | + */ |
| 28 | +export interface ListFileTransferResultsCommandOutput extends ListFileTransferResultsResponse, __MetadataBearer {} |
| 29 | + |
| 30 | +/** |
| 31 | + * <p> |
| 32 | + * Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. |
| 33 | + * You specify the file transfer by providing its <code>ConnectorId</code> and its <code>TransferId</code>.</p> |
| 34 | + * <note> |
| 35 | + * <p>File transfer results are available up to 7 days after an operation has been requested.</p> |
| 36 | + * </note> |
| 37 | + * @example |
| 38 | + * Use a bare-bones client and the command you need to make an API call. |
| 39 | + * ```javascript |
| 40 | + * import { TransferClient, ListFileTransferResultsCommand } from "@aws-sdk/client-transfer"; // ES Modules import |
| 41 | + * // const { TransferClient, ListFileTransferResultsCommand } = require("@aws-sdk/client-transfer"); // CommonJS import |
| 42 | + * const client = new TransferClient(config); |
| 43 | + * const input = { // ListFileTransferResultsRequest |
| 44 | + * ConnectorId: "STRING_VALUE", // required |
| 45 | + * TransferId: "STRING_VALUE", // required |
| 46 | + * NextToken: "STRING_VALUE", |
| 47 | + * MaxResults: Number("int"), |
| 48 | + * }; |
| 49 | + * const command = new ListFileTransferResultsCommand(input); |
| 50 | + * const response = await client.send(command); |
| 51 | + * // { // ListFileTransferResultsResponse |
| 52 | + * // FileTransferResults: [ // ConnectorFileTransferResults // required |
| 53 | + * // { // ConnectorFileTransferResult |
| 54 | + * // FilePath: "STRING_VALUE", // required |
| 55 | + * // StatusCode: "QUEUED" || "IN_PROGRESS" || "COMPLETED" || "FAILED", // required |
| 56 | + * // FailureCode: "STRING_VALUE", |
| 57 | + * // FailureMessage: "STRING_VALUE", |
| 58 | + * // }, |
| 59 | + * // ], |
| 60 | + * // NextToken: "STRING_VALUE", |
| 61 | + * // }; |
| 62 | + * |
| 63 | + * ``` |
| 64 | + * |
| 65 | + * @param ListFileTransferResultsCommandInput - {@link ListFileTransferResultsCommandInput} |
| 66 | + * @returns {@link ListFileTransferResultsCommandOutput} |
| 67 | + * @see {@link ListFileTransferResultsCommandInput} for command's `input` shape. |
| 68 | + * @see {@link ListFileTransferResultsCommandOutput} for command's `response` shape. |
| 69 | + * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape. |
| 70 | + * |
| 71 | + * @throws {@link InternalServiceError} (server fault) |
| 72 | + * <p>This exception is thrown when an error occurs in the Transfer Family service.</p> |
| 73 | + * |
| 74 | + * @throws {@link InvalidRequestException} (client fault) |
| 75 | + * <p>This exception is thrown when the client submits a malformed request.</p> |
| 76 | + * |
| 77 | + * @throws {@link ResourceNotFoundException} (client fault) |
| 78 | + * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family |
| 79 | + * service.</p> |
| 80 | + * |
| 81 | + * @throws {@link ServiceUnavailableException} (server fault) |
| 82 | + * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p> |
| 83 | + * |
| 84 | + * @throws {@link TransferServiceException} |
| 85 | + * <p>Base exception class for all service exceptions from Transfer service.</p> |
| 86 | + * |
| 87 | + * @public |
| 88 | + */ |
| 89 | +export class ListFileTransferResultsCommand extends $Command |
| 90 | + .classBuilder< |
| 91 | + ListFileTransferResultsCommandInput, |
| 92 | + ListFileTransferResultsCommandOutput, |
| 93 | + TransferClientResolvedConfig, |
| 94 | + ServiceInputTypes, |
| 95 | + ServiceOutputTypes |
| 96 | + >() |
| 97 | + .ep(commonParams) |
| 98 | + .m(function (this: any, Command: any, cs: any, config: TransferClientResolvedConfig, o: any) { |
| 99 | + return [ |
| 100 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 101 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 102 | + ]; |
| 103 | + }) |
| 104 | + .s("TransferService", "ListFileTransferResults", {}) |
| 105 | + .n("TransferClient", "ListFileTransferResultsCommand") |
| 106 | + .f(void 0, void 0) |
| 107 | + .ser(se_ListFileTransferResultsCommand) |
| 108 | + .de(de_ListFileTransferResultsCommand) |
| 109 | + .build() { |
| 110 | + /** @internal type navigation helper, not in runtime. */ |
| 111 | + protected declare static __types: { |
| 112 | + api: { |
| 113 | + input: ListFileTransferResultsRequest; |
| 114 | + output: ListFileTransferResultsResponse; |
| 115 | + }; |
| 116 | + sdk: { |
| 117 | + input: ListFileTransferResultsCommandInput; |
| 118 | + output: ListFileTransferResultsCommandOutput; |
| 119 | + }; |
| 120 | + }; |
| 121 | +} |
0 commit comments