-
Notifications
You must be signed in to change notification settings - Fork 587
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(client-transfer): This release enables customers using SFTP conn…
…ectors to query the transfer status of their files to meet their monitoring needs as well as orchestrate post transfer actions.
- Loading branch information
awstools
committed
Oct 14, 2024
1 parent
375e4e5
commit d227a3e
Showing
11 changed files
with
554 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
121 changes: 121 additions & 0 deletions
121
clients/client-transfer/src/commands/ListFileTransferResultsCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| // smithy-typescript generated code | ||
| import { getEndpointPlugin } from "@smithy/middleware-endpoint"; | ||
| import { getSerdePlugin } from "@smithy/middleware-serde"; | ||
| import { Command as $Command } from "@smithy/smithy-client"; | ||
| import { MetadataBearer as __MetadataBearer } from "@smithy/types"; | ||
|
|
||
| import { commonParams } from "../endpoint/EndpointParameters"; | ||
| import { ListFileTransferResultsRequest, ListFileTransferResultsResponse } from "../models/models_0"; | ||
| import { de_ListFileTransferResultsCommand, se_ListFileTransferResultsCommand } from "../protocols/Aws_json1_1"; | ||
| import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient"; | ||
|
|
||
| /** | ||
| * @public | ||
| */ | ||
| export type { __MetadataBearer }; | ||
| export { $Command }; | ||
| /** | ||
| * @public | ||
| * | ||
| * The input for {@link ListFileTransferResultsCommand}. | ||
| */ | ||
| export interface ListFileTransferResultsCommandInput extends ListFileTransferResultsRequest {} | ||
| /** | ||
| * @public | ||
| * | ||
| * The output of {@link ListFileTransferResultsCommand}. | ||
| */ | ||
| export interface ListFileTransferResultsCommandOutput extends ListFileTransferResultsResponse, __MetadataBearer {} | ||
|
|
||
| /** | ||
| * <p> | ||
| * Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. | ||
| * You specify the file transfer by providing its <code>ConnectorId</code> and its <code>TransferId</code>.</p> | ||
| * <note> | ||
| * <p>File transfer results are available up to 7 days after an operation has been requested.</p> | ||
| * </note> | ||
| * @example | ||
| * Use a bare-bones client and the command you need to make an API call. | ||
| * ```javascript | ||
| * import { TransferClient, ListFileTransferResultsCommand } from "@aws-sdk/client-transfer"; // ES Modules import | ||
| * // const { TransferClient, ListFileTransferResultsCommand } = require("@aws-sdk/client-transfer"); // CommonJS import | ||
| * const client = new TransferClient(config); | ||
| * const input = { // ListFileTransferResultsRequest | ||
| * ConnectorId: "STRING_VALUE", // required | ||
| * TransferId: "STRING_VALUE", // required | ||
| * NextToken: "STRING_VALUE", | ||
| * MaxResults: Number("int"), | ||
| * }; | ||
| * const command = new ListFileTransferResultsCommand(input); | ||
| * const response = await client.send(command); | ||
| * // { // ListFileTransferResultsResponse | ||
| * // FileTransferResults: [ // ConnectorFileTransferResults // required | ||
| * // { // ConnectorFileTransferResult | ||
| * // FilePath: "STRING_VALUE", // required | ||
| * // StatusCode: "QUEUED" || "IN_PROGRESS" || "COMPLETED" || "FAILED", // required | ||
| * // FailureCode: "STRING_VALUE", | ||
| * // FailureMessage: "STRING_VALUE", | ||
| * // }, | ||
| * // ], | ||
| * // NextToken: "STRING_VALUE", | ||
| * // }; | ||
| * | ||
| * ``` | ||
| * | ||
| * @param ListFileTransferResultsCommandInput - {@link ListFileTransferResultsCommandInput} | ||
| * @returns {@link ListFileTransferResultsCommandOutput} | ||
| * @see {@link ListFileTransferResultsCommandInput} for command's `input` shape. | ||
| * @see {@link ListFileTransferResultsCommandOutput} for command's `response` shape. | ||
| * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape. | ||
| * | ||
| * @throws {@link InternalServiceError} (server fault) | ||
| * <p>This exception is thrown when an error occurs in the Transfer Family service.</p> | ||
| * | ||
| * @throws {@link InvalidRequestException} (client fault) | ||
| * <p>This exception is thrown when the client submits a malformed request.</p> | ||
| * | ||
| * @throws {@link ResourceNotFoundException} (client fault) | ||
| * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family | ||
| * service.</p> | ||
| * | ||
| * @throws {@link ServiceUnavailableException} (server fault) | ||
| * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p> | ||
| * | ||
| * @throws {@link TransferServiceException} | ||
| * <p>Base exception class for all service exceptions from Transfer service.</p> | ||
| * | ||
| * @public | ||
| */ | ||
| export class ListFileTransferResultsCommand extends $Command | ||
| .classBuilder< | ||
| ListFileTransferResultsCommandInput, | ||
| ListFileTransferResultsCommandOutput, | ||
| TransferClientResolvedConfig, | ||
| ServiceInputTypes, | ||
| ServiceOutputTypes | ||
| >() | ||
| .ep(commonParams) | ||
| .m(function (this: any, Command: any, cs: any, config: TransferClientResolvedConfig, o: any) { | ||
| return [ | ||
| getSerdePlugin(config, this.serialize, this.deserialize), | ||
| getEndpointPlugin(config, Command.getEndpointParameterInstructions()), | ||
| ]; | ||
| }) | ||
| .s("TransferService", "ListFileTransferResults", {}) | ||
| .n("TransferClient", "ListFileTransferResultsCommand") | ||
| .f(void 0, void 0) | ||
| .ser(se_ListFileTransferResultsCommand) | ||
| .de(de_ListFileTransferResultsCommand) | ||
| .build() { | ||
| /** @internal type navigation helper, not in runtime. */ | ||
| protected declare static __types: { | ||
| api: { | ||
| input: ListFileTransferResultsRequest; | ||
| output: ListFileTransferResultsResponse; | ||
| }; | ||
| sdk: { | ||
| input: ListFileTransferResultsCommandInput; | ||
| output: ListFileTransferResultsCommandOutput; | ||
| }; | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.