@aws-sdk/client-transfer 3.782.0 → 3.786.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 (90) hide show
  1. package/README.md +17 -10
  2. package/dist-cjs/index.js +74 -0
  3. package/dist-es/Transfer.js +4 -0
  4. package/dist-es/commands/StartRemoteDeleteCommand.js +22 -0
  5. package/dist-es/commands/StartRemoteMoveCommand.js +22 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/protocols/Aws_json1_1.js +38 -0
  8. package/dist-types/Transfer.d.ts +15 -10
  9. package/dist-types/TransferClient.d.ts +5 -12
  10. package/dist-types/commands/CreateAccessCommand.d.ts +2 -8
  11. package/dist-types/commands/CreateAgreementCommand.d.ts +2 -12
  12. package/dist-types/commands/CreateConnectorCommand.d.ts +3 -8
  13. package/dist-types/commands/CreateProfileCommand.d.ts +1 -2
  14. package/dist-types/commands/CreateServerCommand.d.ts +2 -6
  15. package/dist-types/commands/CreateUserCommand.d.ts +2 -9
  16. package/dist-types/commands/CreateWebAppCommand.d.ts +1 -2
  17. package/dist-types/commands/CreateWorkflowCommand.d.ts +1 -4
  18. package/dist-types/commands/DeleteAccessCommand.d.ts +2 -4
  19. package/dist-types/commands/DeleteAgreementCommand.d.ts +1 -2
  20. package/dist-types/commands/DeleteCertificateCommand.d.ts +2 -4
  21. package/dist-types/commands/DeleteConnectorCommand.d.ts +1 -2
  22. package/dist-types/commands/DeleteHostKeyCommand.d.ts +1 -2
  23. package/dist-types/commands/DeleteProfileCommand.d.ts +1 -2
  24. package/dist-types/commands/DeleteServerCommand.d.ts +2 -4
  25. package/dist-types/commands/DeleteSshPublicKeyCommand.d.ts +1 -2
  26. package/dist-types/commands/DeleteUserCommand.d.ts +2 -7
  27. package/dist-types/commands/DeleteWebAppCommand.d.ts +1 -2
  28. package/dist-types/commands/DeleteWebAppCustomizationCommand.d.ts +2 -5
  29. package/dist-types/commands/DeleteWorkflowCommand.d.ts +1 -2
  30. package/dist-types/commands/DescribeAccessCommand.d.ts +2 -7
  31. package/dist-types/commands/DescribeAgreementCommand.d.ts +1 -2
  32. package/dist-types/commands/DescribeCertificateCommand.d.ts +1 -2
  33. package/dist-types/commands/DescribeConnectorCommand.d.ts +3 -4
  34. package/dist-types/commands/DescribeExecutionCommand.d.ts +2 -9
  35. package/dist-types/commands/DescribeHostKeyCommand.d.ts +1 -2
  36. package/dist-types/commands/DescribeProfileCommand.d.ts +1 -2
  37. package/dist-types/commands/DescribeSecurityPolicyCommand.d.ts +2 -6
  38. package/dist-types/commands/DescribeServerCommand.d.ts +2 -7
  39. package/dist-types/commands/DescribeUserCommand.d.ts +2 -6
  40. package/dist-types/commands/DescribeWebAppCommand.d.ts +1 -2
  41. package/dist-types/commands/DescribeWebAppCustomizationCommand.d.ts +1 -2
  42. package/dist-types/commands/DescribeWorkflowCommand.d.ts +1 -2
  43. package/dist-types/commands/ImportCertificateCommand.d.ts +2 -5
  44. package/dist-types/commands/ImportHostKeyCommand.d.ts +2 -4
  45. package/dist-types/commands/ImportSshPublicKeyCommand.d.ts +2 -7
  46. package/dist-types/commands/ListAccessesCommand.d.ts +1 -2
  47. package/dist-types/commands/ListAgreementsCommand.d.ts +2 -7
  48. package/dist-types/commands/ListCertificatesCommand.d.ts +2 -7
  49. package/dist-types/commands/ListConnectorsCommand.d.ts +1 -2
  50. package/dist-types/commands/ListExecutionsCommand.d.ts +2 -7
  51. package/dist-types/commands/ListFileTransferResultsCommand.d.ts +2 -8
  52. package/dist-types/commands/ListHostKeysCommand.d.ts +2 -4
  53. package/dist-types/commands/ListProfilesCommand.d.ts +2 -6
  54. package/dist-types/commands/ListSecurityPoliciesCommand.d.ts +1 -4
  55. package/dist-types/commands/ListServersCommand.d.ts +1 -2
  56. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -2
  57. package/dist-types/commands/ListUsersCommand.d.ts +2 -4
  58. package/dist-types/commands/SendWorkflowStepStateCommand.d.ts +2 -7
  59. package/dist-types/commands/StartDirectoryListingCommand.d.ts +2 -47
  60. package/dist-types/commands/StartFileTransferCommand.d.ts +2 -28
  61. package/dist-types/commands/StartRemoteDeleteCommand.d.ts +88 -0
  62. package/dist-types/commands/StartRemoteMoveCommand.d.ts +89 -0
  63. package/dist-types/commands/StartServerCommand.d.ts +2 -9
  64. package/dist-types/commands/StopServerCommand.d.ts +2 -14
  65. package/dist-types/commands/TagResourceCommand.d.ts +2 -5
  66. package/dist-types/commands/TestConnectionCommand.d.ts +5 -5
  67. package/dist-types/commands/TestIdentityProviderCommand.d.ts +2 -52
  68. package/dist-types/commands/UntagResourceCommand.d.ts +2 -5
  69. package/dist-types/commands/UpdateAccessCommand.d.ts +2 -4
  70. package/dist-types/commands/UpdateAgreementCommand.d.ts +2 -10
  71. package/dist-types/commands/UpdateCertificateCommand.d.ts +1 -2
  72. package/dist-types/commands/UpdateConnectorCommand.d.ts +3 -5
  73. package/dist-types/commands/UpdateHostKeyCommand.d.ts +2 -4
  74. package/dist-types/commands/UpdateProfileCommand.d.ts +2 -5
  75. package/dist-types/commands/UpdateServerCommand.d.ts +3 -9
  76. package/dist-types/commands/UpdateUserCommand.d.ts +2 -19
  77. package/dist-types/commands/UpdateWebAppCommand.d.ts +2 -5
  78. package/dist-types/commands/UpdateWebAppCustomizationCommand.d.ts +2 -5
  79. package/dist-types/commands/index.d.ts +2 -0
  80. package/dist-types/index.d.ts +1 -10
  81. package/dist-types/models/models_0.d.ts +395 -2556
  82. package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
  83. package/dist-types/ts3.4/Transfer.d.ts +34 -0
  84. package/dist-types/ts3.4/TransferClient.d.ts +12 -0
  85. package/dist-types/ts3.4/commands/StartRemoteDeleteCommand.d.ts +51 -0
  86. package/dist-types/ts3.4/commands/StartRemoteMoveCommand.d.ts +50 -0
  87. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  88. package/dist-types/ts3.4/models/models_0.d.ts +20 -0
  89. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
  90. package/package.json +1 -1
