@aws-sdk/client-transfer 3.556.0 → 3.563.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -563,6 +563,14 @@ SendWorkflowStepState
563
563
 
564
564
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transfer/command/SendWorkflowStepStateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transfer/Interface/SendWorkflowStepStateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transfer/Interface/SendWorkflowStepStateCommandOutput/)
565
565
 
566
+ </details>
567
+ <details>
568
+ <summary>
569
+ StartDirectoryListing
570
+ </summary>
571
+
572
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transfer/command/StartDirectoryListingCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transfer/Interface/StartDirectoryListingCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transfer/Interface/StartDirectoryListingCommandOutput/)
573
+
566
574
  </details>
567
575
  <details>
568
576
  <summary>
package/dist-cjs/index.js CHANGED
@@ -105,6 +105,7 @@ __export(src_exports, {
105
105
  SetStatOption: () => SetStatOption,
106
106
  SftpAuthenticationMethods: () => SftpAuthenticationMethods,
107
107
  SigningAlg: () => SigningAlg,
108
+ StartDirectoryListingCommand: () => StartDirectoryListingCommand,
108
109
  StartFileTransferCommand: () => StartFileTransferCommand,
109
110
  StartServerCommand: () => StartServerCommand,
110
111
  State: () => State,
@@ -939,6 +940,12 @@ var se_SendWorkflowStepStateCommand = /* @__PURE__ */ __name(async (input, conte
939
940
  body = JSON.stringify((0, import_smithy_client._json)(input));
940
941
  return buildHttpRpcRequest(context, headers, "/", void 0, body);
941
942
  }, "se_SendWorkflowStepStateCommand");
943
+ var se_StartDirectoryListingCommand = /* @__PURE__ */ __name(async (input, context) => {
944
+ const headers = sharedHeaders("StartDirectoryListing");
945
+ let body;
946
+ body = JSON.stringify((0, import_smithy_client._json)(input));
947
+ return buildHttpRpcRequest(context, headers, "/", void 0, body);
948
+ }, "se_StartDirectoryListingCommand");
942
949
  var se_StartFileTransferCommand = /* @__PURE__ */ __name(async (input, context) => {
943
950
  const headers = sharedHeaders("StartFileTransfer");
944
951
  let body;
@@ -1571,6 +1578,19 @@ var de_SendWorkflowStepStateCommand = /* @__PURE__ */ __name(async (output, cont
1571
1578
  };
1572
1579
  return response;
1573
1580
  }, "de_SendWorkflowStepStateCommand");
1581
+ var de_StartDirectoryListingCommand = /* @__PURE__ */ __name(async (output, context) => {
1582
+ if (output.statusCode >= 300) {
1583
+ return de_CommandError(output, context);
1584
+ }
1585
+ const data = await (0, import_core2.parseJsonBody)(output.body, context);
1586
+ let contents = {};
1587
+ contents = (0, import_smithy_client._json)(data);
1588
+ const response = {
1589
+ $metadata: deserializeMetadata(output),
1590
+ ...contents
1591
+ };
1592
+ return response;
1593
+ }, "de_StartDirectoryListingCommand");
1574
1594
  var de_StartFileTransferCommand = /* @__PURE__ */ __name(async (output, context) => {
1575
1595
  if (output.statusCode >= 300) {
1576
1596
  return de_CommandError(output, context);
@@ -2794,6 +2814,23 @@ var _SendWorkflowStepStateCommand = class _SendWorkflowStepStateCommand extends
2794
2814
  __name(_SendWorkflowStepStateCommand, "SendWorkflowStepStateCommand");
2795
2815
  var SendWorkflowStepStateCommand = _SendWorkflowStepStateCommand;
2796
2816
 
2817
+ // src/commands/StartDirectoryListingCommand.ts
2818
+
2819
+
2820
+
2821
+
2822
+ var _StartDirectoryListingCommand = class _StartDirectoryListingCommand extends import_smithy_client.Command.classBuilder().ep({
2823
+ ...commonParams
2824
+ }).m(function(Command, cs, config, o) {
2825
+ return [
2826
+ (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
2827
+ (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
2828
+ ];
2829
+ }).s("TransferService", "StartDirectoryListing", {}).n("TransferClient", "StartDirectoryListingCommand").f(void 0, void 0).ser(se_StartDirectoryListingCommand).de(de_StartDirectoryListingCommand).build() {
2830
+ };
2831
+ __name(_StartDirectoryListingCommand, "StartDirectoryListingCommand");
2832
+ var StartDirectoryListingCommand = _StartDirectoryListingCommand;
2833
+
2797
2834
  // src/commands/StartFileTransferCommand.ts
2798
2835
 
2799
2836
 
@@ -3095,6 +3132,7 @@ var commands = {
3095
3132
  ListUsersCommand,
3096
3133
  ListWorkflowsCommand,
3097
3134
  SendWorkflowStepStateCommand,
3135
+ StartDirectoryListingCommand,
3098
3136
  StartFileTransferCommand,
3099
3137
  StartServerCommand,
3100
3138
  StopServerCommand,
@@ -3292,6 +3330,7 @@ var waitUntilServerOnline = /* @__PURE__ */ __name(async (params, input) => {
3292
3330
  ListUsersCommand,
3293
3331
  ListWorkflowsCommand,
3294
3332
  SendWorkflowStepStateCommand,
3333
+ StartDirectoryListingCommand,
3295
3334
  StartFileTransferCommand,
3296
3335
  StartServerCommand,
3297
3336
  StopServerCommand,
@@ -43,6 +43,7 @@ import { ListTagsForResourceCommand, } from "./commands/ListTagsForResourceComma
43
43
  import { ListUsersCommand } from "./commands/ListUsersCommand";
44
44
  import { ListWorkflowsCommand, } from "./commands/ListWorkflowsCommand";
45
45
  import { SendWorkflowStepStateCommand, } from "./commands/SendWorkflowStepStateCommand";
46
+ import { StartDirectoryListingCommand, } from "./commands/StartDirectoryListingCommand";
46
47
  import { StartFileTransferCommand, } from "./commands/StartFileTransferCommand";
47
48
  import { StartServerCommand } from "./commands/StartServerCommand";
48
49
  import { StopServerCommand } from "./commands/StopServerCommand";
@@ -104,6 +105,7 @@ const commands = {
104
105
  ListUsersCommand,
105
106
  ListWorkflowsCommand,
106
107
  SendWorkflowStepStateCommand,
108
+ StartDirectoryListingCommand,
107
109
  StartFileTransferCommand,
108
110
  StartServerCommand,
109
111
  StopServerCommand,
@@ -0,0 +1,24 @@
1
+ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
2
+ import { getSerdePlugin } from "@smithy/middleware-serde";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { commonParams } from "../endpoint/EndpointParameters";
5
+ import { de_StartDirectoryListingCommand, se_StartDirectoryListingCommand } from "../protocols/Aws_json1_1";
6
+ export { $Command };
7
+ export class StartDirectoryListingCommand extends $Command
8
+ .classBuilder()
9
+ .ep({
10
+ ...commonParams,
11
+ })
12
+ .m(function (Command, cs, config, o) {
13
+ return [
14
+ getSerdePlugin(config, this.serialize, this.deserialize),
15
+ getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
16
+ ];
17
+ })
18
+ .s("TransferService", "StartDirectoryListing", {})
19
+ .n("TransferClient", "StartDirectoryListingCommand")
20
+ .f(void 0, void 0)
21
+ .ser(se_StartDirectoryListingCommand)
22
+ .de(de_StartDirectoryListingCommand)
23
+ .build() {
24
+ }
@@ -42,6 +42,7 @@ export * from "./ListTagsForResourceCommand";
42
42
  export * from "./ListUsersCommand";
43
43
  export * from "./ListWorkflowsCommand";
44
44
  export * from "./SendWorkflowStepStateCommand";
45
+ export * from "./StartDirectoryListingCommand";
45
46
  export * from "./StartFileTransferCommand";
46
47
  export * from "./StartServerCommand";
47
48
  export * from "./StopServerCommand";
@@ -267,6 +267,12 @@ export const se_SendWorkflowStepStateCommand = async (input, context) => {
267
267
  body = JSON.stringify(_json(input));
268
268
  return buildHttpRpcRequest(context, headers, "/", undefined, body);
269
269
  };
270
+ export const se_StartDirectoryListingCommand = async (input, context) => {
271
+ const headers = sharedHeaders("StartDirectoryListing");
272
+ let body;
273
+ body = JSON.stringify(_json(input));
274
+ return buildHttpRpcRequest(context, headers, "/", undefined, body);
275
+ };
270
276
  export const se_StartFileTransferCommand = async (input, context) => {
271
277
  const headers = sharedHeaders("StartFileTransfer");
272
278
  let body;
@@ -899,6 +905,19 @@ export const de_SendWorkflowStepStateCommand = async (output, context) => {
899
905
  };
900
906
  return response;
901
907
  };
908
+ export const de_StartDirectoryListingCommand = async (output, context) => {
909
+ if (output.statusCode >= 300) {
910
+ return de_CommandError(output, context);
911
+ }
912
+ const data = await parseBody(output.body, context);
913
+ let contents = {};
914
+ contents = _json(data);
915
+ const response = {
916
+ $metadata: deserializeMetadata(output),
917
+ ...contents,
918
+ };
919
+ return response;
920
+ };
902
921
  export const de_StartFileTransferCommand = async (output, context) => {
903
922
  if (output.statusCode >= 300) {
904
923
  return de_CommandError(output, context);
@@ -43,6 +43,7 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } fro
43
43
  import { ListUsersCommandInput, ListUsersCommandOutput } from "./commands/ListUsersCommand";
44
44
  import { ListWorkflowsCommandInput, ListWorkflowsCommandOutput } from "./commands/ListWorkflowsCommand";
45
45
  import { SendWorkflowStepStateCommandInput, SendWorkflowStepStateCommandOutput } from "./commands/SendWorkflowStepStateCommand";
46
+ import { StartDirectoryListingCommandInput, StartDirectoryListingCommandOutput } from "./commands/StartDirectoryListingCommand";
46
47
  import { StartFileTransferCommandInput, StartFileTransferCommandOutput } from "./commands/StartFileTransferCommand";
47
48
  import { StartServerCommandInput, StartServerCommandOutput } from "./commands/StartServerCommand";
48
49
  import { StopServerCommandInput, StopServerCommandOutput } from "./commands/StopServerCommand";
@@ -331,6 +332,12 @@ export interface Transfer {
331
332
  sendWorkflowStepState(args: SendWorkflowStepStateCommandInput, options?: __HttpHandlerOptions): Promise<SendWorkflowStepStateCommandOutput>;
332
333
  sendWorkflowStepState(args: SendWorkflowStepStateCommandInput, cb: (err: any, data?: SendWorkflowStepStateCommandOutput) => void): void;
333
334
  sendWorkflowStepState(args: SendWorkflowStepStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendWorkflowStepStateCommandOutput) => void): void;
335
+ /**
336
+ * @see {@link StartDirectoryListingCommand}
337
+ */
338
+ startDirectoryListing(args: StartDirectoryListingCommandInput, options?: __HttpHandlerOptions): Promise<StartDirectoryListingCommandOutput>;
339
+ startDirectoryListing(args: StartDirectoryListingCommandInput, cb: (err: any, data?: StartDirectoryListingCommandOutput) => void): void;
340
+ startDirectoryListing(args: StartDirectoryListingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDirectoryListingCommandOutput) => void): void;
334
341
  /**
335
342
  * @see {@link StartFileTransferCommand}
336
343
  */
@@ -51,6 +51,7 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } fro
51
51
  import { ListUsersCommandInput, ListUsersCommandOutput } from "./commands/ListUsersCommand";
52
52
  import { ListWorkflowsCommandInput, ListWorkflowsCommandOutput } from "./commands/ListWorkflowsCommand";
53
53
  import { SendWorkflowStepStateCommandInput, SendWorkflowStepStateCommandOutput } from "./commands/SendWorkflowStepStateCommand";
54
+ import { StartDirectoryListingCommandInput, StartDirectoryListingCommandOutput } from "./commands/StartDirectoryListingCommand";
54
55
  import { StartFileTransferCommandInput, StartFileTransferCommandOutput } from "./commands/StartFileTransferCommand";
55
56
  import { StartServerCommandInput, StartServerCommandOutput } from "./commands/StartServerCommand";
56
57
  import { StopServerCommandInput, StopServerCommandOutput } from "./commands/StopServerCommand";
@@ -72,11 +73,11 @@ export { __Client };
72
73
  /**
73
74
  * @public
74
75
  */
75
- export type ServiceInputTypes = CreateAccessCommandInput | CreateAgreementCommandInput | CreateConnectorCommandInput | CreateProfileCommandInput | CreateServerCommandInput | CreateUserCommandInput | CreateWorkflowCommandInput | DeleteAccessCommandInput | DeleteAgreementCommandInput | DeleteCertificateCommandInput | DeleteConnectorCommandInput | DeleteHostKeyCommandInput | DeleteProfileCommandInput | DeleteServerCommandInput | DeleteSshPublicKeyCommandInput | DeleteUserCommandInput | DeleteWorkflowCommandInput | DescribeAccessCommandInput | DescribeAgreementCommandInput | DescribeCertificateCommandInput | DescribeConnectorCommandInput | DescribeExecutionCommandInput | DescribeHostKeyCommandInput | DescribeProfileCommandInput | DescribeSecurityPolicyCommandInput | DescribeServerCommandInput | DescribeUserCommandInput | DescribeWorkflowCommandInput | ImportCertificateCommandInput | ImportHostKeyCommandInput | ImportSshPublicKeyCommandInput | ListAccessesCommandInput | ListAgreementsCommandInput | ListCertificatesCommandInput | ListConnectorsCommandInput | ListExecutionsCommandInput | ListHostKeysCommandInput | ListProfilesCommandInput | ListSecurityPoliciesCommandInput | ListServersCommandInput | ListTagsForResourceCommandInput | ListUsersCommandInput | ListWorkflowsCommandInput | SendWorkflowStepStateCommandInput | StartFileTransferCommandInput | StartServerCommandInput | StopServerCommandInput | TagResourceCommandInput | TestConnectionCommandInput | TestIdentityProviderCommandInput | UntagResourceCommandInput | UpdateAccessCommandInput | UpdateAgreementCommandInput | UpdateCertificateCommandInput | UpdateConnectorCommandInput | UpdateHostKeyCommandInput | UpdateProfileCommandInput | UpdateServerCommandInput | UpdateUserCommandInput;
76
+ export type ServiceInputTypes = CreateAccessCommandInput | CreateAgreementCommandInput | CreateConnectorCommandInput | CreateProfileCommandInput | CreateServerCommandInput | CreateUserCommandInput | CreateWorkflowCommandInput | DeleteAccessCommandInput | DeleteAgreementCommandInput | DeleteCertificateCommandInput | DeleteConnectorCommandInput | DeleteHostKeyCommandInput | DeleteProfileCommandInput | DeleteServerCommandInput | DeleteSshPublicKeyCommandInput | DeleteUserCommandInput | DeleteWorkflowCommandInput | DescribeAccessCommandInput | DescribeAgreementCommandInput | DescribeCertificateCommandInput | DescribeConnectorCommandInput | DescribeExecutionCommandInput | DescribeHostKeyCommandInput | DescribeProfileCommandInput | DescribeSecurityPolicyCommandInput | DescribeServerCommandInput | DescribeUserCommandInput | DescribeWorkflowCommandInput | ImportCertificateCommandInput | ImportHostKeyCommandInput | ImportSshPublicKeyCommandInput | ListAccessesCommandInput | ListAgreementsCommandInput | ListCertificatesCommandInput | ListConnectorsCommandInput | ListExecutionsCommandInput | ListHostKeysCommandInput | ListProfilesCommandInput | ListSecurityPoliciesCommandInput | ListServersCommandInput | ListTagsForResourceCommandInput | ListUsersCommandInput | ListWorkflowsCommandInput | SendWorkflowStepStateCommandInput | StartDirectoryListingCommandInput | StartFileTransferCommandInput | StartServerCommandInput | StopServerCommandInput | TagResourceCommandInput | TestConnectionCommandInput | TestIdentityProviderCommandInput | UntagResourceCommandInput | UpdateAccessCommandInput | UpdateAgreementCommandInput | UpdateCertificateCommandInput | UpdateConnectorCommandInput | UpdateHostKeyCommandInput | UpdateProfileCommandInput | UpdateServerCommandInput | UpdateUserCommandInput;
76
77
  /**
77
78
  * @public
78
79
  */
79
- export type ServiceOutputTypes = CreateAccessCommandOutput | CreateAgreementCommandOutput | CreateConnectorCommandOutput | CreateProfileCommandOutput | CreateServerCommandOutput | CreateUserCommandOutput | CreateWorkflowCommandOutput | DeleteAccessCommandOutput | DeleteAgreementCommandOutput | DeleteCertificateCommandOutput | DeleteConnectorCommandOutput | DeleteHostKeyCommandOutput | DeleteProfileCommandOutput | DeleteServerCommandOutput | DeleteSshPublicKeyCommandOutput | DeleteUserCommandOutput | DeleteWorkflowCommandOutput | DescribeAccessCommandOutput | DescribeAgreementCommandOutput | DescribeCertificateCommandOutput | DescribeConnectorCommandOutput | DescribeExecutionCommandOutput | DescribeHostKeyCommandOutput | DescribeProfileCommandOutput | DescribeSecurityPolicyCommandOutput | DescribeServerCommandOutput | DescribeUserCommandOutput | DescribeWorkflowCommandOutput | ImportCertificateCommandOutput | ImportHostKeyCommandOutput | ImportSshPublicKeyCommandOutput | ListAccessesCommandOutput | ListAgreementsCommandOutput | ListCertificatesCommandOutput | ListConnectorsCommandOutput | ListExecutionsCommandOutput | ListHostKeysCommandOutput | ListProfilesCommandOutput | ListSecurityPoliciesCommandOutput | ListServersCommandOutput | ListTagsForResourceCommandOutput | ListUsersCommandOutput | ListWorkflowsCommandOutput | SendWorkflowStepStateCommandOutput | StartFileTransferCommandOutput | StartServerCommandOutput | StopServerCommandOutput | TagResourceCommandOutput | TestConnectionCommandOutput | TestIdentityProviderCommandOutput | UntagResourceCommandOutput | UpdateAccessCommandOutput | UpdateAgreementCommandOutput | UpdateCertificateCommandOutput | UpdateConnectorCommandOutput | UpdateHostKeyCommandOutput | UpdateProfileCommandOutput | UpdateServerCommandOutput | UpdateUserCommandOutput;
80
+ export type ServiceOutputTypes = CreateAccessCommandOutput | CreateAgreementCommandOutput | CreateConnectorCommandOutput | CreateProfileCommandOutput | CreateServerCommandOutput | CreateUserCommandOutput | CreateWorkflowCommandOutput | DeleteAccessCommandOutput | DeleteAgreementCommandOutput | DeleteCertificateCommandOutput | DeleteConnectorCommandOutput | DeleteHostKeyCommandOutput | DeleteProfileCommandOutput | DeleteServerCommandOutput | DeleteSshPublicKeyCommandOutput | DeleteUserCommandOutput | DeleteWorkflowCommandOutput | DescribeAccessCommandOutput | DescribeAgreementCommandOutput | DescribeCertificateCommandOutput | DescribeConnectorCommandOutput | DescribeExecutionCommandOutput | DescribeHostKeyCommandOutput | DescribeProfileCommandOutput | DescribeSecurityPolicyCommandOutput | DescribeServerCommandOutput | DescribeUserCommandOutput | DescribeWorkflowCommandOutput | ImportCertificateCommandOutput | ImportHostKeyCommandOutput | ImportSshPublicKeyCommandOutput | ListAccessesCommandOutput | ListAgreementsCommandOutput | ListCertificatesCommandOutput | ListConnectorsCommandOutput | ListExecutionsCommandOutput | ListHostKeysCommandOutput | ListProfilesCommandOutput | ListSecurityPoliciesCommandOutput | ListServersCommandOutput | ListTagsForResourceCommandOutput | ListUsersCommandOutput | ListWorkflowsCommandOutput | SendWorkflowStepStateCommandOutput | StartDirectoryListingCommandOutput | StartFileTransferCommandOutput | StartServerCommandOutput | StopServerCommandOutput | TagResourceCommandOutput | TestConnectionCommandOutput | TestIdentityProviderCommandOutput | UntagResourceCommandOutput | UpdateAccessCommandOutput | UpdateAgreementCommandOutput | UpdateCertificateCommandOutput | UpdateConnectorCommandOutput | UpdateHostKeyCommandOutput | UpdateProfileCommandOutput | UpdateServerCommandOutput | UpdateUserCommandOutput;
80
81
  /**
81
82
  * @public
82
83
  */
@@ -0,0 +1,123 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { StartDirectoryListingRequest, StartDirectoryListingResponse } from "../models/models_0";
4
+ import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link StartDirectoryListingCommand}.
13
+ */
14
+ export interface StartDirectoryListingCommandInput extends StartDirectoryListingRequest {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link StartDirectoryListingCommand}.
20
+ */
21
+ export interface StartDirectoryListingCommandOutput extends StartDirectoryListingResponse, __MetadataBearer {
22
+ }
23
+ declare const StartDirectoryListingCommand_base: {
24
+ new (input: StartDirectoryListingCommandInput): import("@smithy/smithy-client").CommandImpl<StartDirectoryListingCommandInput, StartDirectoryListingCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: StartDirectoryListingCommandInput): import("@smithy/smithy-client").CommandImpl<StartDirectoryListingCommandInput, StartDirectoryListingCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ };
28
+ /**
29
+ * <p>Retrieves a list of the contents of a directory from a remote SFTP server. You specify the
30
+ * connector ID, the output path, and the remote directory path. You can also specify the
31
+ * optional <code>MaxItems</code> value to control the maximum number of items that are listed
32
+ * from the remote directory. This API returns a list of all files and directories in the remote
33
+ * directory (up to the maximum value), but does not return files or folders in sub-directories.
34
+ * That is, it only returns a list of files and directories one-level deep.</p>
35
+ * <p>After you receive the listing file, you can provide the files that you want to transfer to
36
+ * the <code>RetrieveFilePaths</code> parameter of the <code>StartFileTransfer</code> API
37
+ * call.</p>
38
+ * <p>The naming convention for the output file is
39
+ * <code>
40
+ * <i>connector-ID</i>-<i>listing-ID</i>.json</code>. The
41
+ * output file contains the following information:</p>
42
+ * <ul>
43
+ * <li>
44
+ * <p>
45
+ * <code>filePath</code>: the complete path of a remote file, relative to the directory
46
+ * of the listing request for your SFTP connector on the remote server.</p>
47
+ * </li>
48
+ * <li>
49
+ * <p>
50
+ * <code>modifiedTimestamp</code>: the last time the file was modified, in UTC time
51
+ * format. This field is optional. If the remote file attributes don't contain a timestamp,
52
+ * it is omitted from the file listing.</p>
53
+ * </li>
54
+ * <li>
55
+ * <p>
56
+ * <code>size</code>: the size of the file, in bytes. This field is optional. If the
57
+ * remote file attributes don't contain a file size, it is omitted from the file
58
+ * listing.</p>
59
+ * </li>
60
+ * <li>
61
+ * <p>
62
+ * <code>path</code>: the complete path of a remote directory, relative to the directory
63
+ * of the listing request for your SFTP connector on the remote server.</p>
64
+ * </li>
65
+ * <li>
66
+ * <p>
67
+ * <code>truncated</code>: a flag indicating whether the list output contains all of the
68
+ * items contained in the remote directory or not. If your <code>Truncated</code> output
69
+ * value is true, you can increase the value provided in the optional <code>max-items</code>
70
+ * input attribute to be able to list more items (up to the maximum allowed list size of
71
+ * 10,000 items).</p>
72
+ * </li>
73
+ * </ul>
74
+ * @example
75
+ * Use a bare-bones client and the command you need to make an API call.
76
+ * ```javascript
77
+ * import { TransferClient, StartDirectoryListingCommand } from "@aws-sdk/client-transfer"; // ES Modules import
78
+ * // const { TransferClient, StartDirectoryListingCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
79
+ * const client = new TransferClient(config);
80
+ * const input = { // StartDirectoryListingRequest
81
+ * ConnectorId: "STRING_VALUE", // required
82
+ * RemoteDirectoryPath: "STRING_VALUE", // required
83
+ * MaxItems: Number("int"),
84
+ * OutputDirectoryPath: "STRING_VALUE", // required
85
+ * };
86
+ * const command = new StartDirectoryListingCommand(input);
87
+ * const response = await client.send(command);
88
+ * // { // StartDirectoryListingResponse
89
+ * // ListingId: "STRING_VALUE", // required
90
+ * // OutputFileName: "STRING_VALUE", // required
91
+ * // };
92
+ *
93
+ * ```
94
+ *
95
+ * @param StartDirectoryListingCommandInput - {@link StartDirectoryListingCommandInput}
96
+ * @returns {@link StartDirectoryListingCommandOutput}
97
+ * @see {@link StartDirectoryListingCommandInput} for command's `input` shape.
98
+ * @see {@link StartDirectoryListingCommandOutput} for command's `response` shape.
99
+ * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
100
+ *
101
+ * @throws {@link InternalServiceError} (server fault)
102
+ * <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
103
+ *
104
+ * @throws {@link InvalidRequestException} (client fault)
105
+ * <p>This exception is thrown when the client submits a malformed request.</p>
106
+ *
107
+ * @throws {@link ResourceNotFoundException} (client fault)
108
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
109
+ * service.</p>
110
+ *
111
+ * @throws {@link ServiceUnavailableException} (server fault)
112
+ * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
113
+ *
114
+ * @throws {@link ThrottlingException} (client fault)
115
+ * <p>The request was denied due to request throttling.</p>
116
+ *
117
+ * @throws {@link TransferServiceException}
118
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
119
+ *
120
+ * @public
121
+ */
122
+ export declare class StartDirectoryListingCommand extends StartDirectoryListingCommand_base {
123
+ }
@@ -39,7 +39,7 @@ declare const StartFileTransferCommand_base: {
39
39
  * <ul>
40
40
  * <li>
41
41
  * <p>If you are transferring file from a partner's SFTP server to Amazon Web Services
42
- * storage, you specify one or more <code>RetreiveFilePaths</code> to identify the files
42
+ * storage, you specify one or more <code>RetrieveFilePaths</code> to identify the files
43
43
  * you want to transfer, and a <code>LocalDirectoryPath</code> to specify the destination
44
44
  * folder.</p>
45
45
  * </li>
@@ -42,6 +42,7 @@ export * from "./ListTagsForResourceCommand";
42
42
  export * from "./ListUsersCommand";
43
43
  export * from "./ListWorkflowsCommand";
44
44
  export * from "./SendWorkflowStepStateCommand";
45
+ export * from "./StartDirectoryListingCommand";
45
46
  export * from "./StartFileTransferCommand";
46
47
  export * from "./StartServerCommand";
47
48
  export * from "./StopServerCommand";
@@ -2629,21 +2629,7 @@ export interface DescribedCertificate {
2629
2629
  */
2630
2630
  CertificateId?: string;
2631
2631
  /**
2632
- * <p>Specifies how this certificate is used. It can be used in the following ways:</p>
2633
- * <ul>
2634
- * <li>
2635
- * <p>
2636
- * <code>SIGNING</code>: For signing AS2 messages</p>
2637
- * </li>
2638
- * <li>
2639
- * <p>
2640
- * <code>ENCRYPTION</code>: For encrypting AS2 messages</p>
2641
- * </li>
2642
- * <li>
2643
- * <p>
2644
- * <code>TLS</code>: For securing AS2 communications sent over HTTPS</p>
2645
- * </li>
2646
- * </ul>
2632
+ * <p>Specifies whether this certificate is used for signing or encryption.</p>
2647
2633
  * @public
2648
2634
  */
2649
2635
  Usage?: CertificateUsageType;
@@ -3929,21 +3915,7 @@ export interface DescribeWorkflowResponse {
3929
3915
  */
3930
3916
  export interface ImportCertificateRequest {
3931
3917
  /**
3932
- * <p>Specifies how this certificate is used. It can be used in the following ways:</p>
3933
- * <ul>
3934
- * <li>
3935
- * <p>
3936
- * <code>SIGNING</code>: For signing AS2 messages</p>
3937
- * </li>
3938
- * <li>
3939
- * <p>
3940
- * <code>ENCRYPTION</code>: For encrypting AS2 messages</p>
3941
- * </li>
3942
- * <li>
3943
- * <p>
3944
- * <code>TLS</code>: For securing AS2 communications sent over HTTPS</p>
3945
- * </li>
3946
- * </ul>
3918
+ * <p>Specifies whether this certificate is used for signing or encryption.</p>
3947
3919
  * @public
3948
3920
  */
3949
3921
  Usage: CertificateUsageType | undefined;
@@ -4324,21 +4296,7 @@ export interface ListedCertificate {
4324
4296
  */
4325
4297
  CertificateId?: string;
4326
4298
  /**
4327
- * <p>Specifies how this certificate is used. It can be used in the following ways:</p>
4328
- * <ul>
4329
- * <li>
4330
- * <p>
4331
- * <code>SIGNING</code>: For signing AS2 messages</p>
4332
- * </li>
4333
- * <li>
4334
- * <p>
4335
- * <code>ENCRYPTION</code>: For encrypting AS2 messages</p>
4336
- * </li>
4337
- * <li>
4338
- * <p>
4339
- * <code>TLS</code>: For securing AS2 communications sent over HTTPS</p>
4340
- * </li>
4341
- * </ul>
4299
+ * <p>Specifies whether this certificate is used for signing or encryption.</p>
4342
4300
  * @public
4343
4301
  */
4344
4302
  Usage?: CertificateUsageType;
@@ -5098,6 +5056,47 @@ export interface SendWorkflowStepStateRequest {
5098
5056
  */
5099
5057
  export interface SendWorkflowStepStateResponse {
5100
5058
  }
5059
+ /**
5060
+ * @public
5061
+ */
5062
+ export interface StartDirectoryListingRequest {
5063
+ /**
5064
+ * <p>The unique identifier for the connector.</p>
5065
+ * @public
5066
+ */
5067
+ ConnectorId: string | undefined;
5068
+ /**
5069
+ * <p>Specifies the directory on the remote SFTP server for which you want to list its contents.</p>
5070
+ * @public
5071
+ */
5072
+ RemoteDirectoryPath: string | undefined;
5073
+ /**
5074
+ * <p>An optional parameter where you can specify the maximum number of file/directory names to
5075
+ * retrieve. The default value is 1,000.</p>
5076
+ * @public
5077
+ */
5078
+ MaxItems?: number;
5079
+ /**
5080
+ * <p>Specifies the path (bucket and prefix) in Amazon S3 storage to store the results of the directory listing.</p>
5081
+ * @public
5082
+ */
5083
+ OutputDirectoryPath: string | undefined;
5084
+ }
5085
+ /**
5086
+ * @public
5087
+ */
5088
+ export interface StartDirectoryListingResponse {
5089
+ /**
5090
+ * <p>Returns a unique identifier for the directory listing call.</p>
5091
+ * @public
5092
+ */
5093
+ ListingId: string | undefined;
5094
+ /**
5095
+ * <p>Returns the file name where the results are stored. This is a combination of the connector ID and the listing ID: <code>&lt;connector-id&gt;-&lt;listing-id&gt;.json</code>.</p>
5096
+ * @public
5097
+ */
5098
+ OutputFileName: string | undefined;
5099
+ }
5101
5100
  /**
5102
5101
  * @public
5103
5102
  */
@@ -44,6 +44,7 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } fro
44
44
  import { ListUsersCommandInput, ListUsersCommandOutput } from "../commands/ListUsersCommand";
45
45
  import { ListWorkflowsCommandInput, ListWorkflowsCommandOutput } from "../commands/ListWorkflowsCommand";
46
46
  import { SendWorkflowStepStateCommandInput, SendWorkflowStepStateCommandOutput } from "../commands/SendWorkflowStepStateCommand";
47
+ import { StartDirectoryListingCommandInput, StartDirectoryListingCommandOutput } from "../commands/StartDirectoryListingCommand";
47
48
  import { StartFileTransferCommandInput, StartFileTransferCommandOutput } from "../commands/StartFileTransferCommand";
48
49
  import { StartServerCommandInput, StartServerCommandOutput } from "../commands/StartServerCommand";
49
50
  import { StopServerCommandInput, StopServerCommandOutput } from "../commands/StopServerCommand";
@@ -235,6 +236,10 @@ export declare const se_ListWorkflowsCommand: (input: ListWorkflowsCommandInput,
235
236
  * serializeAws_json1_1SendWorkflowStepStateCommand
236
237
  */
237
238
  export declare const se_SendWorkflowStepStateCommand: (input: SendWorkflowStepStateCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
239
+ /**
240
+ * serializeAws_json1_1StartDirectoryListingCommand
241
+ */
242
+ export declare const se_StartDirectoryListingCommand: (input: StartDirectoryListingCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
238
243
  /**
239
244
  * serializeAws_json1_1StartFileTransferCommand
240
245
  */
@@ -471,6 +476,10 @@ export declare const de_ListWorkflowsCommand: (output: __HttpResponse, context:
471
476
  * deserializeAws_json1_1SendWorkflowStepStateCommand
472
477
  */
473
478
  export declare const de_SendWorkflowStepStateCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SendWorkflowStepStateCommandOutput>;
479
+ /**
480
+ * deserializeAws_json1_1StartDirectoryListingCommand
481
+ */
482
+ export declare const de_StartDirectoryListingCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StartDirectoryListingCommandOutput>;
474
483
  /**
475
484
  * deserializeAws_json1_1StartFileTransferCommand
476
485
  */
@@ -175,6 +175,10 @@ import {
175
175
  SendWorkflowStepStateCommandInput,
176
176
  SendWorkflowStepStateCommandOutput,
177
177
  } from "./commands/SendWorkflowStepStateCommand";
178
+ import {
179
+ StartDirectoryListingCommandInput,
180
+ StartDirectoryListingCommandOutput,
181
+ } from "./commands/StartDirectoryListingCommand";
178
182
  import {
179
183
  StartFileTransferCommandInput,
180
184
  StartFileTransferCommandOutput,
@@ -816,6 +820,19 @@ export interface Transfer {
816
820
  options: __HttpHandlerOptions,
817
821
  cb: (err: any, data?: SendWorkflowStepStateCommandOutput) => void
818
822
  ): void;
823
+ startDirectoryListing(
824
+ args: StartDirectoryListingCommandInput,
825
+ options?: __HttpHandlerOptions
826
+ ): Promise<StartDirectoryListingCommandOutput>;
827
+ startDirectoryListing(
828
+ args: StartDirectoryListingCommandInput,
829
+ cb: (err: any, data?: StartDirectoryListingCommandOutput) => void
830
+ ): void;
831
+ startDirectoryListing(
832
+ args: StartDirectoryListingCommandInput,
833
+ options: __HttpHandlerOptions,
834
+ cb: (err: any, data?: StartDirectoryListingCommandOutput) => void
835
+ ): void;
819
836
  startFileTransfer(
820
837
  args: StartFileTransferCommandInput,
821
838
  options?: __HttpHandlerOptions
@@ -221,6 +221,10 @@ import {
221
221
  SendWorkflowStepStateCommandInput,
222
222
  SendWorkflowStepStateCommandOutput,
223
223
  } from "./commands/SendWorkflowStepStateCommand";
224
+ import {
225
+ StartDirectoryListingCommandInput,
226
+ StartDirectoryListingCommandOutput,
227
+ } from "./commands/StartDirectoryListingCommand";
224
228
  import {
225
229
  StartFileTransferCommandInput,
226
230
  StartFileTransferCommandOutput,
@@ -333,6 +337,7 @@ export type ServiceInputTypes =
333
337
  | ListUsersCommandInput
334
338
  | ListWorkflowsCommandInput
335
339
  | SendWorkflowStepStateCommandInput
340
+ | StartDirectoryListingCommandInput
336
341
  | StartFileTransferCommandInput
337
342
  | StartServerCommandInput
338
343
  | StopServerCommandInput
@@ -393,6 +398,7 @@ export type ServiceOutputTypes =
393
398
  | ListUsersCommandOutput
394
399
  | ListWorkflowsCommandOutput
395
400
  | SendWorkflowStepStateCommandOutput
401
+ | StartDirectoryListingCommandOutput
396
402
  | StartFileTransferCommandOutput
397
403
  | StartServerCommandOutput
398
404
  | StopServerCommandOutput
@@ -0,0 +1,39 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import {
4
+ StartDirectoryListingRequest,
5
+ StartDirectoryListingResponse,
6
+ } from "../models/models_0";
7
+ import {
8
+ ServiceInputTypes,
9
+ ServiceOutputTypes,
10
+ TransferClientResolvedConfig,
11
+ } from "../TransferClient";
12
+ export { __MetadataBearer, $Command };
13
+ export interface StartDirectoryListingCommandInput
14
+ extends StartDirectoryListingRequest {}
15
+ export interface StartDirectoryListingCommandOutput
16
+ extends StartDirectoryListingResponse,
17
+ __MetadataBearer {}
18
+ declare const StartDirectoryListingCommand_base: {
19
+ new (
20
+ input: StartDirectoryListingCommandInput
21
+ ): import("@smithy/smithy-client").CommandImpl<
22
+ StartDirectoryListingCommandInput,
23
+ StartDirectoryListingCommandOutput,
24
+ TransferClientResolvedConfig,
25
+ ServiceInputTypes,
26
+ ServiceOutputTypes
27
+ >;
28
+ new (
29
+ __0_0: StartDirectoryListingCommandInput
30
+ ): import("@smithy/smithy-client").CommandImpl<
31
+ StartDirectoryListingCommandInput,
32
+ StartDirectoryListingCommandOutput,
33
+ TransferClientResolvedConfig,
34
+ ServiceInputTypes,
35
+ ServiceOutputTypes
36
+ >;
37
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
38
+ };
39
+ export declare class StartDirectoryListingCommand extends StartDirectoryListingCommand_base {}
@@ -42,6 +42,7 @@ export * from "./ListTagsForResourceCommand";
42
42
  export * from "./ListUsersCommand";
43
43
  export * from "./ListWorkflowsCommand";
44
44
  export * from "./SendWorkflowStepStateCommand";
45
+ export * from "./StartDirectoryListingCommand";
45
46
  export * from "./StartFileTransferCommand";
46
47
  export * from "./StartServerCommand";
47
48
  export * from "./StopServerCommand";
@@ -984,6 +984,16 @@ export interface SendWorkflowStepStateRequest {
984
984
  Status: CustomStepStatus | undefined;
985
985
  }
986
986
  export interface SendWorkflowStepStateResponse {}
987
+ export interface StartDirectoryListingRequest {
988
+ ConnectorId: string | undefined;
989
+ RemoteDirectoryPath: string | undefined;
990
+ MaxItems?: number;
991
+ OutputDirectoryPath: string | undefined;
992
+ }
993
+ export interface StartDirectoryListingResponse {
994
+ ListingId: string | undefined;
995
+ OutputFileName: string | undefined;
996
+ }
987
997
  export interface StartFileTransferRequest {
988
998
  ConnectorId: string | undefined;
989
999
  SendFilePaths?: string[];
@@ -179,6 +179,10 @@ import {
179
179
  SendWorkflowStepStateCommandInput,
180
180
  SendWorkflowStepStateCommandOutput,
181
181
  } from "../commands/SendWorkflowStepStateCommand";
182
+ import {
183
+ StartDirectoryListingCommandInput,
184
+ StartDirectoryListingCommandOutput,
185
+ } from "../commands/StartDirectoryListingCommand";
182
186
  import {
183
187
  StartFileTransferCommandInput,
184
188
  StartFileTransferCommandOutput,
@@ -415,6 +419,10 @@ export declare const se_SendWorkflowStepStateCommand: (
415
419
  input: SendWorkflowStepStateCommandInput,
416
420
  context: __SerdeContext
417
421
  ) => Promise<__HttpRequest>;
422
+ export declare const se_StartDirectoryListingCommand: (
423
+ input: StartDirectoryListingCommandInput,
424
+ context: __SerdeContext
425
+ ) => Promise<__HttpRequest>;
418
426
  export declare const se_StartFileTransferCommand: (
419
427
  input: StartFileTransferCommandInput,
420
428
  context: __SerdeContext
@@ -651,6 +659,10 @@ export declare const de_SendWorkflowStepStateCommand: (
651
659
  output: __HttpResponse,
652
660
  context: __SerdeContext
653
661
  ) => Promise<SendWorkflowStepStateCommandOutput>;
662
+ export declare const de_StartDirectoryListingCommand: (
663
+ output: __HttpResponse,
664
+ context: __SerdeContext
665
+ ) => Promise<StartDirectoryListingCommandOutput>;
654
666
  export declare const de_StartFileTransferCommand: (
655
667
  output: __HttpResponse,
656
668
  context: __SerdeContext
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-transfer",
3
3
  "description": "AWS SDK for JavaScript Transfer Client for Node.js, Browser and React Native",
4
- "version": "3.556.0",
4
+ "version": "3.563.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-transfer",
@@ -22,7 +22,7 @@
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
23
  "@aws-sdk/client-sts": "3.556.0",
24
24
  "@aws-sdk/core": "3.556.0",
25
- "@aws-sdk/credential-provider-node": "3.556.0",
25
+ "@aws-sdk/credential-provider-node": "3.563.0",
26
26
  "@aws-sdk/middleware-host-header": "3.535.0",
27
27
  "@aws-sdk/middleware-logger": "3.535.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.535.0",