@aws-sdk/client-transfer 3.784.0 → 3.787.0

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

@@ -27,10 +27,7 @@ declare const DescribeUserCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Describes the user assigned to the specific file transfer protocol-enabled server, as
- *       identified by its <code>ServerId</code> property.</p>
- *          <p>The response from this call returns the properties of the user associated with the
- *         <code>ServerId</code> value that was specified.</p>
+ * <p>Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its <code>ServerId</code> property.</p> <p>The response from this call returns the properties of the user associated with the <code>ServerId</code> value that was specified.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -97,8 +94,7 @@ declare const DescribeUserCommand_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/DescribeWebAppCommand.d.ts

@@ -83,8 +83,7 @@ declare const DescribeWebAppCommand_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 ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>

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

@@ -67,8 +67,7 @@ declare const DescribeWebAppCustomizationCommand_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 ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>

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

@@ -180,8 +180,7 @@ declare const DescribeWorkflowCommand_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/ImportCertificateCommand.d.ts

@@ -27,15 +27,7 @@ declare const ImportCertificateCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Imports the signing and encryption certificates that you need to create local (AS2)
- *       profiles and partner
- *       profiles.</p>
- *          <p>You can import both the certificate and its chain in the <code>Certificate</code>
- *       parameter.</p>
- *          <note>
- *             <p>If you use the <code>Certificate</code> parameter to upload both the certificate and its
- *         chain, don't use the <code>CertificateChain</code> parameter.</p>
- *          </note>
+ * <p>Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.</p> <p>You can import both the certificate and its chain in the <code>Certificate</code> parameter.</p> <note> <p>If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -78,8 +70,7 @@ declare const ImportCertificateCommand_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/ImportHostKeyCommand.d.ts

@@ -27,8 +27,7 @@ declare const ImportHostKeyCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Adds a host key to the server that's specified by the <code>ServerId</code>
- *       parameter.</p>
+ * <p>Adds a host key to the server that's specified by the <code>ServerId</code> parameter.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -71,8 +70,7 @@ declare const ImportHostKeyCommand_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/ImportSshPublicKeyCommand.d.ts

@@ -27,11 +27,7 @@ declare const ImportSshPublicKeyCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a
- *         <code>UserName</code> value assigned to the specific file transfer protocol-enabled server,
- *       identified by <code>ServerId</code>.</p>
- *          <p>The response returns the <code>UserName</code> value, the <code>ServerId</code> value, and
- *       the name of the <code>SshPublicKeyId</code>.</p>
+ * <p>Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a <code>UserName</code> value assigned to the specific file transfer protocol-enabled server, identified by <code>ServerId</code>.</p> <p>The response returns the <code>UserName</code> value, the <code>ServerId</code> value, and the name of the <code>SshPublicKeyId</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -69,8 +65,7 @@ declare const ImportSshPublicKeyCommand_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/ListAccessesCommand.d.ts

@@ -72,8 +72,7 @@ declare const ListAccessesCommand_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/ListAgreementsCommand.d.ts

@@ -27,11 +27,7 @@ declare const ListAgreementsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of the agreements for the server that's identified by the
- *         <code>ServerId</code> that you supply. If you want to limit the results to a certain number,
- *       supply a value for the <code>MaxResults</code> parameter. If you ran the command previously
- *       and received a value for <code>NextToken</code>, you can supply that value to continue listing
- *       agreements from where you left off.</p>
+ * <p>Returns a list of the agreements for the server that's identified by the <code>ServerId</code> that you supply. If you want to limit the results to a certain number, supply a value for the <code>MaxResults</code> parameter. If you ran the command previously and received a value for <code>NextToken</code>, you can supply that value to continue listing agreements from where you left off.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -78,8 +74,7 @@ declare const ListAgreementsCommand_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/ListCertificatesCommand.d.ts

@@ -27,11 +27,7 @@ declare const ListCertificatesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of the current certificates that have been imported into Transfer Family. If you want to
- *       limit the results to a certain number, supply a value for the <code>MaxResults</code>
- *       parameter. If you ran the command previously and received a value for the
- *         <code>NextToken</code> parameter, you can supply that value to continue listing certificates
- *       from where you left off.</p>
+ * <p>Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the <code>MaxResults</code> parameter. If you ran the command previously and received a value for the <code>NextToken</code> parameter, you can supply that value to continue listing certificates from where you left off.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -78,8 +74,7 @@ declare const ListCertificatesCommand_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/ListConnectorsCommand.d.ts

@@ -69,8 +69,7 @@ declare const ListConnectorsCommand_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/ListExecutionsCommand.d.ts

@@ -27,11 +27,7 @@ declare const ListExecutionsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Lists all in-progress executions for the specified workflow.</p>
- *          <note>
- *             <p>If the specified workflow ID cannot be found, <code>ListExecutions</code> returns a
- *         <code>ResourceNotFound</code> exception.</p>
- *          </note>
+ * <p>Lists all in-progress executions for the specified workflow.</p> <note> <p>If the specified workflow ID cannot be found, <code>ListExecutions</code> returns a <code>ResourceNotFound</code> exception.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -93,8 +89,7 @@ declare const ListExecutionsCommand_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/ListFileTransferResultsCommand.d.ts

@@ -27,12 +27,7 @@ declare const ListFileTransferResultsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>
- *       Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation.
- *       You specify the file transfer by providing its <code>ConnectorId</code> and its <code>TransferId</code>.</p>
- *          <note>
- *             <p>File transfer results are available up to 7 days after an operation has been requested.</p>
- *          </note>
+ * <p> Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its <code>ConnectorId</code> and its <code>TransferId</code>.</p> <note> <p>File transfer results are available up to 7 days after an operation has been requested.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -74,8 +69,7 @@ declare const ListFileTransferResultsCommand_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/ListHostKeysCommand.d.ts

@@ -27,8 +27,7 @@ declare const ListHostKeysCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of host keys for the server that's specified by the <code>ServerId</code>
- *       parameter.</p>
+ * <p>Returns a list of host keys for the server that's specified by 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 ListHostKeysCommand_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/ListProfilesCommand.d.ts

@@ -27,10 +27,7 @@ declare const ListProfilesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of the profiles for your system. If you want to limit the results to a
- *       certain number, supply a value for the <code>MaxResults</code> parameter. If you ran the
- *       command previously and received a value for <code>NextToken</code>, you can supply that value
- *       to continue listing profiles from where you left off.</p>
+ * <p>Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the <code>MaxResults</code> parameter. If you ran the command previously and received a value for <code>NextToken</code>, you can supply that value to continue listing profiles from where you left off.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -74,8 +71,7 @@ declare const ListProfilesCommand_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/ListSecurityPoliciesCommand.d.ts

@@ -27,10 +27,7 @@ declare const ListSecurityPoliciesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Lists the security policies that are attached to your servers and SFTP connectors. For more information
- *       about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security
- *         policies for servers</a> or <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html">Working with security
- *           policies for SFTP connectors</a>.</p>
+ * <p>Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security policies for servers</a> or <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html">Working with security policies for SFTP connectors</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,8 +27,7 @@ declare const ListServersCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services
- *       account.</p>
+ * <p>Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -59,8 +59,7 @@ declare const StartRemoteDeleteCommand_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/StartRemoteMoveCommand.d.ts

@@ -60,8 +60,7 @@ declare const StartRemoteMoveCommand_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/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>