feat(client-transfer): This launch includes 2 enhancements to SFTP connectors user-experience: 1) Customers can self-serve concurrent connections setting for their connectors, and 2) Customers can discover the public host key of remote servers using their SFTP connectors.

Author: awstools

clients/client-transfer/README.md

@@ -6,16 +6,7 @@
 
 AWS SDK for JavaScript Transfer Client for Node.js, Browser and React Native.
 
-<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>
+<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>
 
 ## Installing
 

clients/client-transfer/src/Transfer.ts

@@ -1381,16 +1381,7 @@ export interface Transfer {
 }
 
 /**
- * <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>
+ * <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>
  * @public
  */
 export class Transfer extends TransferClient implements Transfer {}

clients/client-transfer/src/TransferClient.ts

@@ -511,16 +511,7 @@ export type TransferClientResolvedConfigType = __SmithyResolvedConfiguration<__H
 export interface TransferClientResolvedConfig extends TransferClientResolvedConfigType {}
 
 /**
- * <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>
+ * <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>
  * @public
  */
 export class TransferClient extends __Client<

clients/client-transfer/src/commands/CreateAccessCommand.ts

@@ -28,12 +28,7 @@ export interface CreateAccessCommandInput extends CreateAccessRequest {}
 export interface CreateAccessCommandOutput extends CreateAccessResponse, __MetadataBearer {}
 
 /**
- * <p>Used by administrators to choose which groups in the directory should have access to
- *       upload and download files over the enabled protocols using Transfer Family. For example, a
- *       Microsoft Active Directory might contain 50,000 users, but only a small fraction might need
- *       the ability to transfer files to the server. An administrator can use
- *         <code>CreateAccess</code> to limit the access to the correct set of users who need this
- *       ability.</p>
+ * <p>Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use <code>CreateAccess</code> to limit the access to the correct set of users who need this ability.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -87,8 +82,7 @@ export interface CreateAccessCommandOutput extends CreateAccessResponse, __Metad
  *  <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>

clients/client-transfer/src/commands/CreateAgreementCommand.ts

@@ -28,16 +28,7 @@ export interface CreateAgreementCommandInput extends CreateAgreementRequest {}
 export interface CreateAgreementCommandOutput extends CreateAgreementResponse, __MetadataBearer {}
 
 /**
- * <p>Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership,
- *       between an Transfer Family server and an AS2 process. The agreement defines the file and message
- *       transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family
- *       combines a server, local profile, partner profile, certificate, and other
- *       attributes.</p>
- *          <p>The partner is identified with the <code>PartnerProfileId</code>, and the AS2 process is identified with the <code>LocalProfileId</code>.</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>
- *          </note>
+ * <p>Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.</p> <p>The partner is identified with the <code>PartnerProfileId</code>, and the AS2 process is identified with the <code>LocalProfileId</code>.</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> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -92,8 +83,7 @@ export interface CreateAgreementCommandOutput extends CreateAgreementResponse, _
  *  <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>

clients/client-transfer/src/commands/CreateConnectorCommand.ts

@@ -28,12 +28,7 @@ export interface CreateConnectorCommandInput extends CreateConnectorRequest {}
 export interface CreateConnectorCommandOutput extends CreateConnectorResponse, __MetadataBearer {}
 
 /**
- * <p>Creates the connector, which captures the parameters for a connection for the
- *       AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server.
- *       For more details about connectors, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/configure-as2-connector.html">Configure AS2 connectors</a> and <a href="https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html">Create SFTP connectors</a>.</p>
- *          <note>
- *             <p>You must specify exactly one configuration object: either for AS2 (<code>As2Config</code>) or SFTP (<code>SftpConfig</code>).</p>
- *          </note>
+ * <p>Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/configure-as2-connector.html">Configure AS2 connectors</a> and <a href="https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html">Create SFTP connectors</a>.</p> <note> <p>You must specify exactly one configuration object: either for AS2 (<code>As2Config</code>) or SFTP (<code>SftpConfig</code>).</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -67,6 +62,7 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
  *     TrustedHostKeys: [ // SftpConnectorTrustedHostKeyList
  *       "STRING_VALUE",
  *     ],
+ *     MaxConcurrentConnections: Number("int"),
  *   },
  *   SecurityPolicyName: "STRING_VALUE",
  * };
@@ -94,8 +90,7 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
  *  <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>

clients/client-transfer/src/commands/CreateProfileCommand.ts

@@ -69,8 +69,7 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
  *  <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>

clients/client-transfer/src/commands/CreateServerCommand.ts

@@ -28,10 +28,7 @@ export interface CreateServerCommandInput extends CreateServerRequest {}
 export interface CreateServerCommandOutput extends CreateServerResponse, __MetadataBearer {}
 
 /**
- * <p>Instantiates an auto-scaling virtual server based on the selected file transfer protocol
- *       in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work
- *       with users, use the service-generated <code>ServerId</code> property that is assigned to the
- *       newly created server.</p>
+ * <p>Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated <code>ServerId</code> property that is assigned to the newly created server.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -133,8 +130,7 @@ export interface CreateServerCommandOutput extends CreateServerResponse, __Metad
  *  <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>

clients/client-transfer/src/commands/CreateUserCommand.ts

@@ -28,13 +28,7 @@ export interface CreateUserCommandInput extends CreateUserRequest {}
 export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a user and associates them with an existing file transfer protocol-enabled server.
- *       You can only create and associate users with servers that have the
- *         <code>IdentityProviderType</code> set to <code>SERVICE_MANAGED</code>. Using parameters for
- *         <code>CreateUser</code>, you can specify the user name, set the home directory, store the
- *       user's public key, and assign the user's Identity and Access Management (IAM)
- *       role. You can also optionally add a session policy, and assign metadata with tags that can
- *       be used to group and search for users.</p>
+ * <p>Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the <code>IdentityProviderType</code> set to <code>SERVICE_MANAGED</code>. Using parameters for <code>CreateUser</code>, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -95,8 +89,7 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
  *  <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>

clients/client-transfer/src/commands/CreateWebAppCommand.ts

@@ -78,8 +78,7 @@ export interface CreateWebAppCommandOutput extends CreateWebAppResponse, __Metad
  *  <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>