@aws-sdk/client-transfer 3.782.0 → 3.786.0

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -27,8 +27,7 @@ declare const ListTagsForResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The
- *       resource can be a user, server, or role.</p>
+ * <p>Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListUsersCommand.d.ts

@@ -27,8 +27,7 @@ declare const ListUsersCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Lists the users for a file transfer protocol-enabled server that you specify by passing
- *       the <code>ServerId</code> parameter.</p>
+ * <p>Lists the users for a file transfer protocol-enabled server that you specify by passing the <code>ServerId</code> parameter.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -75,8 +74,7 @@ declare const ListUsersCommand_base: {
  *  <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>
+ *  <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>

package/dist-types/commands/SendWorkflowStepStateCommand.d.ts

@@ -27,11 +27,7 @@ declare const SendWorkflowStepStateCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Sends a callback for asynchronous custom steps.</p>
- *          <p>
- *       The <code>ExecutionId</code>, <code>WorkflowId</code>, and <code>Token</code> are passed to the target resource during execution of a custom step of a workflow.
- *       You must include those with their callback as well as providing a status.
- *     </p>
+ * <p>Sends a callback for asynchronous custom steps.</p> <p> The <code>ExecutionId</code>, <code>WorkflowId</code>, and <code>Token</code> are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -66,8 +62,7 @@ declare const SendWorkflowStepStateCommand_base: {
  *  <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>
+ *  <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>

package/dist-types/commands/StartDirectoryListingCommand.d.ts

@@ -27,51 +27,7 @@ declare const StartDirectoryListingCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <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>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -106,8 +62,7 @@ declare const StartDirectoryListingCommand_base: {
  *  <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>
+ *  <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>

package/dist-types/commands/StartFileTransferCommand.d.ts

@@ -27,32 +27,7 @@ declare const StartFileTransferCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.</p>
- *          <ul>
- *             <li>
- *                <p>For an AS2 connector, you specify the <code>ConnectorId</code> and one or more <code>SendFilePaths</code> to identify the files
- *           you want to transfer.</p>
- *             </li>
- *             <li>
- *                <p>For an SFTP connector, the file transfer can be either outbound or inbound. In both
- *           cases, you specify the <code>ConnectorId</code>. Depending on the direction of the transfer,
- *           you also specify the following items:</p>
- *                <ul>
- *                   <li>
- *                      <p>If you are transferring file from a partner's SFTP server to Amazon Web Services
- *               storage, you specify one or more <code>RetrieveFilePaths</code> to identify the files
- *               you want to transfer, and a <code>LocalDirectoryPath</code> to specify the destination
- *               folder.</p>
- *                   </li>
- *                   <li>
- *                      <p>If you are transferring file to a partner's SFTP server from Amazon Web Services
- *               storage, you specify one or more <code>SendFilePaths</code> to identify the files you
- *               want to transfer, and a <code>RemoteDirectoryPath</code> to specify the destination
- *               folder.</p>
- *                   </li>
- *                </ul>
- *             </li>
- *          </ul>
+ * <p>Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.</p> <ul> <li> <p>For an AS2 connector, you specify the <code>ConnectorId</code> and one or more <code>SendFilePaths</code> to identify the files you want to transfer.</p> </li> <li> <p>For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the <code>ConnectorId</code>. Depending on the direction of the transfer, you also specify the following items:</p> <ul> <li> <p>If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more <code>RetrieveFilePaths</code> to identify the files you want to transfer, and a <code>LocalDirectoryPath</code> to specify the destination folder.</p> </li> <li> <p>If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more <code>SendFilePaths</code> to identify the files you want to transfer, and a <code>RemoteDirectoryPath</code> to specify the destination folder.</p> </li> </ul> </li> </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -91,8 +66,7 @@ declare const StartFileTransferCommand_base: {
  *  <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>
+ *  <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>

package/dist-types/commands/StartRemoteDeleteCommand.d.ts

@@ -0,0 +1,88 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { StartRemoteDeleteRequest, StartRemoteDeleteResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartRemoteDeleteCommand}.
+ */
+export interface StartRemoteDeleteCommandInput extends StartRemoteDeleteRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartRemoteDeleteCommand}.
+ */
+export interface StartRemoteDeleteCommandOutput extends StartRemoteDeleteResponse, __MetadataBearer {
+}
+declare const StartRemoteDeleteCommand_base: {
+    new (input: StartRemoteDeleteCommandInput): import("@smithy/smithy-client").CommandImpl<StartRemoteDeleteCommandInput, StartRemoteDeleteCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: StartRemoteDeleteCommandInput): import("@smithy/smithy-client").CommandImpl<StartRemoteDeleteCommandInput, StartRemoteDeleteCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Deletes a file or directory on the remote SFTP server.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TransferClient, StartRemoteDeleteCommand } from "@aws-sdk/client-transfer"; // ES Modules import
+ * // const { TransferClient, StartRemoteDeleteCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
+ * const client = new TransferClient(config);
+ * const input = { // StartRemoteDeleteRequest
+ *   ConnectorId: "STRING_VALUE", // required
+ *   DeletePath: "STRING_VALUE", // required
+ * };
+ * const command = new StartRemoteDeleteCommand(input);
+ * const response = await client.send(command);
+ * // { // StartRemoteDeleteResponse
+ * //   DeleteId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param StartRemoteDeleteCommandInput - {@link StartRemoteDeleteCommandInput}
+ * @returns {@link StartRemoteDeleteCommandOutput}
+ * @see {@link StartRemoteDeleteCommandInput} for command's `input` shape.
+ * @see {@link StartRemoteDeleteCommandOutput} 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 ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
+ *
+ *
+ * @public
+ */
+export declare class StartRemoteDeleteCommand extends StartRemoteDeleteCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartRemoteDeleteRequest;
+            output: StartRemoteDeleteResponse;
+        };
+        sdk: {
+            input: StartRemoteDeleteCommandInput;
+            output: StartRemoteDeleteCommandOutput;
+        };
+    };
+}

