@aws-sdk/client-transfer 3.784.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.
- 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 +1 -1
|
@@ -27,9 +27,7 @@ declare const TestConnectionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Tests whether your SFTP connector is set up successfully. We highly recommend that you call this
|
|
31
|
-
* operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's
|
|
32
|
-
* SFTP server.</p>
|
|
30
|
+
* <p>Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's SFTP server.</p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -45,6 +43,9 @@ declare const TestConnectionCommand_base: {
|
|
|
45
43
|
* // ConnectorId: "STRING_VALUE",
|
|
46
44
|
* // Status: "STRING_VALUE",
|
|
47
45
|
* // StatusMessage: "STRING_VALUE",
|
|
46
|
+
* // SftpConnectionDetails: { // SftpConnectorConnectionDetails
|
|
47
|
+
* // HostKey: "STRING_VALUE",
|
|
48
|
+
* // },
|
|
48
49
|
* // };
|
|
49
50
|
*
|
|
50
51
|
* ```
|
|
@@ -62,8 +63,7 @@ declare const TestConnectionCommand_base: {
|
|
|
62
63
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
63
64
|
*
|
|
64
65
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
66
|
-
* service.</p>
|
|
66
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
69
69
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,56 +27,7 @@ declare const TestIdentityProviderCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>If the <code>IdentityProviderType</code> of a file transfer protocol-enabled server is
|
|
31
|
-
* <code>AWS_DIRECTORY_SERVICE</code> or <code>API_Gateway</code>, tests whether your identity
|
|
32
|
-
* provider is set up successfully. We highly recommend that you call this operation to test your
|
|
33
|
-
* authentication method as soon as you create your server. By doing so, you can troubleshoot
|
|
34
|
-
* issues with the identity provider integration to ensure that your users can successfully use
|
|
35
|
-
* the service.</p>
|
|
36
|
-
* <p>
|
|
37
|
-
* The <code>ServerId</code> and <code>UserName</code> parameters are required. The <code>ServerProtocol</code>, <code>SourceIp</code>, and <code>UserPassword</code> are all optional.
|
|
38
|
-
* </p>
|
|
39
|
-
* <p>Note the following:</p>
|
|
40
|
-
* <ul>
|
|
41
|
-
* <li>
|
|
42
|
-
* <p> You cannot use <code>TestIdentityProvider</code> if the
|
|
43
|
-
* <code>IdentityProviderType</code> of your server is <code>SERVICE_MANAGED</code>.</p>
|
|
44
|
-
* </li>
|
|
45
|
-
* <li>
|
|
46
|
-
* <p>
|
|
47
|
-
* <code>TestIdentityProvider</code> does not work with keys: it only accepts
|
|
48
|
-
* passwords.</p>
|
|
49
|
-
* </li>
|
|
50
|
-
* <li>
|
|
51
|
-
* <p>
|
|
52
|
-
* <code>TestIdentityProvider</code> can test the password operation for a custom Identity Provider that handles keys and passwords.</p>
|
|
53
|
-
* </li>
|
|
54
|
-
* <li>
|
|
55
|
-
* <p>
|
|
56
|
-
* If you provide any incorrect values for any parameters, the <code>Response</code> field is empty.
|
|
57
|
-
* </p>
|
|
58
|
-
* </li>
|
|
59
|
-
* <li>
|
|
60
|
-
* <p>
|
|
61
|
-
* If you provide a server ID for a server that uses service-managed users, you get an error:
|
|
62
|
-
* </p>
|
|
63
|
-
* <p>
|
|
64
|
-
* <code>
|
|
65
|
-
* An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-<i>server-ID</i> not configured for external auth
|
|
66
|
-
* </code>
|
|
67
|
-
* </p>
|
|
68
|
-
* </li>
|
|
69
|
-
* <li>
|
|
70
|
-
* <p>
|
|
71
|
-
* If you enter a Server ID for the <code>--server-id</code> parameter that does not identify an actual Transfer server, you receive the following error:
|
|
72
|
-
* </p>
|
|
73
|
-
* <p>
|
|
74
|
-
* <code>An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server</code>.
|
|
75
|
-
* </p>
|
|
76
|
-
* <p>It is possible your sever is in a different region. You can specify a region by adding the following: <code>--region region-code</code>,
|
|
77
|
-
* such as <code>--region us-east-2</code> to specify a server in <b>US East (Ohio)</b>.</p>
|
|
78
|
-
* </li>
|
|
79
|
-
* </ul>
|
|
30
|
+
* <p>If the <code>IdentityProviderType</code> of a file transfer protocol-enabled server is <code>AWS_DIRECTORY_SERVICE</code> or <code>API_Gateway</code>, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.</p> <p> The <code>ServerId</code> and <code>UserName</code> parameters are required. The <code>ServerProtocol</code>, <code>SourceIp</code>, and <code>UserPassword</code> are all optional. </p> <p>Note the following:</p> <ul> <li> <p> You cannot use <code>TestIdentityProvider</code> if the <code>IdentityProviderType</code> of your server is <code>SERVICE_MANAGED</code>.</p> </li> <li> <p> <code>TestIdentityProvider</code> does not work with keys: it only accepts passwords.</p> </li> <li> <p> <code>TestIdentityProvider</code> can test the password operation for a custom Identity Provider that handles keys and passwords.</p> </li> <li> <p> If you provide any incorrect values for any parameters, the <code>Response</code> field is empty. </p> </li> <li> <p> If you provide a server ID for a server that uses service-managed users, you get an error: </p> <p> <code> An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-<i>server-ID</i> not configured for external auth </code> </p> </li> <li> <p> If you enter a Server ID for the <code>--server-id</code> parameter that does not identify an actual Transfer server, you receive the following error: </p> <p> <code>An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server</code>. </p> <p>It is possible your sever is in a different region. You can specify a region by adding the following: <code>--region region-code</code>, such as <code>--region us-east-2</code> to specify a server in <b>US East (Ohio)</b>.</p> </li> </ul>
|
|
80
31
|
* @example
|
|
81
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
82
33
|
* ```javascript
|
|
@@ -114,8 +65,7 @@ declare const TestIdentityProviderCommand_base: {
|
|
|
114
65
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
115
66
|
*
|
|
116
67
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
117
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
118
|
-
* service.</p>
|
|
68
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
119
69
|
*
|
|
120
70
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
121
71
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,9 +27,7 @@ declare const UntagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Detaches a key-value pair from a resource, as identified by its Amazon Resource Name
|
|
31
|
-
* (ARN). Resources are users, servers, roles, and other entities.</p>
|
|
32
|
-
* <p>No response is returned from this call.</p>
|
|
30
|
+
* <p>Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.</p> <p>No response is returned from this call.</p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -61,8 +59,7 @@ declare const UntagResourceCommand_base: {
|
|
|
61
59
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
62
60
|
*
|
|
63
61
|
* @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>
|
|
62
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
66
63
|
*
|
|
67
64
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
68
65
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,8 +27,7 @@ declare const UpdateAccessCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Allows you to update parameters for the access specified in the <code>ServerID</code> and
|
|
31
|
-
* <code>ExternalID</code> parameters.</p>
|
|
30
|
+
* <p>Allows you to update parameters for 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
|
|
@@ -82,8 +81,7 @@ declare const UpdateAccessCommand_base: {
|
|
|
82
81
|
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
|
|
83
82
|
*
|
|
84
83
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
85
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
86
|
-
* service.</p>
|
|
84
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
87
85
|
*
|
|
88
86
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
89
87
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,14 +27,7 @@ declare const UpdateAgreementCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates some of the parameters for an existing agreement. Provide the
|
|
31
|
-
* <code>AgreementId</code> and the <code>ServerId</code> for the agreement that you want to
|
|
32
|
-
* update, along with the new values for the parameters to update.</p>
|
|
33
|
-
* <note>
|
|
34
|
-
* <p>Specify <i>either</i>
|
|
35
|
-
* <code>BaseDirectory</code> or <code>CustomDirectories</code>, but not both. Specifying both causes the command to fail.</p>
|
|
36
|
-
* <p>If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.</p>
|
|
37
|
-
* </note>
|
|
30
|
+
* <p>Updates some of the parameters for an existing agreement. Provide the <code>AgreementId</code> and the <code>ServerId</code> for the agreement that you want to update, along with the new values for the parameters to update.</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> <p>If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.</p> </note>
|
|
38
31
|
* @example
|
|
39
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
33
|
* ```javascript
|
|
@@ -84,8 +77,7 @@ declare const UpdateAgreementCommand_base: {
|
|
|
84
77
|
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
|
|
85
78
|
*
|
|
86
79
|
* @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>
|
|
80
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
89
81
|
*
|
|
90
82
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
91
83
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -61,8 +61,7 @@ declare const UpdateCertificateCommand_base: {
|
|
|
61
61
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
62
62
|
*
|
|
63
63
|
* @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>
|
|
64
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
66
65
|
*
|
|
67
66
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
68
67
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,9 +27,7 @@ declare const UpdateConnectorCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates some of the parameters for an existing connector. Provide the
|
|
31
|
-
* <code>ConnectorId</code> for the connector that you want to update, along with the new
|
|
32
|
-
* values for the parameters to update.</p>
|
|
30
|
+
* <p>Updates some of the parameters for an existing connector. Provide the <code>ConnectorId</code> for the connector that you want to update, along with the new values for the parameters to update.</p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -58,6 +56,7 @@ declare const UpdateConnectorCommand_base: {
|
|
|
58
56
|
* TrustedHostKeys: [ // SftpConnectorTrustedHostKeyList
|
|
59
57
|
* "STRING_VALUE",
|
|
60
58
|
* ],
|
|
59
|
+
* MaxConcurrentConnections: Number("int"),
|
|
61
60
|
* },
|
|
62
61
|
* SecurityPolicyName: "STRING_VALUE",
|
|
63
62
|
* };
|
|
@@ -85,8 +84,7 @@ declare const UpdateConnectorCommand_base: {
|
|
|
85
84
|
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
|
|
86
85
|
*
|
|
87
86
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
88
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
89
|
-
* service.</p>
|
|
87
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
90
88
|
*
|
|
91
89
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
92
90
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,8 +27,7 @@ declare const UpdateHostKeyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates the description for the host key that's specified by the <code>ServerId</code> and
|
|
31
|
-
* <code>HostKeyId</code> parameters.</p>
|
|
30
|
+
* <p>Updates the description for the host key that's specified by the <code>ServerId</code> and <code>HostKeyId</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
|
|
@@ -62,8 +61,7 @@ declare const UpdateHostKeyCommand_base: {
|
|
|
62
61
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
63
62
|
*
|
|
64
63
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
66
|
-
* service.</p>
|
|
64
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
67
65
|
*
|
|
68
66
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
69
67
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,9 +27,7 @@ declare const UpdateProfileCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates some of the parameters for an existing profile. Provide the <code>ProfileId</code>
|
|
31
|
-
* for the profile that you want to update, along with the new values for the parameters to
|
|
32
|
-
* update.</p>
|
|
30
|
+
* <p>Updates some of the parameters for an existing profile. Provide the <code>ProfileId</code> for the profile that you want to update, along with the new values for the parameters to update.</p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -63,8 +61,7 @@ declare const UpdateProfileCommand_base: {
|
|
|
63
61
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
64
62
|
*
|
|
65
63
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
67
|
-
* service.</p>
|
|
64
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
68
65
|
*
|
|
69
66
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
70
67
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,10 +27,7 @@ declare const UpdateServerCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates the file transfer protocol-enabled server's properties after that server has
|
|
31
|
-
* been created.</p>
|
|
32
|
-
* <p>The <code>UpdateServer</code> call returns the <code>ServerId</code> of the server you
|
|
33
|
-
* updated.</p>
|
|
30
|
+
* <p>Updates the file transfer protocol-enabled server's properties after that server has been created.</p> <p>The <code>UpdateServer</code> call returns the <code>ServerId</code> of the server you updated.</p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -116,9 +113,7 @@ declare const UpdateServerCommand_base: {
|
|
|
116
113
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
117
114
|
*
|
|
118
115
|
* @throws {@link ConflictException} (client fault)
|
|
119
|
-
* <p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer
|
|
120
|
-
* protocol-enabled server that has VPC as the endpoint type and the server's
|
|
121
|
-
* <code>VpcEndpointID</code> is not in the available state.</p>
|
|
116
|
+
* <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>
|
|
122
117
|
*
|
|
123
118
|
* @throws {@link InternalServiceError} (server fault)
|
|
124
119
|
* <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
|
|
@@ -130,8 +125,7 @@ declare const UpdateServerCommand_base: {
|
|
|
130
125
|
* <p>The requested resource does not exist, or exists in a region other than the one specified for the command.</p>
|
|
131
126
|
*
|
|
132
127
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
133
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
134
|
-
* service.</p>
|
|
128
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
135
129
|
*
|
|
136
130
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
137
131
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -27,23 +27,7 @@ declare const UpdateUserCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Assigns new properties to a user. Parameters you pass modify any or all of the following:
|
|
31
|
-
* the home directory, role, and policy for the <code>UserName</code> and <code>ServerId</code>
|
|
32
|
-
* you specify.</p>
|
|
33
|
-
* <p>The response returns the <code>ServerId</code> and the <code>UserName</code> for the
|
|
34
|
-
* updated user.</p>
|
|
35
|
-
* <p>In the console, you can select <i>Restricted</i> when you create or update a
|
|
36
|
-
* user. This ensures that the user can't access anything outside of their home directory. The
|
|
37
|
-
* programmatic way to configure this behavior is to update the user. Set their
|
|
38
|
-
* <code>HomeDirectoryType</code> to <code>LOGICAL</code>, and specify
|
|
39
|
-
* <code>HomeDirectoryMappings</code> with <code>Entry</code> as root (<code>/</code>) and
|
|
40
|
-
* <code>Target</code> as their home directory.</p>
|
|
41
|
-
* <p>For example, if the user's home directory is <code>/test/admin-user</code>, the following
|
|
42
|
-
* command updates the user so that their configuration in the console shows the
|
|
43
|
-
* <i>Restricted</i> flag as selected.</p>
|
|
44
|
-
* <p>
|
|
45
|
-
* <code> aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[\{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"\}]"</code>
|
|
46
|
-
* </p>
|
|
30
|
+
* <p>Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the <code>UserName</code> and <code>ServerId</code> you specify.</p> <p>The response returns the <code>ServerId</code> and the <code>UserName</code> for the updated user.</p> <p>In the console, you can select <i>Restricted</i> when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to configure this behavior is to update the user. Set their <code>HomeDirectoryType</code> to <code>LOGICAL</code>, and specify <code>HomeDirectoryMappings</code> with <code>Entry</code> as root (<code>/</code>) and <code>Target</code> as their home directory.</p> <p>For example, if the user's home directory is <code>/test/admin-user</code>, the following command updates the user so that their configuration in the console shows the <i>Restricted</i> flag as selected.</p> <p> <code> aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[\{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"\}]"</code> </p>
|
|
47
31
|
* @example
|
|
48
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
49
33
|
* ```javascript
|
|
@@ -94,8 +78,7 @@ declare const UpdateUserCommand_base: {
|
|
|
94
78
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
95
79
|
*
|
|
96
80
|
* @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>
|
|
81
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
99
82
|
*
|
|
100
83
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
101
84
|
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
@@ -64,9 +64,7 @@ declare const UpdateWebAppCommand_base: {
|
|
|
64
64
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ConflictException} (client fault)
|
|
67
|
-
* <p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer
|
|
68
|
-
* protocol-enabled server that has VPC as the endpoint type and the server's
|
|
69
|
-
* <code>VpcEndpointID</code> is not in the available state.</p>
|
|
67
|
+
* <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>
|
|
70
68
|
*
|
|
71
69
|
* @throws {@link InternalServiceError} (server fault)
|
|
72
70
|
* <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
|
|
@@ -75,8 +73,7 @@ declare const UpdateWebAppCommand_base: {
|
|
|
75
73
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
76
74
|
*
|
|
77
75
|
* @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>
|
|
76
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
80
77
|
*
|
|
81
78
|
* @throws {@link ThrottlingException} (client fault)
|
|
82
79
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -58,9 +58,7 @@ declare const UpdateWebAppCustomizationCommand_base: {
|
|
|
58
58
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ConflictException} (client fault)
|
|
61
|
-
* <p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer
|
|
62
|
-
* protocol-enabled server that has VPC as the endpoint type and the server's
|
|
63
|
-
* <code>VpcEndpointID</code> is not in the available state.</p>
|
|
61
|
+
* <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>
|
|
64
62
|
*
|
|
65
63
|
* @throws {@link InternalServiceError} (server fault)
|
|
66
64
|
* <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
|
|
@@ -69,8 +67,7 @@ declare const UpdateWebAppCustomizationCommand_base: {
|
|
|
69
67
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
70
68
|
*
|
|
71
69
|
* @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>
|
|
70
|
+
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
|
|
74
71
|
*
|
|
75
72
|
* @throws {@link ThrottlingException} (client fault)
|
|
76
73
|
* <p>The request was denied due to request throttling.</p>
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,14 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>Transfer Family is a fully managed service that enables the transfer of files over the File
|
|
3
|
-
* Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File
|
|
4
|
-
* Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.
|
|
5
|
-
* Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3.
|
|
6
|
-
* Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating
|
|
7
|
-
* with existing authentication systems, and providing DNS routing with Amazon Route 53 so
|
|
8
|
-
* nothing changes for your customers and partners, or their applications. With your data in
|
|
9
|
-
* Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and
|
|
10
|
-
* archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and
|
|
11
|
-
* set up.</p>
|
|
2
|
+
* <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>
|
|
12
3
|
*
|
|
13
4
|
* @packageDocumentation
|
|
14
5
|
*/
|