@aws-sdk/client-transfer 3.1037.0 → 3.1039.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.
@@ -1,5 +1,5 @@
1
1
  import { checkExceptions, createWaiter, WaiterState, } from "@smithy/util-waiter";
2
- import { DescribeServerCommand } from "../commands/DescribeServerCommand";
2
+ import { DescribeServerCommand, } from "../commands/DescribeServerCommand";
3
3
  const checkState = async (client, input) => {
4
4
  let reason;
5
5
  try {
@@ -1,5 +1,5 @@
1
1
  import { checkExceptions, createWaiter, WaiterState, } from "@smithy/util-waiter";
2
- import { DescribeServerCommand } from "../commands/DescribeServerCommand";
2
+ import { DescribeServerCommand, } from "../commands/DescribeServerCommand";
3
3
  const checkState = async (client, input) => {
4
4
  let reason;
5
5
  try {
@@ -603,13 +603,13 @@ export interface Transfer {
603
603
  * @param args - command input.
604
604
  * @param waiterConfig - `maxWaitTime` in seconds or waiter config object.
605
605
  */
606
- waitUntilServerOffline(args: DescribeServerCommandInput, waiterConfig: number | Omit<WaiterConfiguration<Transfer>, "client">): Promise<WaiterResult>;
606
+ waitUntilServerOffline(args: DescribeServerCommandInput, waiterConfig: number | Omit<WaiterConfiguration<Transfer>, "client">): Promise<WaiterResult<DescribeServerCommandOutput>>;
607
607
  /**
608
608
  * @see {@link DescribeServerCommand}
609
609
  * @param args - command input.
610
610
  * @param waiterConfig - `maxWaitTime` in seconds or waiter config object.
611
611
  */
612
- waitUntilServerOnline(args: DescribeServerCommandInput, waiterConfig: number | Omit<WaiterConfiguration<Transfer>, "client">): Promise<WaiterResult>;
612
+ waitUntilServerOnline(args: DescribeServerCommandInput, waiterConfig: number | Omit<WaiterConfiguration<Transfer>, "client">): Promise<WaiterResult<DescribeServerCommandOutput>>;
613
613
  }
614
614
  /**
615
615
  * <p>Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS. Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.</p>
@@ -27,7 +27,7 @@ declare const StartDirectoryListingCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional <code>MaxItems</code> value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep.</p> <p>After you receive the listing file, you can provide the files that you want to transfer to the <code>RetrieveFilePaths</code> parameter of the <code>StartFileTransfer</code> API call.</p> <p>The naming convention for the output file is <code> <i>connector-ID</i>-<i>listing-ID</i>.json</code>. The output file contains the following information:</p> <ul> <li> <p> <code>filePath</code>: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server.</p> </li> <li> <p> <code>modifiedTimestamp</code>: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing.</p> </li> <li> <p> <code>size</code>: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing.</p> </li> <li> <p> <code>path</code>: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server.</p> </li> <li> <p> <code>truncated</code>: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your <code>Truncated</code> output value is true, you can increase the value provided in the optional <code>max-items</code> input attribute to be able to list more items (up to the maximum allowed list size of 10,000 items).</p> </li> </ul>
30
+ * <p>Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional <code>MaxItems</code> value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep.</p> <p>After you receive the listing file, you can provide the files that you want to transfer to the <code>RetrieveFilePaths</code> parameter of the <code>StartFileTransfer</code> API call.</p> <p>The naming convention for the output file is <code> <i>connector-ID</i>-<i>listing-ID</i>.json</code>. The output file contains the following information:</p> <ul> <li> <p> <code>filePath</code>: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server.</p> </li> <li> <p> <code>modifiedTimestamp</code>: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing.</p> </li> <li> <p> <code>size</code>: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing.</p> </li> <li> <p> <code>path</code>: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server.</p> </li> <li> <p> <code>truncated</code>: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your <code>Truncated</code> output value is true, you can increase the value provided in the optional <code>max-items</code> input attribute to be able to list more items (up to the maximum allowed list size of 200,000 items).</p> </li> </ul>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -1321,7 +1321,7 @@ export interface Transfer {
1321
1321
  WaiterConfiguration<Transfer>,
1322
1322
  Exclude<keyof WaiterConfiguration<Transfer>, "client">
1323
1323
  >
1324
- ): Promise<WaiterResult>;
1324
+ ): Promise<WaiterResult<DescribeServerCommandOutput>>;
1325
1325
  waitUntilServerOnline(
1326
1326
  args: DescribeServerCommandInput,
1327
1327
  waiterConfig:
@@ -1330,6 +1330,6 @@ export interface Transfer {
1330
1330
  WaiterConfiguration<Transfer>,
1331
1331
  Exclude<keyof WaiterConfiguration<Transfer>, "client">
1332
1332
  >
1333
- ): Promise<WaiterResult>;
1333
+ ): Promise<WaiterResult<DescribeServerCommandOutput>>;
1334
1334
  }
1335
1335
  export declare class Transfer extends TransferClient implements Transfer {}
@@ -1,11 +1,17 @@
1
1
  import { WaiterConfiguration, WaiterResult } from "@smithy/util-waiter";
2
- import { DescribeServerCommandInput } from "../commands/DescribeServerCommand";
2
+ import {
3
+ DescribeServerCommandInput,
4
+ DescribeServerCommandOutput,
5
+ } from "../commands/DescribeServerCommand";
6
+ import { TransferServiceException } from "../models/TransferServiceException";
3
7
  import { TransferClient } from "../TransferClient";
4
8
  export declare const waitForServerOffline: (
5
9
  params: WaiterConfiguration<TransferClient>,
6
10
  input: DescribeServerCommandInput
7
- ) => Promise<WaiterResult>;
11
+ ) => Promise<
12
+ WaiterResult<DescribeServerCommandOutput | TransferServiceException>
13
+ >;
8
14
  export declare const waitUntilServerOffline: (
9
15
  params: WaiterConfiguration<TransferClient>,
10
16
  input: DescribeServerCommandInput
11
- ) => Promise<WaiterResult>;
17
+ ) => Promise<WaiterResult<DescribeServerCommandOutput>>;
@@ -1,11 +1,17 @@
1
1
  import { WaiterConfiguration, WaiterResult } from "@smithy/util-waiter";
2
- import { DescribeServerCommandInput } from "../commands/DescribeServerCommand";
2
+ import {
3
+ DescribeServerCommandInput,
4
+ DescribeServerCommandOutput,
5
+ } from "../commands/DescribeServerCommand";
6
+ import { TransferServiceException } from "../models/TransferServiceException";
3
7
  import { TransferClient } from "../TransferClient";
4
8
  export declare const waitForServerOnline: (
5
9
  params: WaiterConfiguration<TransferClient>,
6
10
  input: DescribeServerCommandInput
7
- ) => Promise<WaiterResult>;
11
+ ) => Promise<
12
+ WaiterResult<DescribeServerCommandOutput | TransferServiceException>
13
+ >;
8
14
  export declare const waitUntilServerOnline: (
9
15
  params: WaiterConfiguration<TransferClient>,
10
16
  input: DescribeServerCommandInput
11
- ) => Promise<WaiterResult>;
17
+ ) => Promise<WaiterResult<DescribeServerCommandOutput>>;
@@ -1,14 +1,15 @@
1
1
  import { type WaiterConfiguration, type WaiterResult } from "@smithy/util-waiter";
2
- import { type DescribeServerCommandInput } from "../commands/DescribeServerCommand";
2
+ import { type DescribeServerCommandInput, type DescribeServerCommandOutput } from "../commands/DescribeServerCommand";
3
+ import type { TransferServiceException } from "../models/TransferServiceException";
3
4
  import type { TransferClient } from "../TransferClient";
4
5
  /**
5
6
  *
6
7
  * @deprecated Use waitUntilServerOffline instead. waitForServerOffline does not throw error in non-success cases.
7
8
  */
8
- export declare const waitForServerOffline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult>;
9
+ export declare const waitForServerOffline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult<DescribeServerCommandOutput | TransferServiceException>>;
9
10
  /**
10
11
  *
11
12
  * @param params - Waiter configuration options.
12
13
  * @param input - The input to DescribeServerCommand for polling.
13
14
  */
14
- export declare const waitUntilServerOffline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult>;
15
+ export declare const waitUntilServerOffline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult<DescribeServerCommandOutput>>;
@@ -1,14 +1,15 @@
1
1
  import { type WaiterConfiguration, type WaiterResult } from "@smithy/util-waiter";
2
- import { type DescribeServerCommandInput } from "../commands/DescribeServerCommand";
2
+ import { type DescribeServerCommandInput, type DescribeServerCommandOutput } from "../commands/DescribeServerCommand";
3
+ import type { TransferServiceException } from "../models/TransferServiceException";
3
4
  import type { TransferClient } from "../TransferClient";
4
5
  /**
5
6
  *
6
7
  * @deprecated Use waitUntilServerOnline instead. waitForServerOnline does not throw error in non-success cases.
7
8
  */
8
- export declare const waitForServerOnline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult>;
9
+ export declare const waitForServerOnline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult<DescribeServerCommandOutput | TransferServiceException>>;
9
10
  /**
10
11
  *
11
12
  * @param params - Waiter configuration options.
12
13
  * @param input - The input to DescribeServerCommand for polling.
13
14
  */
14
- export declare const waitUntilServerOnline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult>;
15
+ export declare const waitUntilServerOnline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult<DescribeServerCommandOutput>>;
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.1037.0",
4
+ "version": "3.1039.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-transfer",
@@ -21,17 +21,17 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "5.2.0",
23
23
  "@aws-crypto/sha256-js": "5.2.0",
24
- "@aws-sdk/core": "^3.974.5",
25
- "@aws-sdk/credential-provider-node": "^3.972.36",
24
+ "@aws-sdk/core": "^3.974.7",
25
+ "@aws-sdk/credential-provider-node": "^3.972.38",
26
26
  "@aws-sdk/middleware-host-header": "^3.972.10",
27
27
  "@aws-sdk/middleware-logger": "^3.972.10",
28
28
  "@aws-sdk/middleware-recursion-detection": "^3.972.11",
29
- "@aws-sdk/middleware-user-agent": "^3.972.35",
29
+ "@aws-sdk/middleware-user-agent": "^3.972.37",
30
30
  "@aws-sdk/region-config-resolver": "^3.972.13",
31
31
  "@aws-sdk/types": "^3.973.8",
32
32
  "@aws-sdk/util-endpoints": "^3.996.8",
33
33
  "@aws-sdk/util-user-agent-browser": "^3.972.10",
34
- "@aws-sdk/util-user-agent-node": "^3.973.21",
34
+ "@aws-sdk/util-user-agent-node": "^3.973.23",
35
35
  "@smithy/config-resolver": "^4.4.17",
36
36
  "@smithy/core": "^3.23.17",
37
37
  "@smithy/fetch-http-handler": "^5.3.17",
@@ -39,7 +39,7 @@
39
39
  "@smithy/invalid-dependency": "^4.2.14",
40
40
  "@smithy/middleware-content-length": "^4.2.14",
41
41
  "@smithy/middleware-endpoint": "^4.4.32",
42
- "@smithy/middleware-retry": "^4.5.5",
42
+ "@smithy/middleware-retry": "^4.5.7",
43
43
  "@smithy/middleware-serde": "^4.2.20",
44
44
  "@smithy/middleware-stack": "^4.2.14",
45
45
  "@smithy/node-config-provider": "^4.3.14",
@@ -55,9 +55,9 @@
55
55
  "@smithy/util-defaults-mode-node": "^4.2.54",
56
56
  "@smithy/util-endpoints": "^3.4.2",
57
57
  "@smithy/util-middleware": "^4.2.14",
58
- "@smithy/util-retry": "^4.3.4",
58
+ "@smithy/util-retry": "^4.3.6",
59
59
  "@smithy/util-utf8": "^4.2.2",
60
- "@smithy/util-waiter": "^4.2.16",
60
+ "@smithy/util-waiter": "^4.3.0",
61
61
  "tslib": "^2.6.2"
62
62
  },
63
63
  "devDependencies": {