package/dist-types/commands/StartRemoteMoveCommand.d.ts

@@ -0,0 +1,89 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { StartRemoteMoveRequest, StartRemoteMoveResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartRemoteMoveCommand}.
+ */
+export interface StartRemoteMoveCommandInput extends StartRemoteMoveRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartRemoteMoveCommand}.
+ */
+export interface StartRemoteMoveCommandOutput extends StartRemoteMoveResponse, __MetadataBearer {
+}
+declare const StartRemoteMoveCommand_base: {
+    new (input: StartRemoteMoveCommandInput): import("@smithy/smithy-client").CommandImpl<StartRemoteMoveCommandInput, StartRemoteMoveCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: StartRemoteMoveCommandInput): import("@smithy/smithy-client").CommandImpl<StartRemoteMoveCommandInput, StartRemoteMoveCommandOutput, TransferClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Moves or renames a file or directory on the remote SFTP server.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TransferClient, StartRemoteMoveCommand } from "@aws-sdk/client-transfer"; // ES Modules import
+ * // const { TransferClient, StartRemoteMoveCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
+ * const client = new TransferClient(config);
+ * const input = { // StartRemoteMoveRequest
+ *   ConnectorId: "STRING_VALUE", // required
+ *   SourcePath: "STRING_VALUE", // required
+ *   TargetPath: "STRING_VALUE", // required
+ * };
+ * const command = new StartRemoteMoveCommand(input);
+ * const response = await client.send(command);
+ * // { // StartRemoteMoveResponse
+ * //   MoveId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param StartRemoteMoveCommandInput - {@link StartRemoteMoveCommandInput}
+ * @returns {@link StartRemoteMoveCommandOutput}
+ * @see {@link StartRemoteMoveCommandInput} for command's `input` shape.
+ * @see {@link StartRemoteMoveCommandOutput} 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 ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
+ *
+ *
+ * @public
+ */
+export declare class StartRemoteMoveCommand extends StartRemoteMoveCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartRemoteMoveRequest;
+            output: StartRemoteMoveResponse;
+        };
+        sdk: {
+            input: StartRemoteMoveCommandInput;
+            output: StartRemoteMoveCommandOutput;
+        };
+    };
+}

package/dist-types/commands/StartServerCommand.d.ts

