Skip to content

Commit 5816308

Browse files
author
awstools
committed
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.
1 parent 83c36c8 commit 5816308

File tree

76 files changed

+879
-3448
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+879
-3448
lines changed

clients/client-transfer/README.md

+1-10
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,7 @@
66

77
AWS SDK for JavaScript Transfer Client for Node.js, Browser and React Native.
88

9-
<p>Transfer Family is a fully managed service that enables the transfer of files over the File
10-
Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File
11-
Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.
12-
Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3.
13-
Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating
14-
with existing authentication systems, and providing DNS routing with Amazon Route 53 so
15-
nothing changes for your customers and partners, or their applications. With your data in
16-
Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and
17-
archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and
18-
set up.</p>
9+
<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>
1910

2011
## Installing
2112

clients/client-transfer/src/Transfer.ts

+1-10
Original file line numberDiff line numberDiff line change
@@ -1381,16 +1381,7 @@ export interface Transfer {
13811381
}
13821382

13831383
/**
1384-
* <p>Transfer Family is a fully managed service that enables the transfer of files over the File
1385-
* Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File
1386-
* Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.
1387-
* Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3.
1388-
* Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating
1389-
* with existing authentication systems, and providing DNS routing with Amazon Route 53 so
1390-
* nothing changes for your customers and partners, or their applications. With your data in
1391-
* Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and
1392-
* archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and
1393-
* set up.</p>
1384+
* <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>
13941385
* @public
13951386
*/
13961387
export class Transfer extends TransferClient implements Transfer {}

clients/client-transfer/src/TransferClient.ts

+1-10
Original file line numberDiff line numberDiff line change
@@ -511,16 +511,7 @@ export type TransferClientResolvedConfigType = __SmithyResolvedConfiguration<__H
511511
export interface TransferClientResolvedConfig extends TransferClientResolvedConfigType {}
512512

513513
/**
514-
* <p>Transfer Family is a fully managed service that enables the transfer of files over the File
515-
* Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File
516-
* Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.
517-
* Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3.
518-
* Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating
519-
* with existing authentication systems, and providing DNS routing with Amazon Route 53 so
520-
* nothing changes for your customers and partners, or their applications. With your data in
521-
* Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and
522-
* archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and
523-
* set up.</p>
514+
* <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>
524515
* @public
525516
*/
526517
export class TransferClient extends __Client<

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

+2-8
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,7 @@ export interface CreateAccessCommandInput extends CreateAccessRequest {}
2828
export interface CreateAccessCommandOutput extends CreateAccessResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Used by administrators to choose which groups in the directory should have access to
32-
* upload and download files over the enabled protocols using Transfer Family. For example, a
33-
* Microsoft Active Directory might contain 50,000 users, but only a small fraction might need
34-
* the ability to transfer files to the server. An administrator can use
35-
* <code>CreateAccess</code> to limit the access to the correct set of users who need this
36-
* ability.</p>
31+
* <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>
3732
* @example
3833
* Use a bare-bones client and the command you need to make an API call.
3934
* ```javascript
@@ -87,8 +82,7 @@ export interface CreateAccessCommandOutput extends CreateAccessResponse, __Metad
8782
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
8883
*
8984
* @throws {@link ResourceNotFoundException} (client fault)
90-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
91-
* service.</p>
85+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
9286
*
9387
* @throws {@link ServiceUnavailableException} (server fault)
9488
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>

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

+2-12
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,7 @@ export interface CreateAgreementCommandInput extends CreateAgreementRequest {}
2828
export interface CreateAgreementCommandOutput extends CreateAgreementResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership,
32-
* between an Transfer Family server and an AS2 process. The agreement defines the file and message
33-
* transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family
34-
* combines a server, local profile, partner profile, certificate, and other
35-
* attributes.</p>
36-
* <p>The partner is identified with the <code>PartnerProfileId</code>, and the AS2 process is identified with the <code>LocalProfileId</code>.</p>
37-
* <note>
38-
* <p>Specify <i>either</i>
39-
* <code>BaseDirectory</code> or <code>CustomDirectories</code>, but not both. Specifying both causes the command to fail.</p>
40-
* </note>
31+
* <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>
4132
* @example
4233
* Use a bare-bones client and the command you need to make an API call.
4334
* ```javascript
@@ -92,8 +83,7 @@ export interface CreateAgreementCommandOutput extends CreateAgreementResponse, _
9283
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
9384
*
9485
* @throws {@link ResourceNotFoundException} (client fault)
95-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
96-
* service.</p>
86+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
9787
*
9888
* @throws {@link ServiceUnavailableException} (server fault)
9989
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>

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

