@aws-sdk/client-transfer 3.784.0 → 3.787.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.
- package/README.md +1 -10
- package/dist-types/Transfer.d.ts +1 -10
- package/dist-types/TransferClient.d.ts +1 -10
- package/dist-types/commands/CreateAccessCommand.d.ts +2 -8
- package/dist-types/commands/CreateAgreementCommand.d.ts +2 -12
- package/dist-types/commands/CreateConnectorCommand.d.ts +3 -8
- package/dist-types/commands/CreateProfileCommand.d.ts +1 -2
- package/dist-types/commands/CreateServerCommand.d.ts +2 -6
- package/dist-types/commands/CreateUserCommand.d.ts +2 -9
- package/dist-types/commands/CreateWebAppCommand.d.ts +1 -2
- package/dist-types/commands/CreateWorkflowCommand.d.ts +1 -4
- package/dist-types/commands/DeleteAccessCommand.d.ts +2 -4
- package/dist-types/commands/DeleteAgreementCommand.d.ts +1 -2
- package/dist-types/commands/DeleteCertificateCommand.d.ts +2 -4
- package/dist-types/commands/DeleteConnectorCommand.d.ts +1 -2
- package/dist-types/commands/DeleteHostKeyCommand.d.ts +1 -2
- package/dist-types/commands/DeleteProfileCommand.d.ts +1 -2
- package/dist-types/commands/DeleteServerCommand.d.ts +2 -4
- package/dist-types/commands/DeleteSshPublicKeyCommand.d.ts +1 -2
- package/dist-types/commands/DeleteUserCommand.d.ts +2 -7
- package/dist-types/commands/DeleteWebAppCommand.d.ts +1 -2
- package/dist-types/commands/DeleteWebAppCustomizationCommand.d.ts +2 -5
- package/dist-types/commands/DeleteWorkflowCommand.d.ts +1 -2
- package/dist-types/commands/DescribeAccessCommand.d.ts +2 -7
- package/dist-types/commands/DescribeAgreementCommand.d.ts +1 -2
- package/dist-types/commands/DescribeCertificateCommand.d.ts +1 -2
- package/dist-types/commands/DescribeConnectorCommand.d.ts +3 -4
- package/dist-types/commands/DescribeExecutionCommand.d.ts +2 -9
- package/dist-types/commands/DescribeHostKeyCommand.d.ts +1 -2
- package/dist-types/commands/DescribeProfileCommand.d.ts +1 -2
- package/dist-types/commands/DescribeSecurityPolicyCommand.d.ts +2 -6
- package/dist-types/commands/DescribeServerCommand.d.ts +2 -7
- package/dist-types/commands/DescribeUserCommand.d.ts +2 -6
- package/dist-types/commands/DescribeWebAppCommand.d.ts +1 -2
- package/dist-types/commands/DescribeWebAppCustomizationCommand.d.ts +1 -2
- package/dist-types/commands/DescribeWorkflowCommand.d.ts +1 -2
- package/dist-types/commands/ImportCertificateCommand.d.ts +2 -11
- package/dist-types/commands/ImportHostKeyCommand.d.ts +2 -4
- package/dist-types/commands/ImportSshPublicKeyCommand.d.ts +2 -7
- package/dist-types/commands/ListAccessesCommand.d.ts +1 -2
- package/dist-types/commands/ListAgreementsCommand.d.ts +2 -7
- package/dist-types/commands/ListCertificatesCommand.d.ts +2 -7
- package/dist-types/commands/ListConnectorsCommand.d.ts +1 -2
- package/dist-types/commands/ListExecutionsCommand.d.ts +2 -7
- package/dist-types/commands/ListFileTransferResultsCommand.d.ts +2 -8
- package/dist-types/commands/ListHostKeysCommand.d.ts +2 -4
- package/dist-types/commands/ListProfilesCommand.d.ts +2 -6
- package/dist-types/commands/ListSecurityPoliciesCommand.d.ts +1 -4
- package/dist-types/commands/ListServersCommand.d.ts +1 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -2
- package/dist-types/commands/ListUsersCommand.d.ts +2 -4
- package/dist-types/commands/SendWorkflowStepStateCommand.d.ts +2 -7
- package/dist-types/commands/StartDirectoryListingCommand.d.ts +2 -47
- package/dist-types/commands/StartFileTransferCommand.d.ts +2 -28
- package/dist-types/commands/StartRemoteDeleteCommand.d.ts +1 -2
- package/dist-types/commands/StartRemoteMoveCommand.d.ts +1 -2
- package/dist-types/commands/StartServerCommand.d.ts +2 -9
- package/dist-types/commands/StopServerCommand.d.ts +2 -14
- package/dist-types/commands/TagResourceCommand.d.ts +2 -5
- package/dist-types/commands/TestConnectionCommand.d.ts +5 -5
- package/dist-types/commands/TestIdentityProviderCommand.d.ts +2 -52
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -5
- package/dist-types/commands/UpdateAccessCommand.d.ts +2 -4
- package/dist-types/commands/UpdateAgreementCommand.d.ts +2 -10
- package/dist-types/commands/UpdateCertificateCommand.d.ts +1 -2
- package/dist-types/commands/UpdateConnectorCommand.d.ts +3 -5
- package/dist-types/commands/UpdateHostKeyCommand.d.ts +2 -4
- package/dist-types/commands/UpdateProfileCommand.d.ts +2 -5
- package/dist-types/commands/UpdateServerCommand.d.ts +3 -9
- package/dist-types/commands/UpdateUserCommand.d.ts +2 -19
- package/dist-types/commands/UpdateWebAppCommand.d.ts +2 -5
- package/dist-types/commands/UpdateWebAppCustomizationCommand.d.ts +2 -5
- package/dist-types/index.d.ts +1 -10
- package/dist-types/models/models_0.d.ts +340 -2581
- package/dist-types/ts3.4/models/models_0.d.ts +5 -0
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -6,16 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript Transfer Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
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>
|
|
19
10
|
|
|
20
11
|
## Installing
|
|
21
12
|
|
package/dist-types/Transfer.d.ts
CHANGED
|
@@ -508,16 +508,7 @@ export interface Transfer {
|
|
|
508
508
|
updateWebAppCustomization(args: UpdateWebAppCustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWebAppCustomizationCommandOutput) => void): void;
|
|
509
509
|
}
|
|
510
510
|
/**
|
|
511
|
-
* <p>Transfer Family is a fully managed service that enables the transfer of files over the File
|
|
512
|
-
* Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File
|
|
513
|
-
* Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.
|
|
514
|
-
* Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3.
|
|
515
|
-
* Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating
|
|
516
|
-
* with existing authentication systems, and providing DNS routing with Amazon Route 53 so
|
|
517
|
-
* nothing changes for your customers and partners, or their applications. With your data in
|
|
518
|
-
* Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and
|
|
519
|
-
* archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and
|
|
520
|
-
* set up.</p>
|
|
511
|
+
* <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>
|
|
521
512
|
* @public
|
|
522
513
|
*/
|
|
523
514
|
export declare class Transfer extends TransferClient implements Transfer {
|
|
@@ -240,16 +240,7 @@ export type TransferClientResolvedConfigType = __SmithyResolvedConfiguration<__H
|
|
|
240
240
|
export interface TransferClientResolvedConfig extends TransferClientResolvedConfigType {
|
|
241
241
|
}
|
|
242
242
|
/**
|
|
243
|
-
* <p>Transfer Family is a fully managed service that enables the transfer of files over the File
|
|
244
|
-
* Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File
|
|
245
|
-
* Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.
|
|
246
|
-
* Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3.
|
|
247
|
-
* Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating
|
|
248
|
-
* with existing authentication systems, and providing DNS routing with Amazon Route 53 so
|
|
249
|
-
* nothing changes for your customers and partners, or their applications. With your data in
|
|
250
|
-
* Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and
|
|
251
|
-
* archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and
|
|
252
|
-
* set up.</p>
|
|
243
|
+
* <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>
|
|
253
244
|
* @public
|
|
254
245
|
*/
|
|
255
246
|
export declare class TransferClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig> {
|
|
@@ -27,12 +27,7 @@ declare const CreateAccessCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Used by administrators to choose which groups in the directory should have access to
|
|
31
|
-
* upload and download files over the enabled protocols using Transfer Family. For example, a
|
|
32
|
-
* Microsoft Active Directory might contain 50,000 users, but only a small fraction might need
|
|
33
|
-
* the ability to transfer files to the server. An administrator can use
|
|
34
|
-
* <code>CreateAccess</code> to limit the access to the correct set of users who need this
|
|
35
|
-
* ability.</p>
|
|
30
|
+
* <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>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -86,8 +81,7 @@ declare const CreateAccessCommand_base: {
|
|
|
86
81
|
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
|
|
87
82
|
*
|
|
88
83
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
89
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
90
|
-
* service.</p>
|
|
84
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
91
85
|
*
|
|
92
86
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
93
87
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,16 +27,7 @@ declare const CreateAgreementCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership,
|
|
31
|
-
* between an Transfer Family server and an AS2 process. The agreement defines the file and message
|
|
32
|
-
* transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family
|
|
33
|
-
* combines a server, local profile, partner profile, certificate, and other
|
|
34
|
-
* attributes.</p>
|
|
35
|
-
* <p>The partner is identified with the <code>PartnerProfileId</code>, and the AS2 process is identified with the <code>LocalProfileId</code>.</p>
|
|
36
|
-
* <note>
|
|
37
|
-
* <p>Specify <i>either</i>
|
|
38
|
-
* <code>BaseDirectory</code> or <code>CustomDirectories</code>, but not both. Specifying both causes the command to fail.</p>
|
|
39
|
-
* </note>
|
|
30
|
+
* <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>
|
|
40
31
|
* @example
|
|
41
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
33
|
* ```javascript
|
|
@@ -91,8 +82,7 @@ declare const CreateAgreementCommand_base: {
|
|
|
91
82
|
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
|
|
92
83
|
*
|
|
93
84
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
94
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
95
|
-
* service.</p>
|
|
85
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
96
86
|
*
|
|
97
87
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
98
88
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,12 +27,7 @@ declare const CreateConnectorCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates the connector, which captures the parameters for a connection for the
|
|
31
|
-
* 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.
|
|
32
|
-
* 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>
|
|
33
|
-
* <note>
|
|
34
|
-
* <p>You must specify exactly one configuration object: either for AS2 (<code>As2Config</code>) or SFTP (<code>SftpConfig</code>).</p>
|
|
35
|
-
* </note>
|
|
30
|
+
* <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>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -66,6 +61,7 @@ declare const CreateConnectorCommand_base: {
|
|
|
66
61
|
* TrustedHostKeys: [ // SftpConnectorTrustedHostKeyList
|
|
67
62
|
* "STRING_VALUE",
|
|
68
63
|
* ],
|
|
64
|
+
* MaxConcurrentConnections: Number("int"),
|
|
69
65
|
* },
|
|
70
66
|
* SecurityPolicyName: "STRING_VALUE",
|
|
71
67
|
* };
|
|
@@ -93,8 +89,7 @@ declare const CreateConnectorCommand_base: {
|
|
|
93
89
|
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</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>
|
|
@@ -68,8 +68,7 @@ declare const CreateProfileCommand_base: {
|
|
|
68
68
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
69
69
|
*
|
|
70
70
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
71
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
72
|
-
* service.</p>
|
|
71
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
73
72
|
*
|
|
74
73
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
75
74
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,10 +27,7 @@ declare const CreateServerCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Instantiates an auto-scaling virtual server based on the selected file transfer protocol
|
|
31
|
-
* in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work
|
|
32
|
-
* with users, use the service-generated <code>ServerId</code> property that is assigned to the
|
|
33
|
-
* newly created server.</p>
|
|
30
|
+
* <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>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -132,8 +129,7 @@ declare const CreateServerCommand_base: {
|
|
|
132
129
|
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
|
|
133
130
|
*
|
|
134
131
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
135
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
136
|
-
* service.</p>
|
|
132
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
137
133
|
*
|
|
138
134
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
139
135
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,13 +27,7 @@ declare const CreateUserCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a user and associates them with an existing file transfer protocol-enabled server.
|
|
31
|
-
* You can only create and associate users with servers that have the
|
|
32
|
-
* <code>IdentityProviderType</code> set to <code>SERVICE_MANAGED</code>. Using parameters for
|
|
33
|
-
* <code>CreateUser</code>, you can specify the user name, set the home directory, store the
|
|
34
|
-
* user's public key, and assign the user's Identity and Access Management (IAM)
|
|
35
|
-
* role. You can also optionally add a session policy, and assign metadata with tags that can
|
|
36
|
-
* be used to group and search for users.</p>
|
|
30
|
+
* <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>
|
|
37
31
|
* @example
|
|
38
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
33
|
* ```javascript
|
|
@@ -94,8 +88,7 @@ declare const CreateUserCommand_base: {
|
|
|
94
88
|
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
|
|
95
89
|
*
|
|
96
90
|
* @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>
|
|
91
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
99
92
|
*
|
|
100
93
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
101
94
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -77,8 +77,7 @@ declare const CreateWebAppCommand_base: {
|
|
|
77
77
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
78
78
|
*
|
|
79
79
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
80
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
81
|
-
* service.</p>
|
|
80
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
82
81
|
*
|
|
83
82
|
* @throws {@link ThrottlingException} (client fault)
|
|
84
83
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -27,10 +27,7 @@ declare const CreateWorkflowCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
|
|
32
|
-
* 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.
|
|
33
|
-
* </p>
|
|
30
|
+
* <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>
|
|
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 DeleteAccessCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Allows you to delete the access specified in the <code>ServerID</code> and
|
|
31
|
-
* <code>ExternalID</code> parameters.</p>
|
|
30
|
+
* <p>Allows you to delete the access specified in the <code>ServerID</code> and <code>ExternalID</code> parameters.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -58,8 +57,7 @@ declare const DeleteAccessCommand_base: {
|
|
|
58
57
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
59
58
|
*
|
|
60
59
|
* @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>
|
|
60
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
63
61
|
*
|
|
64
62
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
65
63
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -57,8 +57,7 @@ declare const DeleteAgreementCommand_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>
|
|
@@ -27,8 +27,7 @@ declare const DeleteCertificateCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes the certificate that's specified in the <code>CertificateId</code>
|
|
31
|
-
* parameter.</p>
|
|
30
|
+
* <p>Deletes the certificate that's specified in the <code>CertificateId</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
|
|
@@ -57,8 +56,7 @@ declare const DeleteCertificateCommand_base: {
|
|
|
57
56
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
58
57
|
*
|
|
59
58
|
* @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>
|
|
59
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
62
60
|
*
|
|
63
61
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
64
62
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -56,8 +56,7 @@ declare const DeleteConnectorCommand_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>
|
|
@@ -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>
|