@@ -27,13 +27,7 @@ declare const StartServerCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Changes the state of a file transfer protocol-enabled server from <code>OFFLINE</code> to
- *         <code>ONLINE</code>. It has no impact on a server that is already <code>ONLINE</code>. An
- *         <code>ONLINE</code> server can accept and process file transfer jobs.</p>
- *          <p>The state of <code>STARTING</code> indicates that the server is in an intermediate state,
- *       either not fully able to respond, or not fully online. The values of <code>START_FAILED</code>
- *       can indicate an error condition.</p>
- *          <p>No response is returned from this call.</p>
+ * <p>Changes the state of a file transfer protocol-enabled server from <code>OFFLINE</code> to <code>ONLINE</code>. It has no impact on a server that is already <code>ONLINE</code>. An <code>ONLINE</code> server can accept and process file transfer jobs.</p> <p>The state of <code>STARTING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of <code>START_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -62,8 +56,7 @@ declare const StartServerCommand_base: {
  *  <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>
+ *  <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>

package/dist-types/commands/StopServerCommand.d.ts

@@ -27,18 +27,7 @@ declare const StopServerCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Changes the state of a file transfer protocol-enabled server from <code>ONLINE</code> to
- *         <code>OFFLINE</code>. An <code>OFFLINE</code> server cannot accept and process file transfer
- *       jobs. Information tied to your server, such as server and user properties, are not affected by
- *       stopping your server.</p>
- *          <note>
- *             <p>Stopping the server does not reduce or impact your file transfer protocol endpoint
- *         billing; you must delete the server to stop being billed.</p>
- *          </note>
- *          <p>The state of <code>STOPPING</code> indicates that the server is in an intermediate state,
- *       either not fully able to respond, or not fully offline. The values of <code>STOP_FAILED</code>
- *       can indicate an error condition.</p>
- *          <p>No response is returned from this call.</p>
+ * <p>Changes the state of a file transfer protocol-enabled server from <code>ONLINE</code> to <code>OFFLINE</code>. An <code>OFFLINE</code> server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.</p> <note> <p>Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.</p> </note> <p>The state of <code>STOPPING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>STOP_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -67,8 +56,7 @@ declare const StopServerCommand_base: {
  *  <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>
+ *  <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>

package/dist-types/commands/TagResourceCommand.d.ts

@@ -27,9 +27,7 @@ declare const TagResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
- *       Resources are users, servers, roles, and other entities.</p>
- *          <p>There is no response returned from this call.</p>
+ * <p>Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.</p> <p>There is no response returned from this call.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -64,8 +62,7 @@ declare const TagResourceCommand_base: {
  *  <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>
+ *  <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>

package/dist-types/commands/TestConnectionCommand.d.ts

@@ -27,9 +27,7 @@ declare const TestConnectionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Tests whether your SFTP connector is set up successfully. We highly recommend that you call this
- *     operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's
- *     SFTP server.</p>
+ * <p>Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's SFTP server.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -45,6 +43,9 @@ declare const TestConnectionCommand_base: {
  * //   ConnectorId: "STRING_VALUE",
  * //   Status: "STRING_VALUE",
  * //   StatusMessage: "STRING_VALUE",
+ * //   SftpConnectionDetails: { // SftpConnectorConnectionDetails
+ * //     HostKey: "STRING_VALUE",
+ * //   },
  * // };
  *
  * ```
@@ -62,8 +63,7 @@ declare const TestConnectionCommand_base: {
  *  <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>
+ *  <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>

package/dist-types/commands/TestIdentityProviderCommand.d.ts

@@ -27,56 +27,7 @@ declare const TestIdentityProviderCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>If the <code>IdentityProviderType</code> of a file transfer protocol-enabled server is
- *         <code>AWS_DIRECTORY_SERVICE</code> or <code>API_Gateway</code>, tests whether your identity
- *       provider is set up successfully. We highly recommend that you call this operation to test your
- *       authentication method as soon as you create your server. By doing so, you can troubleshoot
- *       issues with the identity provider integration to ensure that your users can successfully use
- *       the service.</p>
- *          <p>
- *       The <code>ServerId</code> and <code>UserName</code> parameters are required. The <code>ServerProtocol</code>, <code>SourceIp</code>, and <code>UserPassword</code> are all optional.
- *     </p>
- *          <p>Note the following:</p>
- *          <ul>
- *             <li>
- *                <p> You cannot use <code>TestIdentityProvider</code> if the
- *           <code>IdentityProviderType</code> of your server is <code>SERVICE_MANAGED</code>.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>TestIdentityProvider</code> does not work with keys: it only accepts
- *           passwords.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>TestIdentityProvider</code> can test the password operation for a custom Identity Provider that handles keys and passwords.</p>
- *             </li>
- *             <li>
- *                <p>
- *         If you provide any incorrect values for any parameters, the <code>Response</code> field is empty.
- *       </p>
- *             </li>
- *             <li>
- *                <p>
- *         If you provide a server ID for a server that uses service-managed users, you get an error:
- *       </p>
- *                <p>
- *                   <code>
- *         An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-<i>server-ID</i> not configured for external auth
- *       </code>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *           If you enter a Server ID for the <code>--server-id</code> parameter that does not identify an actual Transfer server, you receive the following error:
- *         </p>
- *                <p>
- *                   <code>An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server</code>.
- *         </p>
- *                <p>It is possible your sever is in a different region. You can specify a region by adding the following: <code>--region region-code</code>,
- *           such as <code>--region us-east-2</code> to specify a server in <b>US East (Ohio)</b>.</p>
- *             </li>
- *          </ul>
+ * <p>If the <code>IdentityProviderType</code> of a file transfer protocol-enabled server is <code>AWS_DIRECTORY_SERVICE</code> or <code>API_Gateway</code>, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.</p> <p> The <code>ServerId</code> and <code>UserName</code> parameters are required. The <code>ServerProtocol</code>, <code>SourceIp</code>, and <code>UserPassword</code> are all optional. </p> <p>Note the following:</p> <ul> <li> <p> You cannot use <code>TestIdentityProvider</code> if the <code>IdentityProviderType</code> of your server is <code>SERVICE_MANAGED</code>.</p> </li> <li> <p> <code>TestIdentityProvider</code> does not work with keys: it only accepts passwords.</p> </li> <li> <p> <code>TestIdentityProvider</code> can test the password operation for a custom Identity Provider that handles keys and passwords.</p> </li> <li> <p> If you provide any incorrect values for any parameters, the <code>Response</code> field is empty. </p> </li> <li> <p> If you provide a server ID for a server that uses service-managed users, you get an error: </p> <p> <code> An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-<i>server-ID</i> not configured for external auth </code> </p> </li> <li> <p> If you enter a Server ID for the <code>--server-id</code> parameter that does not identify an actual Transfer server, you receive the following error: </p> <p> <code>An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server</code>. </p> <p>It is possible your sever is in a different region. You can specify a region by adding the following: <code>--region region-code</code>, such as <code>--region us-east-2</code> to specify a server in <b>US East (Ohio)</b>.</p> </li> </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -114,8 +65,7 @@ declare const TestIdentityProviderCommand_base: {
  *  <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>
+ *  <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>

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -27,9 +27,7 @@ declare const UntagResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Detaches a key-value pair from a resource, as identified by its Amazon Resource Name
- *       (ARN). Resources are users, servers, roles, and other entities.</p>
- *          <p>No response is returned from this call.</p>
+ * <p>Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.</p> <p>No response is returned from this call.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -61,8 +59,7 @@ declare const UntagResourceCommand_base: {
  *  <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>
+ *  <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>

package/dist-types/commands/UpdateAccessCommand.d.ts

@@ -27,8 +27,7 @@ declare const UpdateAccessCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Allows you to update parameters for the access specified in the <code>ServerID</code> and
- *       <code>ExternalID</code> parameters.</p>
+ * <p>Allows you to update parameters for the access specified in the <code>ServerID</code> and <code>ExternalID</code> parameters.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -82,8 +81,7 @@ declare const UpdateAccessCommand_base: {
  *  <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</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>
+ *  <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>

package/dist-types/commands/UpdateAgreementCommand.d.ts

@@ -27,14 +27,7 @@ declare const UpdateAgreementCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates some of the parameters for an existing agreement. Provide the
- *         <code>AgreementId</code> and the <code>ServerId</code> for the agreement that you want to
- *       update, along with the new values for the parameters to update.</p>
- *          <note>
- *             <p>Specify <i>either</i>
- *                <code>BaseDirectory</code> or <code>CustomDirectories</code>, but not both. Specifying both causes the command to fail.</p>
- *             <p>If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.</p>
- *          </note>
+ * <p>Updates some of the parameters for an existing agreement. Provide the <code>AgreementId</code> and the <code>ServerId</code> for the agreement that you want to update, along with the new values for the parameters to update.</p> <note> <p>Specify <i>either</i> <code>BaseDirectory</code> or <code>CustomDirectories</code>, but not both. Specifying both causes the command to fail.</p> <p>If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -84,8 +77,7 @@ declare const UpdateAgreementCommand_base: {
  *  <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</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>
+ *  <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>

package/dist-types/commands/UpdateCertificateCommand.d.ts

@@ -61,8 +61,7 @@ declare const UpdateCertificateCommand_base: {
  *  <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>
+ *  <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>