@@ -57,8 +57,7 @@ declare const DeleteHostKeyCommand_base: {
57
57
  * <p>This exception is thrown when the client submits a malformed request.</p>
58
58
  *
59
59
  * @throws {@link ResourceNotFoundException} (client fault)
60
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
61
- * service.</p>
60
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
62
61
  *
63
62
  * @throws {@link ServiceUnavailableException} (server fault)
64
63
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -56,8 +56,7 @@ declare const DeleteProfileCommand_base: {
56
56
  * <p>This exception is thrown when the client submits a malformed request.</p>
57
57
  *
58
58
  * @throws {@link ResourceNotFoundException} (client fault)
59
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
60
- * service.</p>
59
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
61
60
  *
62
61
  * @throws {@link ServiceUnavailableException} (server fault)
63
62
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,8 +27,7 @@ declare const DeleteServerCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes the file transfer protocol-enabled server that you specify.</p>
31
- * <p>No response returns from this operation.</p>
30
+ * <p>Deletes the file transfer protocol-enabled server that you specify.</p> <p>No response returns from this operation.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -60,8 +59,7 @@ declare const DeleteServerCommand_base: {
60
59
  * <p>This exception is thrown when the client submits a malformed request.</p>
61
60
  *
62
61
  * @throws {@link ResourceNotFoundException} (client fault)
63
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
64
- * service.</p>
62
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
65
63
  *
66
64
  * @throws {@link ServiceUnavailableException} (server fault)
67
65
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -58,8 +58,7 @@ declare const DeleteSshPublicKeyCommand_base: {
58
58
  * <p>This exception is thrown when the client submits a malformed request.</p>
59
59
  *
60
60
  * @throws {@link ResourceNotFoundException} (client fault)
61
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
62
- * service.</p>
61
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
63
62
  *
64
63
  * @throws {@link ServiceUnavailableException} (server fault)
65
64
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,11 +27,7 @@ declare const DeleteUserCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes the user belonging to a file transfer protocol-enabled server you specify.</p>
31
- * <p>No response returns from this operation.</p>
32
- * <note>
33
- * <p>When you delete a user from a server, the user's information is lost.</p>
34
- * </note>
30
+ * <p>Deletes the user belonging to a file transfer protocol-enabled server you specify.</p> <p>No response returns from this operation.</p> <note> <p>When you delete a user from a server, the user's information is lost.</p> </note>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -61,8 +57,7 @@ declare const DeleteUserCommand_base: {
61
57
  * <p>This exception is thrown when the client submits a malformed request.</p>
62
58
  *
63
59
  * @throws {@link ResourceNotFoundException} (client fault)
64
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
65
- * service.</p>
60
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
66
61
  *
67
62
  * @throws {@link ServiceUnavailableException} (server fault)
68
63
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -59,8 +59,7 @@ declare const DeleteWebAppCommand_base: {
59
59
  * <p>This exception is thrown when the client submits a malformed request.</p>
60
60
  *
61
61
  * @throws {@link ResourceNotFoundException} (client fault)
62
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
63
- * service.</p>
62
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
64
63
  *
65
64
  * @throws {@link ThrottlingException} (client fault)
66
65
  * <p>The request was denied due to request throttling.</p>
@@ -53,9 +53,7 @@ declare const DeleteWebAppCustomizationCommand_base: {
53
53
  * <p>You do not have sufficient access to perform this action.</p>
54
54
  *
55
55
  * @throws {@link ConflictException} (client fault)
56
- * <p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer
57
- * protocol-enabled server that has VPC as the endpoint type and the server's
58
- * <code>VpcEndpointID</code> is not in the available state.</p>
56
+ * <p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's <code>VpcEndpointID</code> is not in the available state.</p>
59
57
  *
60
58
  * @throws {@link InternalServiceError} (server fault)
61
59
  * <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
@@ -64,8 +62,7 @@ declare const DeleteWebAppCustomizationCommand_base: {
64
62
  * <p>This exception is thrown when the client submits a malformed request.</p>
65
63
  *
66
64
  * @throws {@link ResourceNotFoundException} (client fault)
67
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
68
- * service.</p>
65
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
69
66
  *
70
67
  * @throws {@link ThrottlingException} (client fault)
71
68
  * <p>The request was denied due to request throttling.</p>
@@ -59,8 +59,7 @@ declare const DeleteWorkflowCommand_base: {
59
59
  * <p>This exception is thrown when the client submits a malformed request.</p>
60
60
  *
61
61
  * @throws {@link ResourceNotFoundException} (client fault)
62
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
63
- * service.</p>
62
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
64
63
  *
65
64
  * @throws {@link ServiceUnavailableException} (server fault)
66
65
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,11 +27,7 @@ declare const DescribeAccessCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Describes the access that is assigned to the specific file transfer protocol-enabled
31
- * server, as identified by its <code>ServerId</code> property and its
32
- * <code>ExternalId</code>.</p>
33
- * <p>The response from this call returns the properties of the access that is associated with
34
- * the <code>ServerId</code> value that was specified.</p>
30
+ * <p>Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its <code>ServerId</code> property and its <code>ExternalId</code>.</p> <p>The response from this call returns the properties of the access that is associated with the <code>ServerId</code> value that was specified.</p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -84,8 +80,7 @@ declare const DescribeAccessCommand_base: {
84
80
  * <p>This exception is thrown when the client submits a malformed request.</p>
85
81
  *
86
82
  * @throws {@link ResourceNotFoundException} (client fault)
87
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
88
- * service.</p>
83
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
89
84
  *
90
85
  * @throws {@link ServiceUnavailableException} (server fault)
91
86
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -84,8 +84,7 @@ declare const DescribeAgreementCommand_base: {
84
84
  * <p>This exception is thrown when the client submits a malformed request.</p>
85
85
  *
86
86
  * @throws {@link ResourceNotFoundException} (client fault)
87
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
88
- * service.</p>
87
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
89
88
  *
90
89
  * @throws {@link ServiceUnavailableException} (server fault)
91
90
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -78,8 +78,7 @@ declare const DescribeCertificateCommand_base: {
78
78
  * <p>This exception is thrown when the client submits a malformed request.</p>
79
79
  *
80
80
  * @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>
83
82
  *
84
83
  * @throws {@link ServiceUnavailableException} (server fault)
85
84
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,8 +27,7 @@ declare const DescribeConnectorCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Describes the connector that's identified by the <code>ConnectorId.</code>
31
- * </p>
30
+ * <p>Describes the connector that's identified by the <code>ConnectorId.</code> </p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -70,6 +69,7 @@ declare const DescribeConnectorCommand_base: {
70
69
  * // TrustedHostKeys: [ // SftpConnectorTrustedHostKeyList
71
70
  * // "STRING_VALUE",
72
71
  * // ],
72
+ * // MaxConcurrentConnections: Number("int"),
73
73
  * // },
74
74
  * // ServiceManagedEgressIpAddresses: [ // ServiceManagedEgressIpAddresses
75
75
  * // "STRING_VALUE",
@@ -93,8 +93,7 @@ declare const DescribeConnectorCommand_base: {
93
93
  * <p>This exception is thrown when the client submits a malformed request.</p>
94
94
  *
95
95
  * @throws {@link ResourceNotFoundException} (client fault)
96
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
97
- * service.</p>
96
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
98
97
  *
99
98
  * @throws {@link ServiceUnavailableException} (server fault)
100
99
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,13 +27,7 @@ declare const DescribeExecutionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>You can use <code>DescribeExecution</code> to check the details of the execution of the specified workflow.</p>
31
- * <note>
32
- * <p>This API call only returns details for in-progress workflows.</p>
33
- * <p>
34
- * If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a
35
- * <code>ResourceNotFound</code> exception.</p>
36
- * </note>
30
+ * <p>You can use <code>DescribeExecution</code> to check the details of the execution of the specified workflow.</p> <note> <p>This API call only returns details for in-progress workflows.</p> <p> If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a <code>ResourceNotFound</code> exception.</p> </note>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -122,8 +116,7 @@ declare const DescribeExecutionCommand_base: {
122
116
  * <p>This exception is thrown when the client submits a malformed request.</p>
123
117
  *
124
118
  * @throws {@link ResourceNotFoundException} (client fault)
125
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
126
- * service.</p>
119
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
127
120
  *
128
121
  * @throws {@link ServiceUnavailableException} (server fault)
129
122
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -72,8 +72,7 @@ declare const DescribeHostKeyCommand_base: {
72
72
  * <p>This exception is thrown when the client submits a malformed request.</p>
73
73
  *
74
74
  * @throws {@link ResourceNotFoundException} (client fault)
75
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
76
- * service.</p>
75
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
77
76
  *
78
77
  * @throws {@link ServiceUnavailableException} (server fault)
79
78
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -72,8 +72,7 @@ declare const DescribeProfileCommand_base: {
72
72
  * <p>This exception is thrown when the client submits a malformed request.</p>
73
73
  *
74
74
  * @throws {@link ResourceNotFoundException} (client fault)
75
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
76
- * service.</p>
75
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
77
76
  *
78
77
  * @throws {@link ServiceUnavailableException} (server fault)
79
78
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,10 +27,7 @@ declare const DescribeSecurityPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more
31
- * information about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security
32
- * policies for servers</a> or <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html">Working with security
33
- * policies for SFTP connectors</a>.</p>
30
+ * <p>Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. 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>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -83,8 +80,7 @@ declare const DescribeSecurityPolicyCommand_base: {
83
80
  * <p>This exception is thrown when the client submits a malformed request.</p>
84
81
  *
85
82
  * @throws {@link ResourceNotFoundException} (client fault)
86
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
87
- * service.</p>
83
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
88
84
  *
89
85
  * @throws {@link ServiceUnavailableException} (server fault)
90
86
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,11 +27,7 @@ declare const DescribeServerCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Describes a file transfer protocol-enabled server that you specify by passing the
31
- * <code>ServerId</code> parameter.</p>
32
- * <p>The response contains a description of a server's properties. When you set
33
- * <code>EndpointType</code> to VPC, the response will contain the
34
- * <code>EndpointDetails</code>.</p>
30
+ * <p>Describes a file transfer protocol-enabled server that you specify by passing the <code>ServerId</code> parameter.</p> <p>The response contains a description of a server's properties. When you set <code>EndpointType</code> to VPC, the response will contain the <code>EndpointDetails</code>.</p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -136,8 +132,7 @@ declare const DescribeServerCommand_base: {
136
132
  * <p>This exception is thrown when the client submits a malformed request.</p>
137
133
  *
138
134
  * @throws {@link ResourceNotFoundException} (client fault)
139
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
140
- * service.</p>
135
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
141
136
  *
142
137
  * @throws {@link ServiceUnavailableException} (server fault)
143
138
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,10 +27,7 @@ declare const DescribeUserCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Describes the user assigned to the specific file transfer protocol-enabled server, as
31
- * identified by its <code>ServerId</code> property.</p>
32
- * <p>The response from this call returns the properties of the user associated with the
33
- * <code>ServerId</code> value that was specified.</p>
30
+ * <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>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -97,8 +94,7 @@ declare const DescribeUserCommand_base: {
97
94
  * <p>This exception is thrown when the client submits a malformed request.</p>
98
95
  *
99
96
  * @throws {@link ResourceNotFoundException} (client fault)
100
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
101
- * service.</p>
97
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
102
98
  *
103
99
  * @throws {@link ServiceUnavailableException} (server fault)
104
100
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -83,8 +83,7 @@ declare const DescribeWebAppCommand_base: {
83
83
  * <p>This exception is thrown when the client submits a malformed request.</p>
84
84
  *
85
85
  * @throws {@link ResourceNotFoundException} (client fault)
86
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
87
- * service.</p>
86
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
88
87
  *
89
88
  * @throws {@link ThrottlingException} (client fault)
90
89
  * <p>The request was denied due to request throttling.</p>
@@ -67,8 +67,7 @@ declare const DescribeWebAppCustomizationCommand_base: {
67
67
  * <p>This exception is thrown when the client submits a malformed request.</p>
68
68
  *
69
69
  * @throws {@link ResourceNotFoundException} (client fault)
70
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
71
- * service.</p>
70
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
72
71
  *
73
72
  * @throws {@link ThrottlingException} (client fault)
74
73
  * <p>The request was denied due to request throttling.</p>
@@ -180,8 +180,7 @@ declare const DescribeWorkflowCommand_base: {
180
180
  * <p>This exception is thrown when the client submits a malformed request.</p>
181
181
  *
182
182
  * @throws {@link ResourceNotFoundException} (client fault)
183
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
184
- * service.</p>
183
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
185
184
  *
186
185
  * @throws {@link ServiceUnavailableException} (server fault)
187
186
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,9 +27,7 @@ declare const ImportCertificateCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Imports the signing and encryption certificates that you need to create local (AS2)
31
- * profiles and partner
32
- * profiles.</p>
30
+ * <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>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -72,8 +70,7 @@ declare const ImportCertificateCommand_base: {
72
70
  * <p>This exception is thrown when the client submits a malformed request.</p>
73
71
  *
74
72
  * @throws {@link ResourceNotFoundException} (client fault)
75
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
76
- * service.</p>
73
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
77
74
  *
78
75
  * @throws {@link ServiceUnavailableException} (server fault)
79
76
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,8 +27,7 @@ declare const ImportHostKeyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Adds a host key to the server that's specified by the <code>ServerId</code>
31
- * parameter.</p>
30
+ * <p>Adds a host key to the server that's specified by the <code>ServerId</code> parameter.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -71,8 +70,7 @@ declare const ImportHostKeyCommand_base: {
71
70
  * <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
72
71
  *
73
72
  * @throws {@link ResourceNotFoundException} (client fault)
74
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
75
- * service.</p>
73
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
76
74
  *
77
75
  * @throws {@link ServiceUnavailableException} (server fault)
78
76
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,11 +27,7 @@ declare const ImportSshPublicKeyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a
31
- * <code>UserName</code> value assigned to the specific file transfer protocol-enabled server,
32
- * identified by <code>ServerId</code>.</p>
33
- * <p>The response returns the <code>UserName</code> value, the <code>ServerId</code> value, and
34
- * the name of the <code>SshPublicKeyId</code>.</p>
30
+ * <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>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -69,8 +65,7 @@ declare const ImportSshPublicKeyCommand_base: {
69
65
  * <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
70
66
  *
71
67
  * @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>
68
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
74
69
  *
75
70
  * @throws {@link ServiceUnavailableException} (server fault)
76
71
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -72,8 +72,7 @@ declare const ListAccessesCommand_base: {
72
72
  * <p>This exception is thrown when the client submits a malformed request.</p>
73
73
  *
74
74
  * @throws {@link ResourceNotFoundException} (client fault)
75
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
76
- * service.</p>
75
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
77
76
  *
78
77
  * @throws {@link ServiceUnavailableException} (server fault)
79
78
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,11 +27,7 @@ declare const ListAgreementsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of the agreements for the server that's identified by the
31
- * <code>ServerId</code> that you supply. If you want to limit the results to a certain number,
32
- * supply a value for the <code>MaxResults</code> parameter. If you ran the command previously
33
- * and received a value for <code>NextToken</code>, you can supply that value to continue listing
34
- * agreements from where you left off.</p>
30
+ * <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>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -78,8 +74,7 @@ declare const ListAgreementsCommand_base: {
78
74
  * <p>This exception is thrown when the client submits a malformed request.</p>
79
75
  *
80
76
  * @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>
77
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
83
78
  *
84
79
  * @throws {@link ServiceUnavailableException} (server fault)
85
80
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,11 +27,7 @@ declare const ListCertificatesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of the current certificates that have been imported into Transfer Family. If you want to
31
- * limit the results to a certain number, supply a value for the <code>MaxResults</code>
32
- * parameter. If you ran the command previously and received a value for the
33
- * <code>NextToken</code> parameter, you can supply that value to continue listing certificates
34
- * from where you left off.</p>
30
+ * <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>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -78,8 +74,7 @@ declare const ListCertificatesCommand_base: {
78
74
  * <p>This exception is thrown when the client submits a malformed request.</p>
79
75
  *
80
76
  * @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>
77
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
83
78
  *
84
79
  * @throws {@link ServiceUnavailableException} (server fault)
85
80
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -69,8 +69,7 @@ declare const ListConnectorsCommand_base: {
69
69
  * <p>This exception is thrown when the client submits a malformed request.</p>
70
70
  *
71
71
  * @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>
74
73
  *
75
74
  * @throws {@link ServiceUnavailableException} (server fault)
76
75
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,11 +27,7 @@ declare const ListExecutionsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists all in-progress executions for the specified workflow.</p>
31
- * <note>
32
- * <p>If the specified workflow ID cannot be found, <code>ListExecutions</code> returns a
33
- * <code>ResourceNotFound</code> exception.</p>
34
- * </note>
30
+ * <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>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -93,8 +89,7 @@ declare const ListExecutionsCommand_base: {
93
89
  * <p>This exception is thrown when the client submits a malformed request.</p>
94
90
  *
95
91
  * @throws {@link ResourceNotFoundException} (client fault)
96
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
97
- * service.</p>
92
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
98
93
  *
99
94
  * @throws {@link ServiceUnavailableException} (server fault)
100
95
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,12 +27,7 @@ declare const ListFileTransferResultsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation.
32
- * You specify the file transfer by providing its <code>ConnectorId</code> and its <code>TransferId</code>.</p>
33
- * <note>
34
- * <p>File transfer results are available up to 7 days after an operation has been requested.</p>
35
- * </note>
30
+ * <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>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -74,8 +69,7 @@ declare const ListFileTransferResultsCommand_base: {
74
69
  * <p>This exception is thrown when the client submits a malformed request.</p>
75
70
  *
76
71
  * @throws {@link ResourceNotFoundException} (client fault)
77
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
78
- * service.</p>
72
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
79
73
  *
80
74
  * @throws {@link ServiceUnavailableException} (server fault)
81
75
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,8 +27,7 @@ declare const ListHostKeysCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of host keys for the server that's specified by the <code>ServerId</code>
31
- * parameter.</p>
30
+ * <p>Returns a list of host keys for the server that's specified by the <code>ServerId</code> parameter.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -75,8 +74,7 @@ declare const ListHostKeysCommand_base: {
75
74
  * <p>This exception is thrown when the client submits a malformed request.</p>
76
75
  *
77
76
  * @throws {@link ResourceNotFoundException} (client fault)
78
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
79
- * service.</p>
77
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
80
78
  *
81
79
  * @throws {@link ServiceUnavailableException} (server fault)
82
80
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,10 +27,7 @@ declare const ListProfilesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of the profiles for your system. If you want to limit the results to a
31
- * certain number, supply a value for the <code>MaxResults</code> parameter. If you ran the
32
- * command previously and received a value for <code>NextToken</code>, you can supply that value
33
- * to continue listing profiles from where you left off.</p>
30
+ * <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>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -74,8 +71,7 @@ declare const ListProfilesCommand_base: {
74
71
  * <p>This exception is thrown when the client submits a malformed request.</p>
75
72
  *
76
73
  * @throws {@link ResourceNotFoundException} (client fault)
77
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
78
- * service.</p>
74
+ * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
79
75
  *
80
76
  * @throws {@link ServiceUnavailableException} (server fault)
81
77
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
@@ -27,10 +27,7 @@ declare const ListSecurityPoliciesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists the security policies that are attached to your servers and SFTP connectors. For more information
31
- * about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security
32
- * policies for servers</a> or <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html">Working with security
33
- * policies for SFTP connectors</a>.</p>
30
+ * <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>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const ListServersCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services
31
- * account.</p>
30
+ * <p>Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript