@aws-sdk/client-transfer 3.185.0 → 3.188.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/dist-cjs/protocols/Aws_json1_1.js +24 -0
  3. package/dist-es/Transfer.js +234 -241
  4. package/dist-es/TransferClient.js +22 -28
  5. package/dist-es/commands/CreateAccessCommand.js +21 -28
  6. package/dist-es/commands/CreateAgreementCommand.js +21 -28
  7. package/dist-es/commands/CreateConnectorCommand.js +21 -28
  8. package/dist-es/commands/CreateProfileCommand.js +21 -28
  9. package/dist-es/commands/CreateServerCommand.js +21 -28
  10. package/dist-es/commands/CreateUserCommand.js +21 -28
  11. package/dist-es/commands/CreateWorkflowCommand.js +21 -28
  12. package/dist-es/commands/DeleteAccessCommand.js +22 -29
  13. package/dist-es/commands/DeleteAgreementCommand.js +22 -29
  14. package/dist-es/commands/DeleteCertificateCommand.js +22 -29
  15. package/dist-es/commands/DeleteConnectorCommand.js +22 -29
  16. package/dist-es/commands/DeleteHostKeyCommand.js +22 -29
  17. package/dist-es/commands/DeleteProfileCommand.js +22 -29
  18. package/dist-es/commands/DeleteServerCommand.js +22 -29
  19. package/dist-es/commands/DeleteSshPublicKeyCommand.js +22 -29
  20. package/dist-es/commands/DeleteUserCommand.js +22 -29
  21. package/dist-es/commands/DeleteWorkflowCommand.js +22 -29
  22. package/dist-es/commands/DescribeAccessCommand.js +21 -28
  23. package/dist-es/commands/DescribeAgreementCommand.js +21 -28
  24. package/dist-es/commands/DescribeCertificateCommand.js +21 -28
  25. package/dist-es/commands/DescribeConnectorCommand.js +21 -28
  26. package/dist-es/commands/DescribeExecutionCommand.js +21 -28
  27. package/dist-es/commands/DescribeHostKeyCommand.js +21 -28
  28. package/dist-es/commands/DescribeProfileCommand.js +21 -28
  29. package/dist-es/commands/DescribeSecurityPolicyCommand.js +21 -28
  30. package/dist-es/commands/DescribeServerCommand.js +21 -28
  31. package/dist-es/commands/DescribeUserCommand.js +21 -28
  32. package/dist-es/commands/DescribeWorkflowCommand.js +21 -28
  33. package/dist-es/commands/ImportCertificateCommand.js +21 -28
  34. package/dist-es/commands/ImportHostKeyCommand.js +21 -28
  35. package/dist-es/commands/ImportSshPublicKeyCommand.js +21 -28
  36. package/dist-es/commands/ListAccessesCommand.js +21 -28
  37. package/dist-es/commands/ListAgreementsCommand.js +21 -28
  38. package/dist-es/commands/ListCertificatesCommand.js +21 -28
  39. package/dist-es/commands/ListConnectorsCommand.js +21 -28
  40. package/dist-es/commands/ListExecutionsCommand.js +21 -28
  41. package/dist-es/commands/ListHostKeysCommand.js +21 -28
  42. package/dist-es/commands/ListProfilesCommand.js +21 -28
  43. package/dist-es/commands/ListSecurityPoliciesCommand.js +21 -28
  44. package/dist-es/commands/ListServersCommand.js +21 -28
  45. package/dist-es/commands/ListTagsForResourceCommand.js +21 -28
  46. package/dist-es/commands/ListUsersCommand.js +21 -28
  47. package/dist-es/commands/ListWorkflowsCommand.js +21 -28
  48. package/dist-es/commands/SendWorkflowStepStateCommand.js +21 -28
  49. package/dist-es/commands/StartFileTransferCommand.js +21 -28
  50. package/dist-es/commands/StartServerCommand.js +22 -29
  51. package/dist-es/commands/StopServerCommand.js +22 -29
  52. package/dist-es/commands/TagResourceCommand.js +22 -29
  53. package/dist-es/commands/TestIdentityProviderCommand.js +21 -28
  54. package/dist-es/commands/UntagResourceCommand.js +22 -29
  55. package/dist-es/commands/UpdateAccessCommand.js +21 -28
  56. package/dist-es/commands/UpdateAgreementCommand.js +21 -28
  57. package/dist-es/commands/UpdateCertificateCommand.js +21 -28
  58. package/dist-es/commands/UpdateConnectorCommand.js +21 -28
  59. package/dist-es/commands/UpdateHostKeyCommand.js +21 -28
  60. package/dist-es/commands/UpdateProfileCommand.js +21 -28
  61. package/dist-es/commands/UpdateServerCommand.js +21 -28
  62. package/dist-es/commands/UpdateUserCommand.js +21 -28
  63. package/dist-es/endpoints.js +8 -8
  64. package/dist-es/models/TransferServiceException.js +5 -10
  65. package/dist-es/models/models_0.js +572 -263
  66. package/dist-es/pagination/ListAccessesPaginator.js +25 -68
  67. package/dist-es/pagination/ListAgreementsPaginator.js +25 -68
  68. package/dist-es/pagination/ListCertificatesPaginator.js +25 -68
  69. package/dist-es/pagination/ListConnectorsPaginator.js +25 -68
  70. package/dist-es/pagination/ListExecutionsPaginator.js +25 -68
  71. package/dist-es/pagination/ListProfilesPaginator.js +25 -68
  72. package/dist-es/pagination/ListSecurityPoliciesPaginator.js +25 -68
  73. package/dist-es/pagination/ListServersPaginator.js +25 -68
  74. package/dist-es/pagination/ListTagsForResourcePaginator.js +25 -68
  75. package/dist-es/pagination/ListUsersPaginator.js +25 -68
  76. package/dist-es/pagination/ListWorkflowsPaginator.js +25 -68
  77. package/dist-es/protocols/Aws_json1_1.js +3985 -5067
  78. package/dist-es/runtimeConfig.browser.js +26 -12
  79. package/dist-es/runtimeConfig.js +30 -12
  80. package/dist-es/runtimeConfig.native.js +8 -5
  81. package/dist-es/runtimeConfig.shared.js +8 -11
  82. package/dist-es/waiters/waitForServerOffline.js +36 -56
  83. package/dist-es/waiters/waitForServerOnline.js +36 -56
  84. package/dist-types/Transfer.d.ts +10 -8
  85. package/dist-types/commands/CreateConnectorCommand.d.ts +2 -2
  86. package/dist-types/commands/CreateProfileCommand.d.ts +1 -2
  87. package/dist-types/commands/ImportHostKeyCommand.d.ts +2 -1
  88. package/dist-types/commands/ListHostKeysCommand.d.ts +2 -1
  89. package/dist-types/commands/StartFileTransferCommand.d.ts +1 -1
  90. package/dist-types/commands/UpdateHostKeyCommand.d.ts +2 -1
  91. package/dist-types/models/models_0.d.ts +118 -67
  92. package/dist-types/ts3.4/models/models_0.d.ts +2 -1
  93. package/package.json +34 -34
@@ -134,7 +134,7 @@ export declare class ConflictException extends __BaseException {
134
134
  */
135
135
  export interface EfsFileLocation {
136
136
  /**
137
- * <p>The ID of the file system, assigned by Amazon EFS.</p>
137
+ * <p>The identifier of the file system, assigned by Amazon EFS.</p>
138
138
  */
139
139
  FileSystemId?: string;
140
140
  /**
@@ -351,12 +351,12 @@ export interface CreateAccessRequest {
351
351
  }
352
352
  export interface CreateAccessResponse {
353
353
  /**
354
- * <p>The ID of the server that the user is attached to.</p>
354
+ * <p>The identifier of the server that the user is attached to.</p>
355
355
  */
356
356
  ServerId: string | undefined;
357
357
  /**
358
- * <p>The external ID of the group whose users have access to your Amazon S3 or Amazon EFS
359
- * resources over the enabled protocols using Transfer Family.</p>
358
+ * <p>The external identifier of the group whose users have access to your Amazon S3 or Amazon
359
+ * EFS resources over the enabled protocols using Transfer Family.</p>
360
360
  */
361
361
  ExternalId: string | undefined;
362
362
  }
@@ -463,8 +463,7 @@ export interface CreateAgreementRequest {
463
463
  /**
464
464
  * <p>The landing directory (folder) for files transferred by using the AS2 protocol.</p>
465
465
  * <p>A <code>BaseDirectory</code> example is
466
- * <code>/<i>DOC-EXAMPLE-BUCKET</i>/<i>home</i>/<i>mydirectory</i>
467
- * </code>.</p>
466
+ * <i>DOC-EXAMPLE-BUCKET</i>/<i>home</i>/<i>mydirectory</i>.</p>
468
467
  */
469
468
  BaseDirectory: string | undefined;
470
469
  /**
@@ -550,8 +549,15 @@ export interface CreateProfileRequest {
550
549
  */
551
550
  As2Id: string | undefined;
552
551
  /**
553
- * <p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles.
554
- * If not supplied in the request, the command lists all types of profiles.</p>
552
+ * <p>Determines the type of profile to create:</p>
553
+ * <ul>
554
+ * <li>
555
+ * <p>Specify <code>LOCAL</code> to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.</p>
556
+ * </li>
557
+ * <li>
558
+ * <p>Specify <code>PARTNER</code> to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.</p>
559
+ * </li>
560
+ * </ul>
555
561
  */
556
562
  ProfileType: ProfileType | string | undefined;
557
563
  /**
@@ -613,7 +619,7 @@ export interface EndpointDetails {
613
619
  */
614
620
  SubnetIds?: string[];
615
621
  /**
616
- * <p>The ID of the VPC endpoint.</p>
622
+ * <p>The identifier of the VPC endpoint.</p>
617
623
  *
618
624
  * <note>
619
625
  * <p>This property can only be set when <code>EndpointType</code> is set to
@@ -625,7 +631,7 @@ export interface EndpointDetails {
625
631
  */
626
632
  VpcEndpointId?: string;
627
633
  /**
628
- * <p>The VPC ID of the VPC in which a server's endpoint will be hosted.</p>
634
+ * <p>The VPC identifier of the VPC in which a server's endpoint will be hosted.</p>
629
635
  *
630
636
  * <note>
631
637
  * <p>This property can only be set when <code>EndpointType</code> is set to
@@ -706,18 +712,25 @@ export interface ProtocolDetails {
706
712
  * For example:
707
713
  * </p>
708
714
  * <p>
709
- * <code>
710
- * aws transfer update-server --protocol-details PassiveIp=<i>0.0.0.0</i>
711
- * </code>
715
+ * <code>aws transfer update-server --protocol-details PassiveIp=0.0.0.0</code>
712
716
  * </p>
713
- * <p>Replace <code>
714
- * <i>0.0.0.0</i>
715
- * </code> in the example above with the actual IP address you want to use.</p>
717
+ * <p>Replace <code>0.0.0.0</code> in the example above with the actual IP address you want to use.</p>
716
718
  * <note>
717
719
  * <p>
718
720
  * If you change the <code>PassiveIp</code> value, you must stop and then restart your Transfer Family server for the change to take effect. For details on using passive mode (PASV) in a NAT environment, see <a href="http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/">Configuring your FTPS server behind a firewall or NAT with Transfer Family</a>.
719
721
  * </p>
720
722
  * </note>
723
+ * <p>
724
+ * <i>Special values</i>
725
+ * </p>
726
+ *
727
+ * <p>The <code>AUTO</code> and <code>0.0.0.0</code> are special values for the <code>PassiveIp</code> parameter. The value <code>PassiveIp=AUTO</code>
728
+ * is assigned by default to FTP and FTPS type servers. In this case, the server automatically responds with one of the endpoint IPs within the PASV response.
729
+ * <code>PassiveIp=0.0.0.0</code> has a more unique application for its usage. For example, if you have a High Availability (HA) Network Load Balancer (NLB) environment,
730
+ * where you have 3 subnets, you can only specify a single IP address using the <code>PassiveIp</code> parameter. This reduces the effectiveness of having High Availability.
731
+ * In this case, you can specify <code>PassiveIp=0.0.0.0</code>. This tells the client to use the same IP address as the Control connection and utilize all AZs for their
732
+ * connections. Note, however, that not all FTP clients support the <code>PassiveIp=0.0.0.0</code> response. FileZilla and WinSCP do support it. If you are using other
733
+ * clients, check to see if your client supports the <code>PassiveIp=0.0.0.0</code> response.</p>
721
734
  */
722
735
  PassiveIp?: string;
723
736
  /**
@@ -776,6 +789,9 @@ export declare enum Protocol {
776
789
  }
777
790
  /**
778
791
  * <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
792
+ * <p>In additon to a workflow to execute when a file is uploaded completely, <code>WorkflowDeatails</code> can also contain a
793
+ * workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when
794
+ * the session disconnects.</p>
779
795
  */
780
796
  export interface WorkflowDetail {
781
797
  /**
@@ -800,7 +816,13 @@ export interface WorkflowDetails {
800
816
  * <code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'</code>
801
817
  * </p>
802
818
  */
803
- OnUpload: WorkflowDetail[] | undefined;
819
+ OnUpload?: WorkflowDetail[];
820
+ /**
821
+ * <p>A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server
822
+ * that executes whenever there is a partial upload.</p>
823
+ * <p>A <i>partial upload</i> occurs when a file is open when the session disconnects.</p>
824
+ */
825
+ OnPartialUpload?: WorkflowDetail[];
804
826
  }
805
827
  export interface CreateServerRequest {
806
828
  /**
@@ -885,7 +907,8 @@ export interface CreateServerRequest {
885
907
  */
886
908
  EndpointType?: EndpointType | string;
887
909
  /**
888
- * <p>The RSA, ECDSA, or ED25519 private key to use for your server.</p>
910
+ * <p>The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want
911
+ * to rotate keys, or have a set of active keys that use different algorithms.</p>
889
912
  *
890
913
  * <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
891
914
  * <p>
@@ -911,7 +934,7 @@ export interface CreateServerRequest {
911
934
  *
912
935
  *
913
936
  *
914
- * <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change the host key for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>
937
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Update host keys for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>
915
938
  */
916
939
  HostKey?: string;
917
940
  /**
@@ -1053,12 +1076,15 @@ export interface CreateServerRequest {
1053
1076
  Tags?: Tag[];
1054
1077
  /**
1055
1078
  * <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
1079
+ * <p>In additon to a workflow to execute when a file is uploaded completely, <code>WorkflowDeatails</code> can also contain a
1080
+ * workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when
1081
+ * the session disconnects.</p>
1056
1082
  */
1057
1083
  WorkflowDetails?: WorkflowDetails;
1058
1084
  }
1059
1085
  export interface CreateServerResponse {
1060
1086
  /**
1061
- * <p>The service-assigned ID of the server that is created.</p>
1087
+ * <p>The service-assigned identifier of the server that is created.</p>
1062
1088
  */
1063
1089
  ServerId: string | undefined;
1064
1090
  }
@@ -1178,7 +1204,7 @@ export interface CreateUserRequest {
1178
1204
  }
1179
1205
  export interface CreateUserResponse {
1180
1206
  /**
1181
- * <p>The ID of the server that the user is attached to.</p>
1207
+ * <p>The identifier of the server that the user is attached to.</p>
1182
1208
  */
1183
1209
  ServerId: string | undefined;
1184
1210
  /**
@@ -1444,13 +1470,13 @@ export interface DeleteAgreementRequest {
1444
1470
  */
1445
1471
  AgreementId: string | undefined;
1446
1472
  /**
1447
- * <p>The server ID associated with the agreement that you are deleting.</p>
1473
+ * <p>The server identifier associated with the agreement that you are deleting.</p>
1448
1474
  */
1449
1475
  ServerId: string | undefined;
1450
1476
  }
1451
1477
  export interface DeleteCertificateRequest {
1452
1478
  /**
1453
- * <p>The ID of the certificate object that you are deleting.</p>
1479
+ * <p>The identifier of the certificate object that you are deleting.</p>
1454
1480
  */
1455
1481
  CertificateId: string | undefined;
1456
1482
  }
@@ -1462,17 +1488,17 @@ export interface DeleteConnectorRequest {
1462
1488
  }
1463
1489
  export interface DeleteHostKeyRequest {
1464
1490
  /**
1465
- * <p>Provide the ID of the server that contains the host key that you are deleting.</p>
1491
+ * <p>The identifier of the server that contains the host key that you are deleting.</p>
1466
1492
  */
1467
1493
  ServerId: string | undefined;
1468
1494
  /**
1469
- * <p>The ID of the host key that you are deleting.</p>
1495
+ * <p>The identifier of the host key that you are deleting.</p>
1470
1496
  */
1471
1497
  HostKeyId: string | undefined;
1472
1498
  }
1473
1499
  export interface DeleteProfileRequest {
1474
1500
  /**
1475
- * <p>The ID of the profile that you are deleting.</p>
1501
+ * <p>The identifier of the profile that you are deleting.</p>
1476
1502
  */
1477
1503
  ProfileId: string | undefined;
1478
1504
  }
@@ -1612,7 +1638,7 @@ export interface DescribeAccessResponse {
1612
1638
  */
1613
1639
  ServerId: string | undefined;
1614
1640
  /**
1615
- * <p>The external ID of the server that the access is attached to.</p>
1641
+ * <p>The external identifier of the server that the access is attached to.</p>
1616
1642
  */
1617
1643
  Access: DescribedAccess | undefined;
1618
1644
  }
@@ -1622,7 +1648,7 @@ export interface DescribeAgreementRequest {
1622
1648
  */
1623
1649
  AgreementId: string | undefined;
1624
1650
  /**
1625
- * <p>The server ID that's associated with the agreement.</p>
1651
+ * <p>The server identifier that's associated with the agreement.</p>
1626
1652
  */
1627
1653
  ServerId: string | undefined;
1628
1654
  }
@@ -1854,7 +1880,7 @@ export interface FileLocation {
1854
1880
  */
1855
1881
  S3FileLocation?: S3FileLocation;
1856
1882
  /**
1857
- * <p>Specifies the Amazon EFS ID and the path for the file being used.</p>
1883
+ * <p>Specifies the Amazon EFS identifier and the path for the file being used.</p>
1858
1884
  */
1859
1885
  EfsFileLocation?: EfsFileLocation;
1860
1886
  }
@@ -2085,24 +2111,33 @@ export interface DescribedHostKey {
2085
2111
  */
2086
2112
  Description?: string;
2087
2113
  /**
2088
- * <p>The encryption algorithm used for the host key. The <code>Type</code> is one of the
2114
+ * <p>The encryption algorithm that is used for the host key. The <code>Type</code> parameter is specified by using one of the
2089
2115
  * following values:</p>
2090
2116
  * <ul>
2091
2117
  * <li>
2092
- * <p>ssh-rsa</p>
2118
+ * <p>
2119
+ * <code>ssh-rsa</code>
2120
+ * </p>
2093
2121
  * </li>
2094
2122
  * <li>
2095
- * <p>ssh-ed25519</p>
2123
+ * <p>
2124
+ * <code>ssh-ed25519</code>
2125
+ * </p>
2096
2126
  * </li>
2097
2127
  * <li>
2098
- * <p>ecdsa-sha2-nistp256
2099
- * </p>
2128
+ * <p>
2129
+ * <code>ecdsa-sha2-nistp256</code>
2130
+ * </p>
2100
2131
  * </li>
2101
2132
  * <li>
2102
- * <p>ecdsa-sha2-nistp384</p>
2133
+ * <p>
2134
+ * <code>ecdsa-sha2-nistp384</code>
2135
+ * </p>
2103
2136
  * </li>
2104
2137
  * <li>
2105
- * <p>ecdsa-sha2-nistp521</p>
2138
+ * <p>
2139
+ * <code>ecdsa-sha2-nistp521</code>
2140
+ * </p>
2106
2141
  * </li>
2107
2142
  * </ul>
2108
2143
  */
@@ -2117,8 +2152,7 @@ export interface DescribedHostKey {
2117
2152
  Tags?: Tag[];
2118
2153
  }
2119
2154
  /**
2120
- * <p>The details for a local or partner AS2 profile.
2121
- * profile.</p>
2155
+ * <p>The details for a local or partner AS2 profile. </p>
2122
2156
  */
2123
2157
  export interface DescribedProfile {
2124
2158
  /**
@@ -2390,6 +2424,9 @@ export interface DescribedServer {
2390
2424
  UserCount?: number;
2391
2425
  /**
2392
2426
  * <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
2427
+ * <p>In additon to a workflow to execute when a file is uploaded completely, <code>WorkflowDeatails</code> can also contain a
2428
+ * workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when
2429
+ * the session disconnects.</p>
2393
2430
  */
2394
2431
  WorkflowDetails?: WorkflowDetails;
2395
2432
  }
@@ -2544,11 +2581,11 @@ export interface DescribeExecutionResponse {
2544
2581
  }
2545
2582
  export interface DescribeHostKeyRequest {
2546
2583
  /**
2547
- * <p>Provide the ID of the server that contains the host key that you want described.</p>
2584
+ * <p>The identifier of the server that contains the host key that you want described.</p>
2548
2585
  */
2549
2586
  ServerId: string | undefined;
2550
2587
  /**
2551
- * <p>Provide the ID of the host key that you want described.</p>
2588
+ * <p>The identifier of the host key that you want described.</p>
2552
2589
  */
2553
2590
  HostKeyId: string | undefined;
2554
2591
  }
@@ -2672,7 +2709,7 @@ export interface ImportCertificateResponse {
2672
2709
  }
2673
2710
  export interface ImportHostKeyRequest {
2674
2711
  /**
2675
- * <p>Provide the ID of the server that contains the host key that you are importing.</p>
2712
+ * <p>The identifier of the server that contains the host key that you are importing.</p>
2676
2713
  */
2677
2714
  ServerId: string | undefined;
2678
2715
  /**
@@ -2681,7 +2718,7 @@ export interface ImportHostKeyRequest {
2681
2718
  */
2682
2719
  HostKeyBody: string | undefined;
2683
2720
  /**
2684
- * <p>Enter a text description to identify this host key.</p>
2721
+ * <p>The text description that identifies this host key.</p>
2685
2722
  */
2686
2723
  Description?: string;
2687
2724
  /**
@@ -2691,11 +2728,11 @@ export interface ImportHostKeyRequest {
2691
2728
  }
2692
2729
  export interface ImportHostKeyResponse {
2693
2730
  /**
2694
- * <p>Returns the server ID that contains the imported key.</p>
2731
+ * <p>Returns the server identifier that contains the imported key.</p>
2695
2732
  */
2696
2733
  ServerId: string | undefined;
2697
2734
  /**
2698
- * <p>Returns the host key ID for the imported key.</p>
2735
+ * <p>Returns the host key identifier for the imported key.</p>
2699
2736
  */
2700
2737
  HostKeyId: string | undefined;
2701
2738
  }
@@ -3012,15 +3049,15 @@ export interface ListedExecution {
3012
3049
  Status?: ExecutionStatus | string;
3013
3050
  }
3014
3051
  /**
3015
- * <p>Returns properties of the host key that is specified.</p>
3052
+ * <p>Returns properties of the host key that's specified.</p>
3016
3053
  */
3017
3054
  export interface ListedHostKey {
3018
3055
  /**
3019
- * <p>Specifies the unique Amazon Resource Name (ARN) of the host key.</p>
3056
+ * <p>The unique Amazon Resource Name (ARN) of the host key.</p>
3020
3057
  */
3021
3058
  Arn: string | undefined;
3022
3059
  /**
3023
- * <p></p>
3060
+ * <p>A unique identifier for the host key.</p>
3024
3061
  */
3025
3062
  HostKeyId?: string;
3026
3063
  /**
@@ -3032,24 +3069,33 @@ export interface ListedHostKey {
3032
3069
  */
3033
3070
  Description?: string;
3034
3071
  /**
3035
- * <p>The encryption algorithm used for the host key. The <code>Type</code> is one of the
3072
+ * <p>The encryption algorithm that is used for the host key. The <code>Type</code> parameter is specified by using one of the
3036
3073
  * following values:</p>
3037
3074
  * <ul>
3038
3075
  * <li>
3039
- * <p>ssh-rsa</p>
3076
+ * <p>
3077
+ * <code>ssh-rsa</code>
3078
+ * </p>
3040
3079
  * </li>
3041
3080
  * <li>
3042
- * <p>ssh-ed25519</p>
3081
+ * <p>
3082
+ * <code>ssh-ed25519</code>
3083
+ * </p>
3043
3084
  * </li>
3044
3085
  * <li>
3045
- * <p>ecdsa-sha2-nistp256
3046
- * </p>
3086
+ * <p>
3087
+ * <code>ecdsa-sha2-nistp256</code>
3088
+ * </p>
3047
3089
  * </li>
3048
3090
  * <li>
3049
- * <p>ecdsa-sha2-nistp384</p>
3091
+ * <p>
3092
+ * <code>ecdsa-sha2-nistp384</code>
3093
+ * </p>
3050
3094
  * </li>
3051
3095
  * <li>
3052
- * <p>ecdsa-sha2-nistp521</p>
3096
+ * <p>
3097
+ * <code>ecdsa-sha2-nistp521</code>
3098
+ * </p>
3053
3099
  * </li>
3054
3100
  * </ul>
3055
3101
  */
@@ -3192,7 +3238,8 @@ export interface ListedUser {
3192
3238
  UserName?: string;
3193
3239
  }
3194
3240
  /**
3195
- * <p>Contains the ID, text description, and Amazon Resource Name (ARN) for the workflow.</p>
3241
+ * <p>Contains the identifier, text description, and Amazon Resource Name (ARN) for the
3242
+ * workflow.</p>
3196
3243
  */
3197
3244
  export interface ListedWorkflow {
3198
3245
  /**
@@ -3294,7 +3341,7 @@ export interface ListHostKeysRequest {
3294
3341
  */
3295
3342
  NextToken?: string;
3296
3343
  /**
3297
- * <p>Provide the ID of the server that contains the host keys that you want to view.</p>
3344
+ * <p>The identifier of the server that contains the host keys that you want to view.</p>
3298
3345
  */
3299
3346
  ServerId: string | undefined;
3300
3347
  }
@@ -3305,7 +3352,7 @@ export interface ListHostKeysResponse {
3305
3352
  */
3306
3353
  NextToken?: string;
3307
3354
  /**
3308
- * <p>Returns the server ID that contains the listed host keys.</p>
3355
+ * <p>Returns the server identifier that contains the listed host keys.</p>
3309
3356
  */
3310
3357
  ServerId: string | undefined;
3311
3358
  /**
@@ -3715,12 +3762,12 @@ export interface UpdateAccessRequest {
3715
3762
  }
3716
3763
  export interface UpdateAccessResponse {
3717
3764
  /**
3718
- * <p>The ID of the server that the user is attached to.</p>
3765
+ * <p>The identifier of the server that the user is attached to.</p>
3719
3766
  */
3720
3767
  ServerId: string | undefined;
3721
3768
  /**
3722
- * <p>The external ID of the group whose users have access to your Amazon S3 or Amazon EFS
3723
- * resources over the enabled protocols using Amazon Web ServicesTransfer Family.</p>
3769
+ * <p>The external identifier of the group whose users have access to your Amazon S3 or Amazon
3770
+ * EFS resources over the enabled protocols using Amazon Web ServicesTransfer Family.</p>
3724
3771
  */
3725
3772
  ExternalId: string | undefined;
3726
3773
  }
@@ -3845,25 +3892,25 @@ export interface UpdateConnectorResponse {
3845
3892
  }
3846
3893
  export interface UpdateHostKeyRequest {
3847
3894
  /**
3848
- * <p>Provide the ID of the server that contains the host key that you are updating.</p>
3895
+ * <p>The identifier of the server that contains the host key that you are updating.</p>
3849
3896
  */
3850
3897
  ServerId: string | undefined;
3851
3898
  /**
3852
- * <p>Provide the ID of the host key that you are updating.</p>
3899
+ * <p>The identifier of the host key that you are updating.</p>
3853
3900
  */
3854
3901
  HostKeyId: string | undefined;
3855
3902
  /**
3856
- * <p>Provide an updated description for the host key.</p>
3903
+ * <p>An updated description for the host key.</p>
3857
3904
  */
3858
3905
  Description: string | undefined;
3859
3906
  }
3860
3907
  export interface UpdateHostKeyResponse {
3861
3908
  /**
3862
- * <p>Returns the server ID for the server that contains the updated host key.</p>
3909
+ * <p>Returns the server identifier for the server that contains the updated host key.</p>
3863
3910
  */
3864
3911
  ServerId: string | undefined;
3865
3912
  /**
3866
- * <p>Returns the host key ID for the updated host key.</p>
3913
+ * <p>Returns the host key identifier for the updated host key.</p>
3867
3914
  */
3868
3915
  HostKeyId: string | undefined;
3869
3916
  }
@@ -3984,7 +4031,8 @@ export interface UpdateServerRequest {
3984
4031
  */
3985
4032
  EndpointType?: EndpointType | string;
3986
4033
  /**
3987
- * <p>The RSA, ECDSA, or ED25519 private key to use for your server.</p>
4034
+ * <p>The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want
4035
+ * to rotate keys, or have a set of active keys that use different algorithms.</p>
3988
4036
  *
3989
4037
  * <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
3990
4038
  * <p>
@@ -4010,7 +4058,7 @@ export interface UpdateServerRequest {
4010
4058
  *
4011
4059
  *
4012
4060
  *
4013
- * <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change the host key for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>
4061
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Update host keys for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>
4014
4062
  */
4015
4063
  HostKey?: string;
4016
4064
  /**
@@ -4106,6 +4154,9 @@ export interface UpdateServerRequest {
4106
4154
  ServerId: string | undefined;
4107
4155
  /**
4108
4156
  * <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
4157
+ * <p>In additon to a workflow to execute when a file is uploaded completely, <code>WorkflowDeatails</code> can also contain a
4158
+ * workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when
4159
+ * the session disconnects.</p>
4109
4160
  * <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p>
4110
4161
  * <p>
4111
4162
  * <code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'</code>
@@ -259,7 +259,8 @@ export interface WorkflowDetail {
259
259
  ExecutionRole: string | undefined;
260
260
  }
261
261
  export interface WorkflowDetails {
262
- OnUpload: WorkflowDetail[] | undefined;
262
+ OnUpload?: WorkflowDetail[];
263
+ OnPartialUpload?: WorkflowDetail[];
263
264
  }
264
265
  export interface CreateServerRequest {
265
266
  Certificate?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-transfer",
3
3
  "description": "AWS SDK for JavaScript Transfer Client for Node.js, Browser and React Native",
4
- "version": "3.185.0",
4
+ "version": "3.188.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -19,42 +19,42 @@
19
19
  "dependencies": {
20
20
  "@aws-crypto/sha256-browser": "2.0.0",
21
21
  "@aws-crypto/sha256-js": "2.0.0",
22
- "@aws-sdk/client-sts": "3.185.0",
23
- "@aws-sdk/config-resolver": "3.183.0",
24
- "@aws-sdk/credential-provider-node": "3.185.0",
25
- "@aws-sdk/fetch-http-handler": "3.183.0",
26
- "@aws-sdk/hash-node": "3.183.0",
27
- "@aws-sdk/invalid-dependency": "3.183.0",
28
- "@aws-sdk/middleware-content-length": "3.183.0",
29
- "@aws-sdk/middleware-host-header": "3.183.0",
30
- "@aws-sdk/middleware-logger": "3.183.0",
31
- "@aws-sdk/middleware-recursion-detection": "3.183.0",
32
- "@aws-sdk/middleware-retry": "3.185.0",
33
- "@aws-sdk/middleware-serde": "3.183.0",
34
- "@aws-sdk/middleware-signing": "3.183.0",
35
- "@aws-sdk/middleware-stack": "3.183.0",
36
- "@aws-sdk/middleware-user-agent": "3.183.0",
37
- "@aws-sdk/node-config-provider": "3.183.0",
38
- "@aws-sdk/node-http-handler": "3.185.0",
39
- "@aws-sdk/protocol-http": "3.183.0",
40
- "@aws-sdk/smithy-client": "3.183.0",
41
- "@aws-sdk/types": "3.183.0",
42
- "@aws-sdk/url-parser": "3.183.0",
43
- "@aws-sdk/util-base64-browser": "3.183.0",
44
- "@aws-sdk/util-base64-node": "3.183.0",
45
- "@aws-sdk/util-body-length-browser": "3.183.0",
46
- "@aws-sdk/util-body-length-node": "3.183.0",
47
- "@aws-sdk/util-defaults-mode-browser": "3.183.0",
48
- "@aws-sdk/util-defaults-mode-node": "3.183.0",
49
- "@aws-sdk/util-user-agent-browser": "3.183.0",
50
- "@aws-sdk/util-user-agent-node": "3.183.0",
51
- "@aws-sdk/util-utf8-browser": "3.183.0",
52
- "@aws-sdk/util-utf8-node": "3.183.0",
53
- "@aws-sdk/util-waiter": "3.183.0",
22
+ "@aws-sdk/client-sts": "3.188.0",
23
+ "@aws-sdk/config-resolver": "3.188.0",
24
+ "@aws-sdk/credential-provider-node": "3.188.0",
25
+ "@aws-sdk/fetch-http-handler": "3.188.0",
26
+ "@aws-sdk/hash-node": "3.188.0",
27
+ "@aws-sdk/invalid-dependency": "3.188.0",
28
+ "@aws-sdk/middleware-content-length": "3.188.0",
29
+ "@aws-sdk/middleware-host-header": "3.188.0",
30
+ "@aws-sdk/middleware-logger": "3.188.0",
31
+ "@aws-sdk/middleware-recursion-detection": "3.188.0",
32
+ "@aws-sdk/middleware-retry": "3.188.0",
33
+ "@aws-sdk/middleware-serde": "3.188.0",
34
+ "@aws-sdk/middleware-signing": "3.188.0",
35
+ "@aws-sdk/middleware-stack": "3.188.0",
36
+ "@aws-sdk/middleware-user-agent": "3.188.0",
37
+ "@aws-sdk/node-config-provider": "3.188.0",
38
+ "@aws-sdk/node-http-handler": "3.188.0",
39
+ "@aws-sdk/protocol-http": "3.188.0",
40
+ "@aws-sdk/smithy-client": "3.188.0",
41
+ "@aws-sdk/types": "3.188.0",
42
+ "@aws-sdk/url-parser": "3.188.0",
43
+ "@aws-sdk/util-base64-browser": "3.188.0",
44
+ "@aws-sdk/util-base64-node": "3.188.0",
45
+ "@aws-sdk/util-body-length-browser": "3.188.0",
46
+ "@aws-sdk/util-body-length-node": "3.188.0",
47
+ "@aws-sdk/util-defaults-mode-browser": "3.188.0",
48
+ "@aws-sdk/util-defaults-mode-node": "3.188.0",
49
+ "@aws-sdk/util-user-agent-browser": "3.188.0",
50
+ "@aws-sdk/util-user-agent-node": "3.188.0",
51
+ "@aws-sdk/util-utf8-browser": "3.188.0",
52
+ "@aws-sdk/util-utf8-node": "3.188.0",
53
+ "@aws-sdk/util-waiter": "3.188.0",
54
54
  "tslib": "^2.3.1"
55
55
  },
56
56
  "devDependencies": {
57
- "@aws-sdk/service-client-documentation-generator": "3.183.0",
57
+ "@aws-sdk/service-client-documentation-generator": "3.188.0",
58
58
  "@tsconfig/recommended": "1.0.1",
59
59
  "@types/node": "^12.7.5",
60
60
  "concurrently": "7.0.0",