+3-8
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,7 @@ export interface CreateConnectorCommandInput extends CreateConnectorRequest {}
2828
export interface CreateConnectorCommandOutput extends CreateConnectorResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates the connector, which captures the parameters for a connection for the
32-
* 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.
33-
* 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>
34-
* <note>
35-
* <p>You must specify exactly one configuration object: either for AS2 (<code>As2Config</code>) or SFTP (<code>SftpConfig</code>).</p>
36-
* </note>
31+
* <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>
3732
* @example
3833
* Use a bare-bones client and the command you need to make an API call.
3934
* ```javascript
@@ -67,6 +62,7 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
6762
* TrustedHostKeys: [ // SftpConnectorTrustedHostKeyList
6863
* "STRING_VALUE",
6964
* ],
65+
* MaxConcurrentConnections: Number("int"),
7066
* },
7167
* SecurityPolicyName: "STRING_VALUE",
7268
* };
@@ -94,8 +90,7 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
9490
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
9591
*
9692
* @throws {@link ResourceNotFoundException} (client fault)
97-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
98-
* service.</p>
93+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
9994
*
10095
* @throws {@link ServiceUnavailableException} (server fault)
10196
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,7 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
6969
* <p>This exception is thrown when the client submits a malformed request.</p>
7070
*
7171
* @throws {@link ResourceNotFoundException} (client fault)
72-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
73-
* service.</p>
72+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
7473
*
7574
* @throws {@link ServiceUnavailableException} (server fault)
7675
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>

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

+2-6
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,7 @@ export interface CreateServerCommandInput extends CreateServerRequest {}
2828
export interface CreateServerCommandOutput extends CreateServerResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Instantiates an auto-scaling virtual server based on the selected file transfer protocol
32-
* in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work
33-
* with users, use the service-generated <code>ServerId</code> property that is assigned to the
34-
* newly created server.</p>
31+
* <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>
3532
* @example
3633
* Use a bare-bones client and the command you need to make an API call.
3734
* ```javascript
@@ -133,8 +130,7 @@ export interface CreateServerCommandOutput extends CreateServerResponse, __Metad
133130
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
134131
*
135132
* @throws {@link ResourceNotFoundException} (client fault)
136-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
137-
* service.</p>
133+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
138134
*
139135
* @throws {@link ServiceUnavailableException} (server fault)
140136
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>

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

+2-9
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,7 @@ export interface CreateUserCommandInput extends CreateUserRequest {}
2828
export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a user and associates them with an existing file transfer protocol-enabled server.
32-
* You can only create and associate users with servers that have the
33-
* <code>IdentityProviderType</code> set to <code>SERVICE_MANAGED</code>. Using parameters for
34-
* <code>CreateUser</code>, you can specify the user name, set the home directory, store the
35-
* user's public key, and assign the user's Identity and Access Management (IAM)
36-
* role. You can also optionally add a session policy, and assign metadata with tags that can
37-
* be used to group and search for users.</p>
31+
* <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>
3832
* @example
3933
* Use a bare-bones client and the command you need to make an API call.
4034
* ```javascript
@@ -95,8 +89,7 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
9589
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
9690
*
9791
* @throws {@link ResourceNotFoundException} (client fault)
98-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
99-
* service.</p>
92+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
10093
*
10194
* @throws {@link ServiceUnavailableException} (server fault)
10295
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,7 @@ export interface CreateWebAppCommandOutput extends CreateWebAppResponse, __Metad
7878
* <p>This exception is thrown when the client submits a malformed request.</p>
7979
*
8080
* @throws {@link ResourceNotFoundException} (client fault)
81-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
82-
* service.</p>
81+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
8382
*
8483
* @throws {@link ThrottlingException} (client fault)
8584
* <p>The request was denied due to request throttling.</p>

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

+1-4
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,7 @@ export interface CreateWorkflowCommandInput extends CreateWorkflowRequest {}
2828
export interface CreateWorkflowCommandOutput extends CreateWorkflowResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>
32-
* Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
33-
* After creating a workflow, you can associate the workflow created with any transfer servers by specifying the <code>workflow-details</code> field in <code>CreateServer</code> and <code>UpdateServer</code> operations.
34-
* </p>
31+
* <p> Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the <code>workflow-details</code> field in <code>CreateServer</code> and <code>UpdateServer</code> operations. </p>
3532
* @example
3633
* Use a bare-bones client and the command you need to make an API call.
3734
* ```javascript

0 commit comments

Comments
 (0)