@aws-sdk/client-transfer 3.35.0 → 3.38.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/CHANGELOG.md +47 -0
- package/dist-cjs/Transfer.js +0 -12
- package/dist-cjs/TransferClient.js +0 -17
- package/dist-cjs/commands/CreateAccessCommand.js +0 -30
- package/dist-cjs/commands/CreateServerCommand.js +0 -28
- package/dist-cjs/commands/CreateUserCommand.js +0 -31
- package/dist-cjs/commands/CreateWorkflowCommand.js +0 -28
- package/dist-cjs/commands/DeleteAccessCommand.js +0 -26
- package/dist-cjs/commands/DeleteServerCommand.js +0 -27
- package/dist-cjs/commands/DeleteSshPublicKeyCommand.js +0 -25
- package/dist-cjs/commands/DeleteUserCommand.js +0 -31
- package/dist-cjs/commands/DeleteWorkflowCommand.js +0 -25
- package/dist-cjs/commands/DescribeAccessCommand.js +0 -30
- package/dist-cjs/commands/DescribeExecutionCommand.js +0 -25
- package/dist-cjs/commands/DescribeSecurityPolicyCommand.js +0 -28
- package/dist-cjs/commands/DescribeServerCommand.js +0 -30
- package/dist-cjs/commands/DescribeUserCommand.js +0 -29
- package/dist-cjs/commands/DescribeWorkflowCommand.js +0 -25
- package/dist-cjs/commands/ImportSshPublicKeyCommand.js +0 -30
- package/dist-cjs/commands/ListAccessesCommand.js +0 -25
- package/dist-cjs/commands/ListExecutionsCommand.js +0 -25
- package/dist-cjs/commands/ListSecurityPoliciesCommand.js +0 -26
- package/dist-cjs/commands/ListServersCommand.js +0 -26
- package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -26
- package/dist-cjs/commands/ListUsersCommand.js +0 -26
- package/dist-cjs/commands/ListWorkflowsCommand.js +0 -25
- package/dist-cjs/commands/SendWorkflowStepStateCommand.js +0 -29
- package/dist-cjs/commands/StartServerCommand.js +0 -33
- package/dist-cjs/commands/StopServerCommand.js +0 -39
- package/dist-cjs/commands/TagResourceCommand.js +0 -28
- package/dist-cjs/commands/TestIdentityProviderCommand.js +0 -63
- package/dist-cjs/commands/UntagResourceCommand.js +0 -28
- package/dist-cjs/commands/UpdateAccessCommand.js +0 -26
- package/dist-cjs/commands/UpdateServerCommand.js +0 -29
- package/dist-cjs/commands/UpdateUserCommand.js +0 -30
- package/dist-cjs/commands/index.js +35 -0
- package/dist-cjs/endpoints.js +1 -2
- package/dist-cjs/index.js +4 -43
- package/dist-cjs/models/index.js +0 -1
- package/dist-cjs/models/models_0.js +0 -304
- package/dist-cjs/pagination/Interfaces.js +0 -1
- package/dist-cjs/pagination/ListAccessesPaginator.js +0 -11
- package/dist-cjs/pagination/ListExecutionsPaginator.js +0 -11
- package/dist-cjs/pagination/ListSecurityPoliciesPaginator.js +0 -11
- package/dist-cjs/pagination/ListServersPaginator.js +0 -11
- package/dist-cjs/pagination/ListTagsForResourcePaginator.js +0 -11
- package/dist-cjs/pagination/ListUsersPaginator.js +0 -11
- package/dist-cjs/pagination/ListWorkflowsPaginator.js +0 -11
- package/dist-cjs/pagination/index.js +11 -0
- package/dist-cjs/protocols/Aws_json1_1.js +0 -6
- package/dist-cjs/runtimeConfig.browser.js +1 -6
- package/dist-cjs/runtimeConfig.js +2 -7
- package/dist-cjs/runtimeConfig.native.js +0 -4
- package/dist-cjs/runtimeConfig.shared.js +0 -4
- package/dist-es/Transfer.js +0 -1
- package/dist-es/TransferClient.js +0 -1
- package/dist-es/commands/CreateAccessCommand.js +0 -1
- package/dist-es/commands/CreateServerCommand.js +0 -1
- package/dist-es/commands/CreateUserCommand.js +0 -1
- package/dist-es/commands/CreateWorkflowCommand.js +0 -1
- package/dist-es/commands/DeleteAccessCommand.js +0 -1
- package/dist-es/commands/DeleteServerCommand.js +0 -1
- package/dist-es/commands/DeleteSshPublicKeyCommand.js +0 -1
- package/dist-es/commands/DeleteUserCommand.js +0 -1
- package/dist-es/commands/DeleteWorkflowCommand.js +0 -1
- package/dist-es/commands/DescribeAccessCommand.js +0 -1
- package/dist-es/commands/DescribeExecutionCommand.js +0 -1
- package/dist-es/commands/DescribeSecurityPolicyCommand.js +0 -1
- package/dist-es/commands/DescribeServerCommand.js +0 -1
- package/dist-es/commands/DescribeUserCommand.js +0 -1
- package/dist-es/commands/DescribeWorkflowCommand.js +0 -1
- package/dist-es/commands/ImportSshPublicKeyCommand.js +0 -1
- package/dist-es/commands/ListAccessesCommand.js +0 -1
- package/dist-es/commands/ListExecutionsCommand.js +0 -1
- package/dist-es/commands/ListSecurityPoliciesCommand.js +0 -1
- package/dist-es/commands/ListServersCommand.js +0 -1
- package/dist-es/commands/ListTagsForResourceCommand.js +0 -1
- package/dist-es/commands/ListUsersCommand.js +0 -1
- package/dist-es/commands/ListWorkflowsCommand.js +0 -1
- package/dist-es/commands/SendWorkflowStepStateCommand.js +0 -1
- package/dist-es/commands/StartServerCommand.js +0 -1
- package/dist-es/commands/StopServerCommand.js +0 -1
- package/dist-es/commands/TagResourceCommand.js +0 -1
- package/dist-es/commands/TestIdentityProviderCommand.js +0 -1
- package/dist-es/commands/UntagResourceCommand.js +0 -1
- package/dist-es/commands/UpdateAccessCommand.js +0 -1
- package/dist-es/commands/UpdateServerCommand.js +0 -1
- package/dist-es/commands/UpdateUserCommand.js +0 -1
- package/dist-es/commands/index.js +32 -0
- package/dist-es/endpoints.js +1 -2
- package/dist-es/index.js +4 -43
- package/dist-es/models/index.js +0 -1
- package/dist-es/models/models_0.js +0 -1
- package/dist-es/pagination/Interfaces.js +0 -1
- package/dist-es/pagination/ListAccessesPaginator.js +0 -1
- package/dist-es/pagination/ListExecutionsPaginator.js +0 -1
- package/dist-es/pagination/ListSecurityPoliciesPaginator.js +0 -1
- package/dist-es/pagination/ListServersPaginator.js +0 -1
- package/dist-es/pagination/ListTagsForResourcePaginator.js +0 -1
- package/dist-es/pagination/ListUsersPaginator.js +0 -1
- package/dist-es/pagination/ListWorkflowsPaginator.js +0 -1
- package/dist-es/pagination/index.js +8 -0
- package/dist-es/protocols/Aws_json1_1.js +0 -1
- package/dist-es/runtimeConfig.browser.js +1 -2
- package/dist-es/runtimeConfig.js +2 -3
- package/dist-es/runtimeConfig.native.js +0 -1
- package/dist-es/runtimeConfig.shared.js +0 -1
- package/dist-types/commands/index.d.ts +32 -0
- package/dist-types/index.d.ts +4 -42
- package/dist-types/pagination/index.d.ts +8 -0
- package/dist-types/ts3.4/Transfer.d.ts +33 -239
- package/dist-types/ts3.4/TransferClient.d.ts +24 -97
- package/dist-types/ts3.4/commands/CreateAccessCommand.d.ts +2 -25
- package/dist-types/ts3.4/commands/CreateServerCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +2 -26
- package/dist-types/ts3.4/commands/CreateWorkflowCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/DeleteAccessCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/DeleteServerCommand.d.ts +2 -22
- package/dist-types/ts3.4/commands/DeleteSshPublicKeyCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +2 -26
- package/dist-types/ts3.4/commands/DeleteWorkflowCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DescribeAccessCommand.d.ts +2 -25
- package/dist-types/ts3.4/commands/DescribeExecutionCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DescribeSecurityPolicyCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/DescribeServerCommand.d.ts +2 -25
- package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/DescribeWorkflowCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/ImportSshPublicKeyCommand.d.ts +2 -25
- package/dist-types/ts3.4/commands/ListAccessesCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/ListSecurityPoliciesCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/ListServersCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/ListWorkflowsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/SendWorkflowStepStateCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/StartServerCommand.d.ts +2 -28
- package/dist-types/ts3.4/commands/StopServerCommand.d.ts +2 -34
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/TestIdentityProviderCommand.d.ts +2 -58
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/UpdateAccessCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/UpdateServerCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +2 -25
- package/dist-types/ts3.4/commands/index.d.ts +32 -0
- package/dist-types/ts3.4/index.d.ts +4 -42
- package/dist-types/ts3.4/models/models_0.d.ts +451 -2421
- package/dist-types/ts3.4/pagination/index.d.ts +8 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
- package/package.json +33 -30
- package/dist-cjs/Transfer.js.map +0 -1
- package/dist-cjs/TransferClient.js.map +0 -1
- package/dist-cjs/commands/CreateAccessCommand.js.map +0 -1
- package/dist-cjs/commands/CreateServerCommand.js.map +0 -1
- package/dist-cjs/commands/CreateUserCommand.js.map +0 -1
- package/dist-cjs/commands/CreateWorkflowCommand.js.map +0 -1
- package/dist-cjs/commands/DeleteAccessCommand.js.map +0 -1
- package/dist-cjs/commands/DeleteServerCommand.js.map +0 -1
- package/dist-cjs/commands/DeleteSshPublicKeyCommand.js.map +0 -1
- package/dist-cjs/commands/DeleteUserCommand.js.map +0 -1
- package/dist-cjs/commands/DeleteWorkflowCommand.js.map +0 -1
- package/dist-cjs/commands/DescribeAccessCommand.js.map +0 -1
- package/dist-cjs/commands/DescribeExecutionCommand.js.map +0 -1
- package/dist-cjs/commands/DescribeSecurityPolicyCommand.js.map +0 -1
- package/dist-cjs/commands/DescribeServerCommand.js.map +0 -1
- package/dist-cjs/commands/DescribeUserCommand.js.map +0 -1
- package/dist-cjs/commands/DescribeWorkflowCommand.js.map +0 -1
- package/dist-cjs/commands/ImportSshPublicKeyCommand.js.map +0 -1
- package/dist-cjs/commands/ListAccessesCommand.js.map +0 -1
- package/dist-cjs/commands/ListExecutionsCommand.js.map +0 -1
- package/dist-cjs/commands/ListSecurityPoliciesCommand.js.map +0 -1
- package/dist-cjs/commands/ListServersCommand.js.map +0 -1
- package/dist-cjs/commands/ListTagsForResourceCommand.js.map +0 -1
- package/dist-cjs/commands/ListUsersCommand.js.map +0 -1
- package/dist-cjs/commands/ListWorkflowsCommand.js.map +0 -1
- package/dist-cjs/commands/SendWorkflowStepStateCommand.js.map +0 -1
- package/dist-cjs/commands/StartServerCommand.js.map +0 -1
- package/dist-cjs/commands/StopServerCommand.js.map +0 -1
- package/dist-cjs/commands/TagResourceCommand.js.map +0 -1
- package/dist-cjs/commands/TestIdentityProviderCommand.js.map +0 -1
- package/dist-cjs/commands/UntagResourceCommand.js.map +0 -1
- package/dist-cjs/commands/UpdateAccessCommand.js.map +0 -1
- package/dist-cjs/commands/UpdateServerCommand.js.map +0 -1
- package/dist-cjs/commands/UpdateUserCommand.js.map +0 -1
- package/dist-cjs/endpoints.js.map +0 -1
- package/dist-cjs/index.js.map +0 -1
- package/dist-cjs/models/index.js.map +0 -1
- package/dist-cjs/models/models_0.js.map +0 -1
- package/dist-cjs/pagination/Interfaces.js.map +0 -1
- package/dist-cjs/pagination/ListAccessesPaginator.js.map +0 -1
- package/dist-cjs/pagination/ListExecutionsPaginator.js.map +0 -1
- package/dist-cjs/pagination/ListSecurityPoliciesPaginator.js.map +0 -1
- package/dist-cjs/pagination/ListServersPaginator.js.map +0 -1
- package/dist-cjs/pagination/ListTagsForResourcePaginator.js.map +0 -1
- package/dist-cjs/pagination/ListUsersPaginator.js.map +0 -1
- package/dist-cjs/pagination/ListWorkflowsPaginator.js.map +0 -1
- package/dist-cjs/protocols/Aws_json1_1.js.map +0 -1
- package/dist-cjs/runtimeConfig.browser.js.map +0 -1
- package/dist-cjs/runtimeConfig.js.map +0 -1
- package/dist-cjs/runtimeConfig.native.js.map +0 -1
- package/dist-cjs/runtimeConfig.shared.js.map +0 -1
- package/dist-es/Transfer.js.map +0 -1
- package/dist-es/TransferClient.js.map +0 -1
- package/dist-es/commands/CreateAccessCommand.js.map +0 -1
- package/dist-es/commands/CreateServerCommand.js.map +0 -1
- package/dist-es/commands/CreateUserCommand.js.map +0 -1
- package/dist-es/commands/CreateWorkflowCommand.js.map +0 -1
- package/dist-es/commands/DeleteAccessCommand.js.map +0 -1
- package/dist-es/commands/DeleteServerCommand.js.map +0 -1
- package/dist-es/commands/DeleteSshPublicKeyCommand.js.map +0 -1
- package/dist-es/commands/DeleteUserCommand.js.map +0 -1
- package/dist-es/commands/DeleteWorkflowCommand.js.map +0 -1
- package/dist-es/commands/DescribeAccessCommand.js.map +0 -1
- package/dist-es/commands/DescribeExecutionCommand.js.map +0 -1
- package/dist-es/commands/DescribeSecurityPolicyCommand.js.map +0 -1
- package/dist-es/commands/DescribeServerCommand.js.map +0 -1
- package/dist-es/commands/DescribeUserCommand.js.map +0 -1
- package/dist-es/commands/DescribeWorkflowCommand.js.map +0 -1
- package/dist-es/commands/ImportSshPublicKeyCommand.js.map +0 -1
- package/dist-es/commands/ListAccessesCommand.js.map +0 -1
- package/dist-es/commands/ListExecutionsCommand.js.map +0 -1
- package/dist-es/commands/ListSecurityPoliciesCommand.js.map +0 -1
- package/dist-es/commands/ListServersCommand.js.map +0 -1
- package/dist-es/commands/ListTagsForResourceCommand.js.map +0 -1
- package/dist-es/commands/ListUsersCommand.js.map +0 -1
- package/dist-es/commands/ListWorkflowsCommand.js.map +0 -1
- package/dist-es/commands/SendWorkflowStepStateCommand.js.map +0 -1
- package/dist-es/commands/StartServerCommand.js.map +0 -1
- package/dist-es/commands/StopServerCommand.js.map +0 -1
- package/dist-es/commands/TagResourceCommand.js.map +0 -1
- package/dist-es/commands/TestIdentityProviderCommand.js.map +0 -1
- package/dist-es/commands/UntagResourceCommand.js.map +0 -1
- package/dist-es/commands/UpdateAccessCommand.js.map +0 -1
- package/dist-es/commands/UpdateServerCommand.js.map +0 -1
- package/dist-es/commands/UpdateUserCommand.js.map +0 -1
- package/dist-es/endpoints.js.map +0 -1
- package/dist-es/index.js.map +0 -1
- package/dist-es/models/index.js.map +0 -1
- package/dist-es/models/models_0.js.map +0 -1
- package/dist-es/pagination/Interfaces.js.map +0 -1
- package/dist-es/pagination/ListAccessesPaginator.js.map +0 -1
- package/dist-es/pagination/ListExecutionsPaginator.js.map +0 -1
- package/dist-es/pagination/ListSecurityPoliciesPaginator.js.map +0 -1
- package/dist-es/pagination/ListServersPaginator.js.map +0 -1
- package/dist-es/pagination/ListTagsForResourcePaginator.js.map +0 -1
- package/dist-es/pagination/ListUsersPaginator.js.map +0 -1
- package/dist-es/pagination/ListWorkflowsPaginator.js.map +0 -1
- package/dist-es/protocols/Aws_json1_1.js.map +0 -1
- package/dist-es/runtimeConfig.browser.js.map +0 -1
- package/dist-es/runtimeConfig.js.map +0 -1
- package/dist-es/runtimeConfig.native.js.map +0 -1
- package/dist-es/runtimeConfig.shared.js.map +0 -1
- package/jest.config.js +0 -4
- package/src/Transfer.ts +0 -1228
- package/src/TransferClient.ts +0 -355
- package/src/commands/CreateAccessCommand.ts +0 -100
- package/src/commands/CreateServerCommand.ts +0 -98
- package/src/commands/CreateUserCommand.ts +0 -101
- package/src/commands/CreateWorkflowCommand.ts +0 -98
- package/src/commands/DeleteAccessCommand.ts +0 -96
- package/src/commands/DeleteServerCommand.ts +0 -97
- package/src/commands/DeleteSshPublicKeyCommand.ts +0 -95
- package/src/commands/DeleteUserCommand.ts +0 -101
- package/src/commands/DeleteWorkflowCommand.ts +0 -95
- package/src/commands/DescribeAccessCommand.ts +0 -100
- package/src/commands/DescribeExecutionCommand.ts +0 -95
- package/src/commands/DescribeSecurityPolicyCommand.ts +0 -98
- package/src/commands/DescribeServerCommand.ts +0 -100
- package/src/commands/DescribeUserCommand.ts +0 -99
- package/src/commands/DescribeWorkflowCommand.ts +0 -95
- package/src/commands/ImportSshPublicKeyCommand.ts +0 -100
- package/src/commands/ListAccessesCommand.ts +0 -95
- package/src/commands/ListExecutionsCommand.ts +0 -95
- package/src/commands/ListSecurityPoliciesCommand.ts +0 -96
- package/src/commands/ListServersCommand.ts +0 -96
- package/src/commands/ListTagsForResourceCommand.ts +0 -96
- package/src/commands/ListUsersCommand.ts +0 -93
- package/src/commands/ListWorkflowsCommand.ts +0 -95
- package/src/commands/SendWorkflowStepStateCommand.ts +0 -99
- package/src/commands/StartServerCommand.ts +0 -103
- package/src/commands/StopServerCommand.ts +0 -109
- package/src/commands/TagResourceCommand.ts +0 -98
- package/src/commands/TestIdentityProviderCommand.ts +0 -133
- package/src/commands/UntagResourceCommand.ts +0 -98
- package/src/commands/UpdateAccessCommand.ts +0 -96
- package/src/commands/UpdateServerCommand.ts +0 -99
- package/src/commands/UpdateUserCommand.ts +0 -100
- package/src/endpoints.ts +0 -91
- package/src/index.ts +0 -43
- package/src/models/index.ts +0 -1
- package/src/models/models_0.ts +0 -3943
- package/src/pagination/Interfaces.ts +0 -8
- package/src/pagination/ListAccessesPaginator.ts +0 -59
- package/src/pagination/ListExecutionsPaginator.ts +0 -59
- package/src/pagination/ListSecurityPoliciesPaginator.ts +0 -59
- package/src/pagination/ListServersPaginator.ts +0 -55
- package/src/pagination/ListTagsForResourcePaginator.ts +0 -59
- package/src/pagination/ListUsersPaginator.ts +0 -55
- package/src/pagination/ListWorkflowsPaginator.ts +0 -59
- package/src/protocols/Aws_json1_1.ts +0 -5079
- package/src/runtimeConfig.browser.ts +0 -41
- package/src/runtimeConfig.native.ts +0 -17
- package/src/runtimeConfig.shared.ts +0 -17
- package/src/runtimeConfig.ts +0 -46
- package/tsconfig.es.json +0 -10
- package/tsconfig.json +0 -33
- package/tsconfig.types.json +0 -9
|
@@ -1,348 +1,155 @@
|
|
|
1
1
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
2
|
-
|
|
3
|
-
* <p>You do not have sufficient access to perform this action.</p>
|
|
4
|
-
*/
|
|
2
|
+
|
|
5
3
|
export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
|
|
6
4
|
name: "AccessDeniedException";
|
|
7
5
|
$fault: "client";
|
|
8
6
|
Message?: string;
|
|
9
7
|
}
|
|
10
8
|
export declare namespace AccessDeniedException {
|
|
11
|
-
|
|
12
|
-
* @internal
|
|
13
|
-
*/
|
|
9
|
+
|
|
14
10
|
const filterSensitiveLog: (obj: AccessDeniedException) => any;
|
|
15
11
|
}
|
|
16
|
-
|
|
17
|
-
* <p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer
|
|
18
|
-
* protocol-enabled server that has VPC as the endpoint type and the server's
|
|
19
|
-
* <code>VpcEndpointID</code> is not in the available state.</p>
|
|
20
|
-
*/
|
|
12
|
+
|
|
21
13
|
export interface ConflictException extends __SmithyException, $MetadataBearer {
|
|
22
14
|
name: "ConflictException";
|
|
23
15
|
$fault: "client";
|
|
24
16
|
Message: string | undefined;
|
|
25
17
|
}
|
|
26
18
|
export declare namespace ConflictException {
|
|
27
|
-
|
|
28
|
-
* @internal
|
|
29
|
-
*/
|
|
19
|
+
|
|
30
20
|
const filterSensitiveLog: (obj: ConflictException) => any;
|
|
31
21
|
}
|
|
32
|
-
|
|
33
|
-
* <p>Reserved for future use.</p>
|
|
34
|
-
* <p>
|
|
35
|
-
*
|
|
36
|
-
* </p>
|
|
37
|
-
*/
|
|
22
|
+
|
|
38
23
|
export interface EfsFileLocation {
|
|
39
|
-
|
|
40
|
-
* <p>The ID of the file system, assigned by Amazon EFS.</p>
|
|
41
|
-
*/
|
|
24
|
+
|
|
42
25
|
FileSystemId?: string;
|
|
43
|
-
|
|
44
|
-
* <p>The pathname for the folder being used by a workflow.</p>
|
|
45
|
-
*/
|
|
26
|
+
|
|
46
27
|
Path?: string;
|
|
47
28
|
}
|
|
48
29
|
export declare namespace EfsFileLocation {
|
|
49
|
-
|
|
50
|
-
* @internal
|
|
51
|
-
*/
|
|
30
|
+
|
|
52
31
|
const filterSensitiveLog: (obj: EfsFileLocation) => any;
|
|
53
32
|
}
|
|
54
|
-
|
|
55
|
-
* <p>Specifies the customer input S3 file location. If it is used inside <code>copyStepDetails.DestinationFileLocation</code>, it should be the S3 copy destination.</p>
|
|
56
|
-
* <p>
|
|
57
|
-
* You need to provide the bucket and key.
|
|
58
|
-
* The key can represent either a path or a file.
|
|
59
|
-
* This is determined by whether or not you end the key value with the forward slash (/) character.
|
|
60
|
-
* If the final character is "/", then your file is copied to the folder, and its name does not change.
|
|
61
|
-
* If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.
|
|
62
|
-
* </p>
|
|
63
|
-
* <p>For example, if your path is <code>shared-files/bob/</code>, your uploaded files are copied to the <code>shared-files/bob/</code>, folder.
|
|
64
|
-
* If your path is <code>shared-files/today</code>, each uploaded file is copied to the <code>shared-files</code> folder and named <code>today</code>:
|
|
65
|
-
* each upload overwrites the previous version of the <i>bob</i> file.</p>
|
|
66
|
-
*/
|
|
33
|
+
|
|
67
34
|
export interface S3InputFileLocation {
|
|
68
|
-
|
|
69
|
-
* <p>Specifies the S3 bucket for the customer input file.</p>
|
|
70
|
-
*/
|
|
35
|
+
|
|
71
36
|
Bucket?: string;
|
|
72
|
-
|
|
73
|
-
* <p>The name assigned to the file when it was created in S3. You use the object key to retrieve the object.</p>
|
|
74
|
-
*/
|
|
37
|
+
|
|
75
38
|
Key?: string;
|
|
76
39
|
}
|
|
77
40
|
export declare namespace S3InputFileLocation {
|
|
78
|
-
|
|
79
|
-
* @internal
|
|
80
|
-
*/
|
|
41
|
+
|
|
81
42
|
const filterSensitiveLog: (obj: S3InputFileLocation) => any;
|
|
82
43
|
}
|
|
83
|
-
|
|
84
|
-
* <p>Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.</p>
|
|
85
|
-
*/
|
|
44
|
+
|
|
86
45
|
export interface InputFileLocation {
|
|
87
|
-
|
|
88
|
-
* <p>Specifies the details for the S3 file being copied.</p>
|
|
89
|
-
*/
|
|
46
|
+
|
|
90
47
|
S3FileLocation?: S3InputFileLocation;
|
|
91
|
-
|
|
92
|
-
* <p>Reserved for future use.</p>
|
|
93
|
-
*/
|
|
48
|
+
|
|
94
49
|
EfsFileLocation?: EfsFileLocation;
|
|
95
50
|
}
|
|
96
51
|
export declare namespace InputFileLocation {
|
|
97
|
-
|
|
98
|
-
* @internal
|
|
99
|
-
*/
|
|
52
|
+
|
|
100
53
|
const filterSensitiveLog: (obj: InputFileLocation) => any;
|
|
101
54
|
}
|
|
102
55
|
export declare enum OverwriteExisting {
|
|
103
56
|
FALSE = "FALSE",
|
|
104
57
|
TRUE = "TRUE"
|
|
105
58
|
}
|
|
106
|
-
|
|
107
|
-
* <p>Each step type has its own <code>StepDetails</code> structure.</p>
|
|
108
|
-
*/
|
|
59
|
+
|
|
109
60
|
export interface CopyStepDetails {
|
|
110
|
-
|
|
111
|
-
* <p>The name of the step, used as an identifier.</p>
|
|
112
|
-
*/
|
|
61
|
+
|
|
113
62
|
Name?: string;
|
|
114
|
-
|
|
115
|
-
* <p>Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.</p>
|
|
116
|
-
*/
|
|
63
|
+
|
|
117
64
|
DestinationFileLocation?: InputFileLocation;
|
|
118
|
-
|
|
119
|
-
* <p>A flag that indicates whether or not to overwrite an existing file of the same name.
|
|
120
|
-
* The default is <code>FALSE</code>.</p>
|
|
121
|
-
*/
|
|
65
|
+
|
|
122
66
|
OverwriteExisting?: OverwriteExisting | string;
|
|
123
67
|
}
|
|
124
68
|
export declare namespace CopyStepDetails {
|
|
125
|
-
|
|
126
|
-
* @internal
|
|
127
|
-
*/
|
|
69
|
+
|
|
128
70
|
const filterSensitiveLog: (obj: CopyStepDetails) => any;
|
|
129
71
|
}
|
|
130
|
-
|
|
131
|
-
* <p>Represents an object that contains entries and targets for
|
|
132
|
-
* <code>HomeDirectoryMappings</code>.</p>
|
|
133
|
-
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>
|
|
134
|
-
* <p>
|
|
135
|
-
* <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
|
|
136
|
-
* </p>
|
|
137
|
-
*
|
|
138
|
-
* <note>
|
|
139
|
-
* <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
|
|
140
|
-
* ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
|
|
141
|
-
* holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
|
|
142
|
-
* <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
|
|
143
|
-
* following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
|
|
144
|
-
* sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
|
|
145
|
-
* </note>
|
|
146
|
-
*/
|
|
72
|
+
|
|
147
73
|
export interface HomeDirectoryMapEntry {
|
|
148
|
-
|
|
149
|
-
* <p>Represents an entry for <code>HomeDirectoryMappings</code>.</p>
|
|
150
|
-
*/
|
|
74
|
+
|
|
151
75
|
Entry: string | undefined;
|
|
152
|
-
|
|
153
|
-
* <p>Represents the map target that is used in a <code>HomeDirectorymapEntry</code>.</p>
|
|
154
|
-
*/
|
|
76
|
+
|
|
155
77
|
Target: string | undefined;
|
|
156
78
|
}
|
|
157
79
|
export declare namespace HomeDirectoryMapEntry {
|
|
158
|
-
|
|
159
|
-
* @internal
|
|
160
|
-
*/
|
|
80
|
+
|
|
161
81
|
const filterSensitiveLog: (obj: HomeDirectoryMapEntry) => any;
|
|
162
82
|
}
|
|
163
83
|
export declare enum HomeDirectoryType {
|
|
164
84
|
LOGICAL = "LOGICAL",
|
|
165
85
|
PATH = "PATH"
|
|
166
86
|
}
|
|
167
|
-
|
|
168
|
-
* <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
|
|
169
|
-
* (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
|
|
170
|
-
* your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
|
|
171
|
-
* files and directories in your file system determine the level of access your users get when
|
|
172
|
-
* transferring files into and out of your Amazon EFS file systems.</p>
|
|
173
|
-
*/
|
|
87
|
+
|
|
174
88
|
export interface PosixProfile {
|
|
175
|
-
|
|
176
|
-
* <p>The POSIX user ID used for all EFS operations by this user.</p>
|
|
177
|
-
*/
|
|
89
|
+
|
|
178
90
|
Uid: number | undefined;
|
|
179
|
-
|
|
180
|
-
* <p>The POSIX group ID used for all EFS operations by this user.</p>
|
|
181
|
-
*/
|
|
91
|
+
|
|
182
92
|
Gid: number | undefined;
|
|
183
|
-
|
|
184
|
-
* <p>The secondary POSIX group IDs used for all EFS operations by this user.</p>
|
|
185
|
-
*/
|
|
93
|
+
|
|
186
94
|
SecondaryGids?: number[];
|
|
187
95
|
}
|
|
188
96
|
export declare namespace PosixProfile {
|
|
189
|
-
|
|
190
|
-
* @internal
|
|
191
|
-
*/
|
|
97
|
+
|
|
192
98
|
const filterSensitiveLog: (obj: PosixProfile) => any;
|
|
193
99
|
}
|
|
194
100
|
export interface CreateAccessRequest {
|
|
195
|
-
|
|
196
|
-
* <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
|
|
197
|
-
* <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
|
|
198
|
-
*/
|
|
101
|
+
|
|
199
102
|
HomeDirectory?: string;
|
|
200
|
-
|
|
201
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
|
|
202
|
-
* If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
|
|
203
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
|
|
204
|
-
* S3 or EFS paths visible to your users.</p>
|
|
205
|
-
*/
|
|
103
|
+
|
|
206
104
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
207
|
-
|
|
208
|
-
* <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
|
|
209
|
-
* be visible to your user and how you want to make them visible. You must specify the
|
|
210
|
-
* <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
|
|
211
|
-
* is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
|
|
212
|
-
* only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity
|
|
213
|
-
* and Access Management (IAM) role provides access to paths in <code>Target</code>. This value
|
|
214
|
-
* can only be set when <code>HomeDirectoryType</code> is set to
|
|
215
|
-
* <i>LOGICAL</i>.</p>
|
|
216
|
-
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>
|
|
217
|
-
* <p>
|
|
218
|
-
* <code>[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]</code>
|
|
219
|
-
* </p>
|
|
220
|
-
* <p>In most cases, you can use this value instead of the session policy to lock down your
|
|
221
|
-
* user to the designated home directory ("<code>chroot</code>"). To do this, you can set
|
|
222
|
-
* <code>Entry</code> to <code>/</code> and set <code>Target</code> to the
|
|
223
|
-
* <code>HomeDirectory</code> parameter value.</p>
|
|
224
|
-
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>
|
|
225
|
-
* <p>
|
|
226
|
-
* <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
|
|
227
|
-
* </p>
|
|
228
|
-
*
|
|
229
|
-
* <note>
|
|
230
|
-
* <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
|
|
231
|
-
* ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
|
|
232
|
-
* holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
|
|
233
|
-
* <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
|
|
234
|
-
* following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
|
|
235
|
-
* sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
|
|
236
|
-
* </note>
|
|
237
|
-
*/
|
|
105
|
+
|
|
238
106
|
HomeDirectoryMappings?: HomeDirectoryMapEntry[];
|
|
239
|
-
|
|
240
|
-
* <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
|
|
241
|
-
* access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
|
|
242
|
-
* <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
|
|
243
|
-
*
|
|
244
|
-
* <note>
|
|
245
|
-
* <p>This only applies when the domain of <code>ServerId</code> is S3. EFS does not use session policies.</p>
|
|
246
|
-
* <p>For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead
|
|
247
|
-
* of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass
|
|
248
|
-
* it in the <code>Policy</code> argument.</p>
|
|
249
|
-
* <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html">Example
|
|
250
|
-
* session policy</a>.</p>
|
|
251
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Amazon Web Services Security Token Service API
|
|
252
|
-
* Reference</i>.</p>
|
|
253
|
-
* </note>
|
|
254
|
-
*/
|
|
107
|
+
|
|
255
108
|
Policy?: string;
|
|
256
|
-
|
|
257
|
-
* <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
|
|
258
|
-
* (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
|
|
259
|
-
* your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
|
|
260
|
-
* files and directories in your file system determine the level of access your users get when
|
|
261
|
-
* transferring files into and out of your Amazon EFS file systems.</p>
|
|
262
|
-
*/
|
|
109
|
+
|
|
263
110
|
PosixProfile?: PosixProfile;
|
|
264
|
-
|
|
265
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
|
|
266
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
|
|
267
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
|
|
268
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
269
|
-
*/
|
|
111
|
+
|
|
270
112
|
Role: string | undefined;
|
|
271
|
-
|
|
272
|
-
* <p>A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.</p>
|
|
273
|
-
*/
|
|
113
|
+
|
|
274
114
|
ServerId: string | undefined;
|
|
275
|
-
|
|
276
|
-
* <p>A unique identifier that is required to identify specific groups within your directory.
|
|
277
|
-
* The users of the group that you associate have access to your Amazon S3 or Amazon EFS
|
|
278
|
-
* resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,
|
|
279
|
-
* you can view the SID values by running the following command using Windows PowerShell.</p>
|
|
280
|
-
*
|
|
281
|
-
* <p>
|
|
282
|
-
* <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code>
|
|
283
|
-
* </p>
|
|
284
|
-
*
|
|
285
|
-
* <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
|
|
286
|
-
*
|
|
287
|
-
* <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
|
|
288
|
-
* You can also include underscores or any of the following characters: =,.@:/-</p>
|
|
289
|
-
*/
|
|
115
|
+
|
|
290
116
|
ExternalId: string | undefined;
|
|
291
117
|
}
|
|
292
118
|
export declare namespace CreateAccessRequest {
|
|
293
|
-
|
|
294
|
-
* @internal
|
|
295
|
-
*/
|
|
119
|
+
|
|
296
120
|
const filterSensitiveLog: (obj: CreateAccessRequest) => any;
|
|
297
121
|
}
|
|
298
122
|
export interface CreateAccessResponse {
|
|
299
|
-
|
|
300
|
-
* <p>The ID of the server that the user is attached to.</p>
|
|
301
|
-
*/
|
|
123
|
+
|
|
302
124
|
ServerId: string | undefined;
|
|
303
|
-
|
|
304
|
-
* <p>The external ID of the group whose users have access to your Amazon S3 or Amazon EFS
|
|
305
|
-
* resources over the enabled protocols using Amazon Web Services Transfer Family.</p>
|
|
306
|
-
*/
|
|
125
|
+
|
|
307
126
|
ExternalId: string | undefined;
|
|
308
127
|
}
|
|
309
128
|
export declare namespace CreateAccessResponse {
|
|
310
|
-
|
|
311
|
-
* @internal
|
|
312
|
-
*/
|
|
129
|
+
|
|
313
130
|
const filterSensitiveLog: (obj: CreateAccessResponse) => any;
|
|
314
131
|
}
|
|
315
|
-
|
|
316
|
-
* <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
|
|
317
|
-
*/
|
|
132
|
+
|
|
318
133
|
export interface InternalServiceError extends __SmithyException, $MetadataBearer {
|
|
319
134
|
name: "InternalServiceError";
|
|
320
135
|
$fault: "server";
|
|
321
136
|
Message: string | undefined;
|
|
322
137
|
}
|
|
323
138
|
export declare namespace InternalServiceError {
|
|
324
|
-
|
|
325
|
-
* @internal
|
|
326
|
-
*/
|
|
139
|
+
|
|
327
140
|
const filterSensitiveLog: (obj: InternalServiceError) => any;
|
|
328
141
|
}
|
|
329
|
-
|
|
330
|
-
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
331
|
-
*/
|
|
142
|
+
|
|
332
143
|
export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
|
|
333
144
|
name: "InvalidRequestException";
|
|
334
145
|
$fault: "client";
|
|
335
146
|
Message: string | undefined;
|
|
336
147
|
}
|
|
337
148
|
export declare namespace InvalidRequestException {
|
|
338
|
-
|
|
339
|
-
* @internal
|
|
340
|
-
*/
|
|
149
|
+
|
|
341
150
|
const filterSensitiveLog: (obj: InvalidRequestException) => any;
|
|
342
151
|
}
|
|
343
|
-
|
|
344
|
-
* <p>The requested resource does not exist.</p>
|
|
345
|
-
*/
|
|
152
|
+
|
|
346
153
|
export interface ResourceExistsException extends __SmithyException, $MetadataBearer {
|
|
347
154
|
name: "ResourceExistsException";
|
|
348
155
|
$fault: "client";
|
|
@@ -351,15 +158,10 @@ export interface ResourceExistsException extends __SmithyException, $MetadataBea
|
|
|
351
158
|
ResourceType: string | undefined;
|
|
352
159
|
}
|
|
353
160
|
export declare namespace ResourceExistsException {
|
|
354
|
-
|
|
355
|
-
* @internal
|
|
356
|
-
*/
|
|
161
|
+
|
|
357
162
|
const filterSensitiveLog: (obj: ResourceExistsException) => any;
|
|
358
163
|
}
|
|
359
|
-
|
|
360
|
-
* <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
|
|
361
|
-
* service.</p>
|
|
362
|
-
*/
|
|
164
|
+
|
|
363
165
|
export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
|
|
364
166
|
name: "ResourceNotFoundException";
|
|
365
167
|
$fault: "client";
|
|
@@ -368,109 +170,38 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB
|
|
|
368
170
|
ResourceType: string | undefined;
|
|
369
171
|
}
|
|
370
172
|
export declare namespace ResourceNotFoundException {
|
|
371
|
-
|
|
372
|
-
* @internal
|
|
373
|
-
*/
|
|
173
|
+
|
|
374
174
|
const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
|
|
375
175
|
}
|
|
376
|
-
|
|
377
|
-
* <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
|
|
378
|
-
*/
|
|
176
|
+
|
|
379
177
|
export interface ServiceUnavailableException extends __SmithyException, $MetadataBearer {
|
|
380
178
|
name: "ServiceUnavailableException";
|
|
381
179
|
$fault: "server";
|
|
382
180
|
Message?: string;
|
|
383
181
|
}
|
|
384
182
|
export declare namespace ServiceUnavailableException {
|
|
385
|
-
|
|
386
|
-
* @internal
|
|
387
|
-
*/
|
|
183
|
+
|
|
388
184
|
const filterSensitiveLog: (obj: ServiceUnavailableException) => any;
|
|
389
185
|
}
|
|
390
186
|
export declare enum Domain {
|
|
391
187
|
EFS = "EFS",
|
|
392
188
|
S3 = "S3"
|
|
393
189
|
}
|
|
394
|
-
|
|
395
|
-
* <p>The virtual private cloud (VPC) endpoint settings that are configured for your file
|
|
396
|
-
* transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server
|
|
397
|
-
* and resources only within your VPC. To control incoming internet traffic, invoke the
|
|
398
|
-
* <code>UpdateServer</code> API and attach an Elastic IP address to your server's
|
|
399
|
-
* endpoint.</p>
|
|
400
|
-
* <note>
|
|
401
|
-
* <p> After May 19, 2021, you won't be able to create a server using
|
|
402
|
-
* <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Servicesaccount if your account hasn't already
|
|
403
|
-
* done so before May 19, 2021. If you have already created servers with
|
|
404
|
-
* <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Servicesaccount on or before May 19, 2021,
|
|
405
|
-
* you will not be affected. After this date, use
|
|
406
|
-
* <code>EndpointType</code>=<code>VPC</code>.</p>
|
|
407
|
-
*
|
|
408
|
-
* <p>For more information, see
|
|
409
|
-
* https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
|
|
410
|
-
* </note>
|
|
411
|
-
*/
|
|
190
|
+
|
|
412
191
|
export interface EndpointDetails {
|
|
413
|
-
|
|
414
|
-
* <p>A list of address allocation IDs that are required to attach an Elastic IP address to your
|
|
415
|
-
* server's endpoint.</p>
|
|
416
|
-
*
|
|
417
|
-
* <note>
|
|
418
|
-
*
|
|
419
|
-
* <p>This property can only be set when <code>EndpointType</code> is set to <code>VPC</code>
|
|
420
|
-
* and it is only valid in the <code>UpdateServer</code> API.</p>
|
|
421
|
-
* </note>
|
|
422
|
-
*/
|
|
192
|
+
|
|
423
193
|
AddressAllocationIds?: string[];
|
|
424
|
-
|
|
425
|
-
* <p>A list of subnet IDs that are required to host your server endpoint in your VPC.</p>
|
|
426
|
-
*
|
|
427
|
-
* <note>
|
|
428
|
-
* <p>This property can only be set when <code>EndpointType</code> is set to
|
|
429
|
-
* <code>VPC</code>.</p>
|
|
430
|
-
* </note>
|
|
431
|
-
*/
|
|
194
|
+
|
|
432
195
|
SubnetIds?: string[];
|
|
433
|
-
|
|
434
|
-
* <p>The ID of the VPC endpoint.</p>
|
|
435
|
-
*
|
|
436
|
-
* <note>
|
|
437
|
-
* <p>This property can only be set when <code>EndpointType</code> is set to
|
|
438
|
-
* <code>VPC_ENDPOINT</code>.</p>
|
|
439
|
-
*
|
|
440
|
-
* <p>For more information, see
|
|
441
|
-
* https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
|
|
442
|
-
* </note>
|
|
443
|
-
*/
|
|
196
|
+
|
|
444
197
|
VpcEndpointId?: string;
|
|
445
|
-
|
|
446
|
-
* <p>The VPC ID of the VPC in which a server's endpoint will be hosted.</p>
|
|
447
|
-
*
|
|
448
|
-
* <note>
|
|
449
|
-
* <p>This property can only be set when <code>EndpointType</code> is set to
|
|
450
|
-
* <code>VPC</code>.</p>
|
|
451
|
-
* </note>
|
|
452
|
-
*/
|
|
198
|
+
|
|
453
199
|
VpcId?: string;
|
|
454
|
-
|
|
455
|
-
* <p>A list of security groups IDs that are available to attach to your server's
|
|
456
|
-
* endpoint.</p>
|
|
457
|
-
*
|
|
458
|
-
* <note>
|
|
459
|
-
* <p>This property can only be set when <code>EndpointType</code> is set to
|
|
460
|
-
* <code>VPC</code>.</p>
|
|
461
|
-
*
|
|
462
|
-
* <p>You can edit the <code>SecurityGroupIds</code> property in the <a href="https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html">UpdateServer</a> API only if you are changing the <code>EndpointType</code> from
|
|
463
|
-
* <code>PUBLIC</code> or <code>VPC_ENDPOINT</code> to <code>VPC</code>. To change security
|
|
464
|
-
* groups associated with your server's VPC endpoint after creation, use the Amazon EC2
|
|
465
|
-
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html">ModifyVpcEndpoint</a> API.</p>
|
|
466
|
-
* </note>
|
|
467
|
-
*/
|
|
200
|
+
|
|
468
201
|
SecurityGroupIds?: string[];
|
|
469
202
|
}
|
|
470
203
|
export declare namespace EndpointDetails {
|
|
471
|
-
|
|
472
|
-
* @internal
|
|
473
|
-
*/
|
|
204
|
+
|
|
474
205
|
const filterSensitiveLog: (obj: EndpointDetails) => any;
|
|
475
206
|
}
|
|
476
207
|
export declare enum EndpointType {
|
|
@@ -478,30 +209,17 @@ export declare enum EndpointType {
|
|
|
478
209
|
VPC = "VPC",
|
|
479
210
|
VPC_ENDPOINT = "VPC_ENDPOINT"
|
|
480
211
|
}
|
|
481
|
-
|
|
482
|
-
* <p>Returns information related to the type of user authentication that is in use for a file
|
|
483
|
-
* transfer protocol-enabled server's users. A server can have only one method of
|
|
484
|
-
* authentication.</p>
|
|
485
|
-
*/
|
|
212
|
+
|
|
486
213
|
export interface IdentityProviderDetails {
|
|
487
|
-
|
|
488
|
-
* <p>Provides the location of the service endpoint used to authenticate users.</p>
|
|
489
|
-
*/
|
|
214
|
+
|
|
490
215
|
Url?: string;
|
|
491
|
-
|
|
492
|
-
* <p>Provides the type of <code>InvocationRole</code> used to authenticate the user
|
|
493
|
-
* account.</p>
|
|
494
|
-
*/
|
|
216
|
+
|
|
495
217
|
InvocationRole?: string;
|
|
496
|
-
|
|
497
|
-
* <p>The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.</p>
|
|
498
|
-
*/
|
|
218
|
+
|
|
499
219
|
DirectoryId?: string;
|
|
500
220
|
}
|
|
501
221
|
export declare namespace IdentityProviderDetails {
|
|
502
|
-
|
|
503
|
-
* @internal
|
|
504
|
-
*/
|
|
222
|
+
|
|
505
223
|
const filterSensitiveLog: (obj: IdentityProviderDetails) => any;
|
|
506
224
|
}
|
|
507
225
|
export declare enum IdentityProviderType {
|
|
@@ -514,483 +232,163 @@ export declare enum Protocol {
|
|
|
514
232
|
FTPS = "FTPS",
|
|
515
233
|
SFTP = "SFTP"
|
|
516
234
|
}
|
|
517
|
-
|
|
518
|
-
* <p>Creates a key-value pair for a specific resource. Tags are metadata that you can use to
|
|
519
|
-
* search for and group a resource for various purposes. You can apply tags to servers, users,
|
|
520
|
-
* and roles. A tag key can take more than one value. For example, to group servers for
|
|
521
|
-
* accounting purposes, you might create a tag called <code>Group</code> and assign the values
|
|
522
|
-
* <code>Research</code> and <code>Accounting</code> to that group.</p>
|
|
523
|
-
*/
|
|
235
|
+
|
|
524
236
|
export interface Tag {
|
|
525
|
-
|
|
526
|
-
* <p>The name assigned to the tag that you create.</p>
|
|
527
|
-
*/
|
|
237
|
+
|
|
528
238
|
Key: string | undefined;
|
|
529
|
-
|
|
530
|
-
* <p>Contains one or more values that you assigned to the key name you create.</p>
|
|
531
|
-
*/
|
|
239
|
+
|
|
532
240
|
Value: string | undefined;
|
|
533
241
|
}
|
|
534
242
|
export declare namespace Tag {
|
|
535
|
-
|
|
536
|
-
* @internal
|
|
537
|
-
*/
|
|
243
|
+
|
|
538
244
|
const filterSensitiveLog: (obj: Tag) => any;
|
|
539
245
|
}
|
|
540
|
-
|
|
541
|
-
* <p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>
|
|
542
|
-
*/
|
|
246
|
+
|
|
543
247
|
export interface WorkflowDetail {
|
|
544
|
-
|
|
545
|
-
* <p>A unique identifier for the workflow.</p>
|
|
546
|
-
*/
|
|
248
|
+
|
|
547
249
|
WorkflowId: string | undefined;
|
|
548
|
-
|
|
549
|
-
* <p>Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can
|
|
550
|
-
* assume, so that all workflow steps can operate on the required resources</p>
|
|
551
|
-
*/
|
|
250
|
+
|
|
552
251
|
ExecutionRole: string | undefined;
|
|
553
252
|
}
|
|
554
253
|
export declare namespace WorkflowDetail {
|
|
555
|
-
|
|
556
|
-
* @internal
|
|
557
|
-
*/
|
|
254
|
+
|
|
558
255
|
const filterSensitiveLog: (obj: WorkflowDetail) => any;
|
|
559
256
|
}
|
|
560
|
-
|
|
561
|
-
* <p>Container for the <code>WorkflowDetail</code> data type.
|
|
562
|
-
* It is used by actions that trigger a workflow to begin execution.</p>
|
|
563
|
-
*/
|
|
257
|
+
|
|
564
258
|
export interface WorkflowDetails {
|
|
565
|
-
|
|
566
|
-
* <p>A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.</p>
|
|
567
|
-
*/
|
|
259
|
+
|
|
568
260
|
OnUpload: WorkflowDetail[] | undefined;
|
|
569
261
|
}
|
|
570
262
|
export declare namespace WorkflowDetails {
|
|
571
|
-
|
|
572
|
-
* @internal
|
|
573
|
-
*/
|
|
263
|
+
|
|
574
264
|
const filterSensitiveLog: (obj: WorkflowDetails) => any;
|
|
575
265
|
}
|
|
576
266
|
export interface CreateServerRequest {
|
|
577
|
-
|
|
578
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager (ACM) certificate. Required
|
|
579
|
-
* when <code>Protocols</code> is set to <code>FTPS</code>.</p>
|
|
580
|
-
*
|
|
581
|
-
* <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a>
|
|
582
|
-
* in the <i> Amazon Web Services Certificate Manager User Guide</i>.</p>
|
|
583
|
-
*
|
|
584
|
-
* <p>To import an existing certificate into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into ACM</a>
|
|
585
|
-
* in the <i> Amazon Web Services Certificate Manager User Guide</i>.</p>
|
|
586
|
-
*
|
|
587
|
-
* <p>To request a private certificate to use FTPS through private IP addresses, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request a
|
|
588
|
-
* private certificate</a> in the <i> Amazon Web Services Certificate Manager User
|
|
589
|
-
* Guide</i>.</p>
|
|
590
|
-
*
|
|
591
|
-
* <p>Certificates with the following cryptographic algorithms and key sizes are
|
|
592
|
-
* supported:</p>
|
|
593
|
-
*
|
|
594
|
-
* <ul>
|
|
595
|
-
* <li>
|
|
596
|
-
* <p>2048-bit RSA (RSA_2048)</p>
|
|
597
|
-
* </li>
|
|
598
|
-
* <li>
|
|
599
|
-
* <p>4096-bit RSA (RSA_4096)</p>
|
|
600
|
-
* </li>
|
|
601
|
-
* <li>
|
|
602
|
-
* <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p>
|
|
603
|
-
* </li>
|
|
604
|
-
* <li>
|
|
605
|
-
* <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p>
|
|
606
|
-
* </li>
|
|
607
|
-
* <li>
|
|
608
|
-
* <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p>
|
|
609
|
-
* </li>
|
|
610
|
-
* </ul>
|
|
611
|
-
*
|
|
612
|
-
* <note>
|
|
613
|
-
* <p>The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP
|
|
614
|
-
* address specified and information about the issuer.</p>
|
|
615
|
-
* </note>
|
|
616
|
-
*/
|
|
267
|
+
|
|
617
268
|
Certificate?: string;
|
|
618
|
-
|
|
619
|
-
* <p>The domain of the storage system that is used for file transfers. There are two domains
|
|
620
|
-
* available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The
|
|
621
|
-
* default value is S3.</p>
|
|
622
|
-
*
|
|
623
|
-
* <note>
|
|
624
|
-
* <p>After the server is created, the domain cannot be changed.</p>
|
|
625
|
-
* </note>
|
|
626
|
-
*/
|
|
269
|
+
|
|
627
270
|
Domain?: Domain | string;
|
|
628
|
-
|
|
629
|
-
* <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
|
630
|
-
* When you host your endpoint within your VPC, you can make it accessible only to resources
|
|
631
|
-
* within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over
|
|
632
|
-
* the internet. Your VPC's default security groups are automatically assigned to your
|
|
633
|
-
* endpoint.</p>
|
|
634
|
-
*/
|
|
271
|
+
|
|
635
272
|
EndpointDetails?: EndpointDetails;
|
|
636
|
-
|
|
637
|
-
* <p>The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)
|
|
638
|
-
* or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and
|
|
639
|
-
* resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.</p>
|
|
640
|
-
* <note>
|
|
641
|
-
* <p> After May 19, 2021, you won't be able to create a server using
|
|
642
|
-
* <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account if your account hasn't already
|
|
643
|
-
* done so before May 19, 2021. If you have already created servers with
|
|
644
|
-
* <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account on or before May 19, 2021,
|
|
645
|
-
* you will not be affected. After this date, use
|
|
646
|
-
* <code>EndpointType</code>=<code>VPC</code>.</p>
|
|
647
|
-
*
|
|
648
|
-
* <p>For more information, see
|
|
649
|
-
* https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
|
|
650
|
-
* <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. With
|
|
651
|
-
* this endpoint type, you have the option to directly associate up to three Elastic IPv4
|
|
652
|
-
* addresses (BYO IP included) with your server's endpoint and use VPC security groups to
|
|
653
|
-
* restrict traffic by the client's public IP address. This is not possible with
|
|
654
|
-
* <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p>
|
|
655
|
-
* </note>
|
|
656
|
-
*/
|
|
273
|
+
|
|
657
274
|
EndpointType?: EndpointType | string;
|
|
658
|
-
|
|
659
|
-
* <p>The RSA private key as generated by the <code>ssh-keygen -N "" -m PEM -f
|
|
660
|
-
* my-new-server-key</code> command.</p>
|
|
661
|
-
*
|
|
662
|
-
* <important>
|
|
663
|
-
* <p>If you aren't planning to migrate existing users from an existing SFTP-enabled
|
|
664
|
-
* server to a new server, don't update the host key. Accidentally changing a
|
|
665
|
-
* server's host key can be disruptive.</p>
|
|
666
|
-
* </important>
|
|
667
|
-
*
|
|
668
|
-
*
|
|
669
|
-
*
|
|
670
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change the host key for your SFTP-enabled server</a> in the <i>Amazon Web Services Transfer
|
|
671
|
-
* Family User Guide</i>.</p>
|
|
672
|
-
*/
|
|
275
|
+
|
|
673
276
|
HostKey?: string;
|
|
674
|
-
|
|
675
|
-
* <p>Required when <code>IdentityProviderType</code> is set to
|
|
676
|
-
* <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>. Accepts an array containing
|
|
677
|
-
* all of the information required to use a directory in <code>AWS_DIRECTORY_SERVICE</code> or
|
|
678
|
-
* invoke a customer-supplied authentication API, including the API Gateway URL. Not required
|
|
679
|
-
* when <code>IdentityProviderType</code> is set to <code>SERVICE_MANAGED</code>.</p>
|
|
680
|
-
*/
|
|
277
|
+
|
|
681
278
|
IdentityProviderDetails?: IdentityProviderDetails;
|
|
682
|
-
|
|
683
|
-
* <p>Specifies the mode of authentication for a server. The default value is
|
|
684
|
-
* <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
|
|
685
|
-
* the Amazon Web Services Transfer Family service.</p>
|
|
686
|
-
* <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to
|
|
687
|
-
* Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your
|
|
688
|
-
* on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to
|
|
689
|
-
* provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
690
|
-
* <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The
|
|
691
|
-
* <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call
|
|
692
|
-
* for authentication using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
693
|
-
*/
|
|
279
|
+
|
|
694
280
|
IdentityProviderType?: IdentityProviderType | string;
|
|
695
|
-
|
|
696
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn
|
|
697
|
-
* on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in
|
|
698
|
-
* your CloudWatch logs.</p>
|
|
699
|
-
*/
|
|
281
|
+
|
|
700
282
|
LoggingRole?: string;
|
|
701
|
-
|
|
702
|
-
* <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
|
|
703
|
-
* client can connect to your server's endpoint. The available protocols are:</p>
|
|
704
|
-
*
|
|
705
|
-
* <ul>
|
|
706
|
-
* <li>
|
|
707
|
-
* <p>
|
|
708
|
-
* <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over
|
|
709
|
-
* SSH</p>
|
|
710
|
-
* </li>
|
|
711
|
-
* <li>
|
|
712
|
-
* <p>
|
|
713
|
-
* <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS
|
|
714
|
-
* encryption</p>
|
|
715
|
-
* </li>
|
|
716
|
-
* <li>
|
|
717
|
-
* <p>
|
|
718
|
-
* <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p>
|
|
719
|
-
* </li>
|
|
720
|
-
* </ul>
|
|
721
|
-
*
|
|
722
|
-
* <note>
|
|
723
|
-
* <p>If you select <code>FTPS</code>, you must choose a certificate stored in Amazon Web Services Certificate
|
|
724
|
-
* Manager (ACM) which is used to identify your server when clients connect to it over
|
|
725
|
-
* FTPS.</p>
|
|
726
|
-
*
|
|
727
|
-
* <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the
|
|
728
|
-
* <code>EndpointType</code> must be <code>VPC</code> and the
|
|
729
|
-
* <code>IdentityProviderType</code> must be <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>.</p>
|
|
730
|
-
*
|
|
731
|
-
* <p>If <code>Protocol</code> includes <code>FTP</code>, then
|
|
732
|
-
* <code>AddressAllocationIds</code> cannot be associated.</p>
|
|
733
|
-
*
|
|
734
|
-
* <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code>
|
|
735
|
-
* can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to
|
|
736
|
-
* <code>SERVICE_MANAGED</code>.</p>
|
|
737
|
-
* </note>
|
|
738
|
-
*/
|
|
283
|
+
|
|
739
284
|
Protocols?: (Protocol | string)[];
|
|
740
|
-
|
|
741
|
-
* <p>Specifies the name of the security policy that is attached to the server.</p>
|
|
742
|
-
*/
|
|
285
|
+
|
|
743
286
|
SecurityPolicyName?: string;
|
|
744
|
-
|
|
745
|
-
* <p>Key-value pairs that can be used to group and search for servers.</p>
|
|
746
|
-
*/
|
|
287
|
+
|
|
747
288
|
Tags?: Tag[];
|
|
748
|
-
|
|
749
|
-
* <p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>
|
|
750
|
-
*/
|
|
289
|
+
|
|
751
290
|
WorkflowDetails?: WorkflowDetails;
|
|
752
291
|
}
|
|
753
292
|
export declare namespace CreateServerRequest {
|
|
754
|
-
|
|
755
|
-
* @internal
|
|
756
|
-
*/
|
|
293
|
+
|
|
757
294
|
const filterSensitiveLog: (obj: CreateServerRequest) => any;
|
|
758
295
|
}
|
|
759
296
|
export interface CreateServerResponse {
|
|
760
|
-
|
|
761
|
-
* <p>The service-assigned ID of the server that is created.</p>
|
|
762
|
-
*/
|
|
297
|
+
|
|
763
298
|
ServerId: string | undefined;
|
|
764
299
|
}
|
|
765
300
|
export declare namespace CreateServerResponse {
|
|
766
|
-
|
|
767
|
-
* @internal
|
|
768
|
-
*/
|
|
301
|
+
|
|
769
302
|
const filterSensitiveLog: (obj: CreateServerResponse) => any;
|
|
770
303
|
}
|
|
771
|
-
|
|
772
|
-
* <p>The request was denied due to request throttling.</p>
|
|
773
|
-
*
|
|
774
|
-
* <p> HTTP Status Code: 400</p>
|
|
775
|
-
*/
|
|
304
|
+
|
|
776
305
|
export interface ThrottlingException extends __SmithyException, $MetadataBearer {
|
|
777
306
|
name: "ThrottlingException";
|
|
778
307
|
$fault: "client";
|
|
779
308
|
RetryAfterSeconds?: string;
|
|
780
309
|
}
|
|
781
310
|
export declare namespace ThrottlingException {
|
|
782
|
-
|
|
783
|
-
* @internal
|
|
784
|
-
*/
|
|
311
|
+
|
|
785
312
|
const filterSensitiveLog: (obj: ThrottlingException) => any;
|
|
786
313
|
}
|
|
787
314
|
export interface CreateUserRequest {
|
|
788
|
-
|
|
789
|
-
* <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
|
|
790
|
-
* <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
|
|
791
|
-
*/
|
|
315
|
+
|
|
792
316
|
HomeDirectory?: string;
|
|
793
|
-
|
|
794
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
|
|
795
|
-
* If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
|
|
796
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
|
|
797
|
-
* S3 or EFS paths visible to your users.</p>
|
|
798
|
-
*/
|
|
317
|
+
|
|
799
318
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
800
|
-
|
|
801
|
-
* <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
|
|
802
|
-
* be visible to your user and how you want to make them visible. You must specify the
|
|
803
|
-
* <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
|
|
804
|
-
* is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
|
|
805
|
-
* only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity
|
|
806
|
-
* and Access Management (IAM) role provides access to paths in <code>Target</code>. This value
|
|
807
|
-
* can only be set when <code>HomeDirectoryType</code> is set to
|
|
808
|
-
* <i>LOGICAL</i>.</p>
|
|
809
|
-
*
|
|
810
|
-
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>
|
|
811
|
-
*
|
|
812
|
-
* <p>
|
|
813
|
-
* <code>[ { "Entry": "/directory1", "Target":
|
|
814
|
-
* "/bucket_name/home/mydirectory" } ]</code>
|
|
815
|
-
* </p>
|
|
816
|
-
*
|
|
817
|
-
* <p>In most cases, you can use this value instead of the session policy to lock your user
|
|
818
|
-
* down to the designated home directory ("<code>chroot</code>"). To do this, you can set
|
|
819
|
-
* <code>Entry</code> to <code>/</code> and set <code>Target</code> to the HomeDirectory
|
|
820
|
-
* parameter value.</p>
|
|
821
|
-
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>
|
|
822
|
-
* <p>
|
|
823
|
-
* <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
|
|
824
|
-
* </p>
|
|
825
|
-
*
|
|
826
|
-
* <note>
|
|
827
|
-
* <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
|
|
828
|
-
* ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
|
|
829
|
-
* holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
|
|
830
|
-
* <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
|
|
831
|
-
* following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
|
|
832
|
-
* sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
|
|
833
|
-
* </note>
|
|
834
|
-
*/
|
|
319
|
+
|
|
835
320
|
HomeDirectoryMappings?: HomeDirectoryMapEntry[];
|
|
836
|
-
|
|
837
|
-
* <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
|
|
838
|
-
* access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
|
|
839
|
-
* <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
|
|
840
|
-
*
|
|
841
|
-
* <note>
|
|
842
|
-
* <p>This only applies when the domain of <code>ServerId</code> is S3. EFS does not use session policies.</p>
|
|
843
|
-
* <p>For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead
|
|
844
|
-
* of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass
|
|
845
|
-
* it in the <code>Policy</code> argument.</p>
|
|
846
|
-
*
|
|
847
|
-
*
|
|
848
|
-
*
|
|
849
|
-
* <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html">Example session
|
|
850
|
-
* policy</a>.</p>
|
|
851
|
-
*
|
|
852
|
-
*
|
|
853
|
-
*
|
|
854
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Amazon Web Services
|
|
855
|
-
* Security Token Service API Reference</i>.</p>
|
|
856
|
-
* </note>
|
|
857
|
-
*/
|
|
321
|
+
|
|
858
322
|
Policy?: string;
|
|
859
|
-
|
|
860
|
-
* <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID
|
|
861
|
-
* (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
|
|
862
|
-
* your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
|
|
863
|
-
* files and directories in Amazon EFS determine the level of access your users get when
|
|
864
|
-
* transferring files into and out of your Amazon EFS file systems.</p>
|
|
865
|
-
*/
|
|
323
|
+
|
|
866
324
|
PosixProfile?: PosixProfile;
|
|
867
|
-
|
|
868
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
|
|
869
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
|
|
870
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
|
|
871
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
872
|
-
*/
|
|
325
|
+
|
|
873
326
|
Role: string | undefined;
|
|
874
|
-
|
|
875
|
-
* <p>A system-assigned unique identifier for a server instance. This is the specific server
|
|
876
|
-
* that you added your user to.</p>
|
|
877
|
-
*/
|
|
327
|
+
|
|
878
328
|
ServerId: string | undefined;
|
|
879
|
-
|
|
880
|
-
* <p>The public portion of the Secure Shell (SSH) key used to authenticate the user to the
|
|
881
|
-
* server.</p>
|
|
882
|
-
*/
|
|
329
|
+
|
|
883
330
|
SshPublicKeyBody?: string;
|
|
884
|
-
|
|
885
|
-
* <p>Key-value pairs that can be used to group and search for users. Tags are metadata attached
|
|
886
|
-
* to users for any purpose.</p>
|
|
887
|
-
*/
|
|
331
|
+
|
|
888
332
|
Tags?: Tag[];
|
|
889
|
-
|
|
890
|
-
* <p>A unique string that identifies a user and is associated with a <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 100 characters
|
|
891
|
-
* long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen
|
|
892
|
-
* '-', period '.', and at sign '@'. The user name can't start
|
|
893
|
-
* with a hyphen, period, or at sign.</p>
|
|
894
|
-
*/
|
|
333
|
+
|
|
895
334
|
UserName: string | undefined;
|
|
896
335
|
}
|
|
897
336
|
export declare namespace CreateUserRequest {
|
|
898
|
-
|
|
899
|
-
* @internal
|
|
900
|
-
*/
|
|
337
|
+
|
|
901
338
|
const filterSensitiveLog: (obj: CreateUserRequest) => any;
|
|
902
339
|
}
|
|
903
340
|
export interface CreateUserResponse {
|
|
904
|
-
|
|
905
|
-
* <p>The ID of the server that the user is attached to.</p>
|
|
906
|
-
*/
|
|
341
|
+
|
|
907
342
|
ServerId: string | undefined;
|
|
908
|
-
|
|
909
|
-
* <p>A unique string that identifies a user account associated with a server.</p>
|
|
910
|
-
*/
|
|
343
|
+
|
|
911
344
|
UserName: string | undefined;
|
|
912
345
|
}
|
|
913
346
|
export declare namespace CreateUserResponse {
|
|
914
|
-
|
|
915
|
-
* @internal
|
|
916
|
-
*/
|
|
347
|
+
|
|
917
348
|
const filterSensitiveLog: (obj: CreateUserResponse) => any;
|
|
918
349
|
}
|
|
919
|
-
|
|
920
|
-
* <p>Each step type has its own <code>StepDetails</code> structure.</p>
|
|
921
|
-
*/
|
|
350
|
+
|
|
922
351
|
export interface CustomStepDetails {
|
|
923
|
-
|
|
924
|
-
* <p>The name of the step, used as an identifier.</p>
|
|
925
|
-
*/
|
|
352
|
+
|
|
926
353
|
Name?: string;
|
|
927
|
-
|
|
928
|
-
* <p>The ARN for the lambda function that is being called.</p>
|
|
929
|
-
*/
|
|
354
|
+
|
|
930
355
|
Target?: string;
|
|
931
|
-
|
|
932
|
-
* <p>Timeout, in seconds, for the step.</p>
|
|
933
|
-
*/
|
|
356
|
+
|
|
934
357
|
TimeoutSeconds?: number;
|
|
935
358
|
}
|
|
936
359
|
export declare namespace CustomStepDetails {
|
|
937
|
-
|
|
938
|
-
* @internal
|
|
939
|
-
*/
|
|
360
|
+
|
|
940
361
|
const filterSensitiveLog: (obj: CustomStepDetails) => any;
|
|
941
362
|
}
|
|
942
|
-
|
|
943
|
-
* <p>The name of the step, used to identify the delete step.</p>
|
|
944
|
-
*/
|
|
363
|
+
|
|
945
364
|
export interface DeleteStepDetails {
|
|
946
|
-
|
|
947
|
-
* <p>The name of the step, used as an identifier.</p>
|
|
948
|
-
*/
|
|
365
|
+
|
|
949
366
|
Name?: string;
|
|
950
367
|
}
|
|
951
368
|
export declare namespace DeleteStepDetails {
|
|
952
|
-
|
|
953
|
-
* @internal
|
|
954
|
-
*/
|
|
369
|
+
|
|
955
370
|
const filterSensitiveLog: (obj: DeleteStepDetails) => any;
|
|
956
371
|
}
|
|
957
|
-
|
|
958
|
-
* <p>Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.</p>
|
|
959
|
-
*/
|
|
372
|
+
|
|
960
373
|
export interface S3Tag {
|
|
961
|
-
|
|
962
|
-
* <p>The name assigned to the tag that you create.</p>
|
|
963
|
-
*/
|
|
374
|
+
|
|
964
375
|
Key: string | undefined;
|
|
965
|
-
|
|
966
|
-
* <p>The value that corresponds to the key.</p>
|
|
967
|
-
*/
|
|
376
|
+
|
|
968
377
|
Value: string | undefined;
|
|
969
378
|
}
|
|
970
379
|
export declare namespace S3Tag {
|
|
971
|
-
|
|
972
|
-
* @internal
|
|
973
|
-
*/
|
|
380
|
+
|
|
974
381
|
const filterSensitiveLog: (obj: S3Tag) => any;
|
|
975
382
|
}
|
|
976
|
-
|
|
977
|
-
* <p>Each step type has its own <code>StepDetails</code> structure.</p>
|
|
978
|
-
* <p>The key/value pairs used to tag a file during the execution of a workflow step.</p>
|
|
979
|
-
*/
|
|
383
|
+
|
|
980
384
|
export interface TagStepDetails {
|
|
981
|
-
|
|
982
|
-
* <p>The name of the step, used as an identifier.</p>
|
|
983
|
-
*/
|
|
385
|
+
|
|
984
386
|
Name?: string;
|
|
985
|
-
|
|
986
|
-
* <p>Array that contains from 1 to 10 key/value pairs.</p>
|
|
987
|
-
*/
|
|
387
|
+
|
|
988
388
|
Tags?: S3Tag[];
|
|
989
389
|
}
|
|
990
390
|
export declare namespace TagStepDetails {
|
|
991
|
-
|
|
992
|
-
* @internal
|
|
993
|
-
*/
|
|
391
|
+
|
|
994
392
|
const filterSensitiveLog: (obj: TagStepDetails) => any;
|
|
995
393
|
}
|
|
996
394
|
export declare enum WorkflowStepType {
|
|
@@ -999,145 +397,43 @@ export declare enum WorkflowStepType {
|
|
|
999
397
|
DELETE = "DELETE",
|
|
1000
398
|
TAG = "TAG"
|
|
1001
399
|
}
|
|
1002
|
-
|
|
1003
|
-
* <p>The basic building block of a workflow.</p>
|
|
1004
|
-
*/
|
|
400
|
+
|
|
1005
401
|
export interface WorkflowStep {
|
|
1006
|
-
|
|
1007
|
-
* <p>
|
|
1008
|
-
* Currently, the following step types are supported.
|
|
1009
|
-
* </p>
|
|
1010
|
-
* <ul>
|
|
1011
|
-
* <li>
|
|
1012
|
-
* <p>
|
|
1013
|
-
* <i>Copy</i>: copy the file to another location</p>
|
|
1014
|
-
* </li>
|
|
1015
|
-
* <li>
|
|
1016
|
-
* <p>
|
|
1017
|
-
* <i>Custom</i>: custom step with a lambda target</p>
|
|
1018
|
-
* </li>
|
|
1019
|
-
* <li>
|
|
1020
|
-
* <p>
|
|
1021
|
-
* <i>Delete</i>: delete the file</p>
|
|
1022
|
-
* </li>
|
|
1023
|
-
* <li>
|
|
1024
|
-
* <p>
|
|
1025
|
-
* <i>Tag</i>: add a tag to the file</p>
|
|
1026
|
-
* </li>
|
|
1027
|
-
* </ul>
|
|
1028
|
-
*/
|
|
402
|
+
|
|
1029
403
|
Type?: WorkflowStepType | string;
|
|
1030
|
-
|
|
1031
|
-
* <p>Details for a step that performs a file copy.</p>
|
|
1032
|
-
* <p>
|
|
1033
|
-
* Consists of the following values:
|
|
1034
|
-
* </p>
|
|
1035
|
-
* <ul>
|
|
1036
|
-
* <li>
|
|
1037
|
-
* <p>A description</p>
|
|
1038
|
-
* </li>
|
|
1039
|
-
* <li>
|
|
1040
|
-
* <p>An S3 location for the destination of the file copy.</p>
|
|
1041
|
-
* </li>
|
|
1042
|
-
* <li>
|
|
1043
|
-
* <p>A flag that indicates whether or not to overwrite an existing file of the same name.
|
|
1044
|
-
* The default is <code>FALSE</code>.</p>
|
|
1045
|
-
* </li>
|
|
1046
|
-
* </ul>
|
|
1047
|
-
*/
|
|
404
|
+
|
|
1048
405
|
CopyStepDetails?: CopyStepDetails;
|
|
1049
|
-
|
|
1050
|
-
* <p>Details for a step that invokes a lambda function.</p>
|
|
1051
|
-
* <p>
|
|
1052
|
-
* Consists of the lambda function name, target, and timeout (in seconds).
|
|
1053
|
-
* </p>
|
|
1054
|
-
*/
|
|
406
|
+
|
|
1055
407
|
CustomStepDetails?: CustomStepDetails;
|
|
1056
|
-
|
|
1057
|
-
* <p>Details for a step that deletes the file.</p>
|
|
1058
|
-
*/
|
|
408
|
+
|
|
1059
409
|
DeleteStepDetails?: DeleteStepDetails;
|
|
1060
|
-
|
|
1061
|
-
* <p>Details for a step that creates one or more tags.</p>
|
|
1062
|
-
* <p>You specify one or more tags: each tag contains a key/value pair.</p>
|
|
1063
|
-
*/
|
|
410
|
+
|
|
1064
411
|
TagStepDetails?: TagStepDetails;
|
|
1065
412
|
}
|
|
1066
413
|
export declare namespace WorkflowStep {
|
|
1067
|
-
|
|
1068
|
-
* @internal
|
|
1069
|
-
*/
|
|
414
|
+
|
|
1070
415
|
const filterSensitiveLog: (obj: WorkflowStep) => any;
|
|
1071
416
|
}
|
|
1072
417
|
export interface CreateWorkflowRequest {
|
|
1073
|
-
|
|
1074
|
-
* <p>A textual description for the workflow.</p>
|
|
1075
|
-
*/
|
|
418
|
+
|
|
1076
419
|
Description?: string;
|
|
1077
|
-
|
|
1078
|
-
* <p>Specifies the details for the steps that are in the specified workflow.</p>
|
|
1079
|
-
* <p>
|
|
1080
|
-
* The <code>TYPE</code> specifies which of the following actions is being taken for this step.
|
|
1081
|
-
* </p>
|
|
1082
|
-
* <ul>
|
|
1083
|
-
* <li>
|
|
1084
|
-
* <p>
|
|
1085
|
-
* <i>Copy</i>: copy the file to another location</p>
|
|
1086
|
-
* </li>
|
|
1087
|
-
* <li>
|
|
1088
|
-
* <p>
|
|
1089
|
-
* <i>Custom</i>: custom step with a lambda target</p>
|
|
1090
|
-
* </li>
|
|
1091
|
-
* <li>
|
|
1092
|
-
* <p>
|
|
1093
|
-
* <i>Delete</i>: delete the file</p>
|
|
1094
|
-
* </li>
|
|
1095
|
-
* <li>
|
|
1096
|
-
* <p>
|
|
1097
|
-
* <i>Tag</i>: add a tag to the file</p>
|
|
1098
|
-
* </li>
|
|
1099
|
-
* </ul>
|
|
1100
|
-
* <note>
|
|
1101
|
-
* <p>
|
|
1102
|
-
* Currently, copying and tagging are supported only on S3.
|
|
1103
|
-
* </p>
|
|
1104
|
-
* </note>
|
|
1105
|
-
* <p>
|
|
1106
|
-
* For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.
|
|
1107
|
-
* </p>
|
|
1108
|
-
*/
|
|
420
|
+
|
|
1109
421
|
Steps: WorkflowStep[] | undefined;
|
|
1110
|
-
|
|
1111
|
-
* <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p>
|
|
1112
|
-
* <note>
|
|
1113
|
-
* <p>For custom steps, the lambda function needs to send <code>FAILURE</code> to the call
|
|
1114
|
-
* back API to kick off the exception steps. Additionally, if the lambda does not send
|
|
1115
|
-
* <code>SUCCESS</code> before it times out, the exception steps are executed.</p>
|
|
1116
|
-
* </note>
|
|
1117
|
-
*/
|
|
422
|
+
|
|
1118
423
|
OnExceptionSteps?: WorkflowStep[];
|
|
1119
|
-
|
|
1120
|
-
* <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached
|
|
1121
|
-
* to workflows for any purpose.</p>
|
|
1122
|
-
*/
|
|
424
|
+
|
|
1123
425
|
Tags?: Tag[];
|
|
1124
426
|
}
|
|
1125
427
|
export declare namespace CreateWorkflowRequest {
|
|
1126
|
-
|
|
1127
|
-
* @internal
|
|
1128
|
-
*/
|
|
428
|
+
|
|
1129
429
|
const filterSensitiveLog: (obj: CreateWorkflowRequest) => any;
|
|
1130
430
|
}
|
|
1131
431
|
export interface CreateWorkflowResponse {
|
|
1132
|
-
|
|
1133
|
-
* <p>A unique identifier for the workflow.</p>
|
|
1134
|
-
*/
|
|
432
|
+
|
|
1135
433
|
WorkflowId: string | undefined;
|
|
1136
434
|
}
|
|
1137
435
|
export declare namespace CreateWorkflowResponse {
|
|
1138
|
-
|
|
1139
|
-
* @internal
|
|
1140
|
-
*/
|
|
436
|
+
|
|
1141
437
|
const filterSensitiveLog: (obj: CreateWorkflowResponse) => any;
|
|
1142
438
|
}
|
|
1143
439
|
export declare enum CustomStepStatus {
|
|
@@ -1145,401 +441,189 @@ export declare enum CustomStepStatus {
|
|
|
1145
441
|
SUCCESS = "SUCCESS"
|
|
1146
442
|
}
|
|
1147
443
|
export interface DeleteAccessRequest {
|
|
1148
|
-
|
|
1149
|
-
* <p>A system-assigned unique identifier for a server that has this user assigned.</p>
|
|
1150
|
-
*/
|
|
444
|
+
|
|
1151
445
|
ServerId: string | undefined;
|
|
1152
|
-
|
|
1153
|
-
* <p>A unique identifier that is required to identify specific groups within your directory.
|
|
1154
|
-
* The users of the group that you associate have access to your Amazon S3 or Amazon EFS
|
|
1155
|
-
* resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,
|
|
1156
|
-
* you can view the SID values by running the following command using Windows PowerShell.</p>
|
|
1157
|
-
*
|
|
1158
|
-
* <p>
|
|
1159
|
-
* <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code>
|
|
1160
|
-
* </p>
|
|
1161
|
-
*
|
|
1162
|
-
* <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
|
|
1163
|
-
*
|
|
1164
|
-
* <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
|
|
1165
|
-
* You can also include underscores or any of the following characters: =,.@:/-</p>
|
|
1166
|
-
*/
|
|
446
|
+
|
|
1167
447
|
ExternalId: string | undefined;
|
|
1168
448
|
}
|
|
1169
449
|
export declare namespace DeleteAccessRequest {
|
|
1170
|
-
|
|
1171
|
-
* @internal
|
|
1172
|
-
*/
|
|
450
|
+
|
|
1173
451
|
const filterSensitiveLog: (obj: DeleteAccessRequest) => any;
|
|
1174
452
|
}
|
|
1175
453
|
export interface DeleteServerRequest {
|
|
1176
|
-
|
|
1177
|
-
* <p>A unique system-assigned identifier for a server instance.</p>
|
|
1178
|
-
*/
|
|
454
|
+
|
|
1179
455
|
ServerId: string | undefined;
|
|
1180
456
|
}
|
|
1181
457
|
export declare namespace DeleteServerRequest {
|
|
1182
|
-
|
|
1183
|
-
* @internal
|
|
1184
|
-
*/
|
|
458
|
+
|
|
1185
459
|
const filterSensitiveLog: (obj: DeleteServerRequest) => any;
|
|
1186
460
|
}
|
|
1187
461
|
export interface DeleteSshPublicKeyRequest {
|
|
1188
|
-
|
|
1189
|
-
* <p>A system-assigned unique identifier for a file transfer protocol-enabled server instance
|
|
1190
|
-
* that has the user assigned to it.</p>
|
|
1191
|
-
*/
|
|
462
|
+
|
|
1192
463
|
ServerId: string | undefined;
|
|
1193
|
-
|
|
1194
|
-
* <p>A unique identifier used to reference your user's specific SSH key.</p>
|
|
1195
|
-
*/
|
|
464
|
+
|
|
1196
465
|
SshPublicKeyId: string | undefined;
|
|
1197
|
-
|
|
1198
|
-
* <p>A unique string that identifies a user whose public key is being deleted.</p>
|
|
1199
|
-
*/
|
|
466
|
+
|
|
1200
467
|
UserName: string | undefined;
|
|
1201
468
|
}
|
|
1202
469
|
export declare namespace DeleteSshPublicKeyRequest {
|
|
1203
|
-
|
|
1204
|
-
* @internal
|
|
1205
|
-
*/
|
|
470
|
+
|
|
1206
471
|
const filterSensitiveLog: (obj: DeleteSshPublicKeyRequest) => any;
|
|
1207
472
|
}
|
|
1208
473
|
export interface DeleteUserRequest {
|
|
1209
|
-
|
|
1210
|
-
* <p>A system-assigned unique identifier for a server instance that has the user assigned to
|
|
1211
|
-
* it.</p>
|
|
1212
|
-
*/
|
|
474
|
+
|
|
1213
475
|
ServerId: string | undefined;
|
|
1214
|
-
|
|
1215
|
-
* <p>A unique string that identifies a user that is being deleted from a server.</p>
|
|
1216
|
-
*/
|
|
476
|
+
|
|
1217
477
|
UserName: string | undefined;
|
|
1218
478
|
}
|
|
1219
479
|
export declare namespace DeleteUserRequest {
|
|
1220
|
-
|
|
1221
|
-
* @internal
|
|
1222
|
-
*/
|
|
480
|
+
|
|
1223
481
|
const filterSensitiveLog: (obj: DeleteUserRequest) => any;
|
|
1224
482
|
}
|
|
1225
483
|
export interface DeleteWorkflowRequest {
|
|
1226
|
-
|
|
1227
|
-
* <p>A unique identifier for the workflow.</p>
|
|
1228
|
-
*/
|
|
484
|
+
|
|
1229
485
|
WorkflowId: string | undefined;
|
|
1230
486
|
}
|
|
1231
487
|
export declare namespace DeleteWorkflowRequest {
|
|
1232
|
-
|
|
1233
|
-
* @internal
|
|
1234
|
-
*/
|
|
488
|
+
|
|
1235
489
|
const filterSensitiveLog: (obj: DeleteWorkflowRequest) => any;
|
|
1236
490
|
}
|
|
1237
491
|
export interface DescribeAccessRequest {
|
|
1238
|
-
|
|
1239
|
-
* <p>A system-assigned unique identifier for a server that has this access assigned.</p>
|
|
1240
|
-
*/
|
|
492
|
+
|
|
1241
493
|
ServerId: string | undefined;
|
|
1242
|
-
|
|
1243
|
-
* <p>A unique identifier that is required to identify specific groups within your directory.
|
|
1244
|
-
* The users of the group that you associate have access to your Amazon S3 or Amazon EFS
|
|
1245
|
-
* resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,
|
|
1246
|
-
* you can view the SID values by running the following command using Windows PowerShell.</p>
|
|
1247
|
-
*
|
|
1248
|
-
* <p>
|
|
1249
|
-
* <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code>
|
|
1250
|
-
* </p>
|
|
1251
|
-
*
|
|
1252
|
-
* <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
|
|
1253
|
-
*
|
|
1254
|
-
* <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
|
|
1255
|
-
* You can also include underscores or any of the following characters: =,.@:/-</p>
|
|
1256
|
-
*/
|
|
494
|
+
|
|
1257
495
|
ExternalId: string | undefined;
|
|
1258
496
|
}
|
|
1259
497
|
export declare namespace DescribeAccessRequest {
|
|
1260
|
-
|
|
1261
|
-
* @internal
|
|
1262
|
-
*/
|
|
498
|
+
|
|
1263
499
|
const filterSensitiveLog: (obj: DescribeAccessRequest) => any;
|
|
1264
500
|
}
|
|
1265
|
-
|
|
1266
|
-
* <p>Describes the properties of the access that was specified.</p>
|
|
1267
|
-
*/
|
|
501
|
+
|
|
1268
502
|
export interface DescribedAccess {
|
|
1269
|
-
|
|
1270
|
-
* <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
|
|
1271
|
-
* <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
|
|
1272
|
-
*/
|
|
503
|
+
|
|
1273
504
|
HomeDirectory?: string;
|
|
1274
|
-
|
|
1275
|
-
* <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
|
|
1276
|
-
* be visible to your user and how you want to make them visible. You must specify the
|
|
1277
|
-
* <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
|
|
1278
|
-
* is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
|
|
1279
|
-
* only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity
|
|
1280
|
-
* and Access Management (IAM) role provides access to paths in <code>Target</code>. This value
|
|
1281
|
-
* can only be set when <code>HomeDirectoryType</code> is set to
|
|
1282
|
-
* <i>LOGICAL</i>.</p>
|
|
1283
|
-
*
|
|
1284
|
-
* <p>In most cases, you can use this value instead of the session policy to lock down the
|
|
1285
|
-
* associated access to the designated home directory ("<code>chroot</code>"). To do this, you
|
|
1286
|
-
* can set <code>Entry</code> to '/' and set <code>Target</code> to the
|
|
1287
|
-
* <code>HomeDirectory</code> parameter value.</p>
|
|
1288
|
-
*/
|
|
505
|
+
|
|
1289
506
|
HomeDirectoryMappings?: HomeDirectoryMapEntry[];
|
|
1290
|
-
|
|
1291
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
|
|
1292
|
-
* If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
|
|
1293
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
|
|
1294
|
-
* S3 or EFS paths visible to your users.</p>
|
|
1295
|
-
*/
|
|
507
|
+
|
|
1296
508
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
1297
|
-
|
|
1298
|
-
* <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
|
|
1299
|
-
* access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
|
|
1300
|
-
* <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
|
|
1301
|
-
*/
|
|
509
|
+
|
|
1302
510
|
Policy?: string;
|
|
1303
|
-
|
|
1304
|
-
* <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
|
|
1305
|
-
* (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
|
|
1306
|
-
* your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
|
|
1307
|
-
* files and directories in your file system determine the level of access your users get when
|
|
1308
|
-
* transferring files into and out of your Amazon EFS file systems.</p>
|
|
1309
|
-
*/
|
|
511
|
+
|
|
1310
512
|
PosixProfile?: PosixProfile;
|
|
1311
|
-
|
|
1312
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
|
|
1313
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
|
|
1314
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
|
|
1315
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
1316
|
-
*/
|
|
513
|
+
|
|
1317
514
|
Role?: string;
|
|
1318
|
-
|
|
1319
|
-
* <p>A unique identifier that is required to identify specific groups within your directory.
|
|
1320
|
-
* The users of the group that you associate have access to your Amazon S3 or Amazon EFS
|
|
1321
|
-
* resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,
|
|
1322
|
-
* you can view the SID values by running the following command using Windows PowerShell.</p>
|
|
1323
|
-
*
|
|
1324
|
-
* <p>
|
|
1325
|
-
* <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code>
|
|
1326
|
-
* </p>
|
|
1327
|
-
*
|
|
1328
|
-
* <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
|
|
1329
|
-
*
|
|
1330
|
-
* <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
|
|
1331
|
-
* You can also include underscores or any of the following characters: =,.@:/-</p>
|
|
1332
|
-
*/
|
|
515
|
+
|
|
1333
516
|
ExternalId?: string;
|
|
1334
517
|
}
|
|
1335
518
|
export declare namespace DescribedAccess {
|
|
1336
|
-
|
|
1337
|
-
* @internal
|
|
1338
|
-
*/
|
|
519
|
+
|
|
1339
520
|
const filterSensitiveLog: (obj: DescribedAccess) => any;
|
|
1340
521
|
}
|
|
1341
522
|
export interface DescribeAccessResponse {
|
|
1342
|
-
|
|
1343
|
-
* <p>A system-assigned unique identifier for a server that has this access assigned.</p>
|
|
1344
|
-
*/
|
|
523
|
+
|
|
1345
524
|
ServerId: string | undefined;
|
|
1346
|
-
|
|
1347
|
-
* <p>The external ID of the server that the access is attached to.</p>
|
|
1348
|
-
*/
|
|
525
|
+
|
|
1349
526
|
Access: DescribedAccess | undefined;
|
|
1350
527
|
}
|
|
1351
528
|
export declare namespace DescribeAccessResponse {
|
|
1352
|
-
|
|
1353
|
-
* @internal
|
|
1354
|
-
*/
|
|
529
|
+
|
|
1355
530
|
const filterSensitiveLog: (obj: DescribeAccessResponse) => any;
|
|
1356
531
|
}
|
|
1357
|
-
|
|
1358
|
-
* <p>Specifies the details for the file location for the file being used in the workflow. Only applicable if you are using S3 storage.</p>
|
|
1359
|
-
*/
|
|
532
|
+
|
|
1360
533
|
export interface S3FileLocation {
|
|
1361
|
-
|
|
1362
|
-
* <p>Specifies the S3 bucket that contains the file being used.</p>
|
|
1363
|
-
*/
|
|
534
|
+
|
|
1364
535
|
Bucket?: string;
|
|
1365
|
-
|
|
1366
|
-
* <p>The name assigned to the file when it was created in S3. You use the object key to retrieve the object.</p>
|
|
1367
|
-
*/
|
|
536
|
+
|
|
1368
537
|
Key?: string;
|
|
1369
|
-
|
|
1370
|
-
* <p>Specifies the file version.</p>
|
|
1371
|
-
*/
|
|
538
|
+
|
|
1372
539
|
VersionId?: string;
|
|
1373
|
-
|
|
1374
|
-
* <p>The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.</p>
|
|
1375
|
-
*/
|
|
540
|
+
|
|
1376
541
|
Etag?: string;
|
|
1377
542
|
}
|
|
1378
543
|
export declare namespace S3FileLocation {
|
|
1379
|
-
|
|
1380
|
-
* @internal
|
|
1381
|
-
*/
|
|
544
|
+
|
|
1382
545
|
const filterSensitiveLog: (obj: S3FileLocation) => any;
|
|
1383
546
|
}
|
|
1384
|
-
|
|
1385
|
-
* <p>Specifies the Amazon S3 or EFS file details to be used in the step.</p>
|
|
1386
|
-
*/
|
|
547
|
+
|
|
1387
548
|
export interface FileLocation {
|
|
1388
|
-
|
|
1389
|
-
* <p>Specifies the S3 details for the file being used, such as bucket, Etag, and so forth.</p>
|
|
1390
|
-
*/
|
|
549
|
+
|
|
1391
550
|
S3FileLocation?: S3FileLocation;
|
|
1392
|
-
|
|
1393
|
-
* <p>Specifies the Amazon EFS ID and the path for the file being used.</p>
|
|
1394
|
-
*/
|
|
551
|
+
|
|
1395
552
|
EfsFileLocation?: EfsFileLocation;
|
|
1396
553
|
}
|
|
1397
554
|
export declare namespace FileLocation {
|
|
1398
|
-
|
|
1399
|
-
* @internal
|
|
1400
|
-
*/
|
|
555
|
+
|
|
1401
556
|
const filterSensitiveLog: (obj: FileLocation) => any;
|
|
1402
557
|
}
|
|
1403
|
-
|
|
1404
|
-
* <p>Consists of the logging role and the log group name.</p>
|
|
1405
|
-
*/
|
|
558
|
+
|
|
1406
559
|
export interface LoggingConfiguration {
|
|
1407
|
-
|
|
1408
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn
|
|
1409
|
-
* on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in
|
|
1410
|
-
* your CloudWatch logs.</p>
|
|
1411
|
-
*/
|
|
560
|
+
|
|
1412
561
|
LoggingRole?: string;
|
|
1413
|
-
|
|
1414
|
-
* <p>The name of the CloudWatch logging group for the Amazon Web Services Transfer server to which this workflow belongs.</p>
|
|
1415
|
-
*/
|
|
562
|
+
|
|
1416
563
|
LogGroupName?: string;
|
|
1417
564
|
}
|
|
1418
565
|
export declare namespace LoggingConfiguration {
|
|
1419
|
-
|
|
1420
|
-
* @internal
|
|
1421
|
-
*/
|
|
566
|
+
|
|
1422
567
|
const filterSensitiveLog: (obj: LoggingConfiguration) => any;
|
|
1423
568
|
}
|
|
1424
569
|
export declare enum ExecutionErrorType {
|
|
1425
570
|
PERMISSION_DENIED = "PERMISSION_DENIED"
|
|
1426
571
|
}
|
|
1427
|
-
|
|
1428
|
-
* <p>Specifies the error message and type, for an error that occurs during the execution of the workflow.</p>
|
|
1429
|
-
*/
|
|
572
|
+
|
|
1430
573
|
export interface ExecutionError {
|
|
1431
|
-
|
|
1432
|
-
* <p>Specifies the error type: currently, the only valid value is <code>PERMISSION_DENIED</code>, which occurs
|
|
1433
|
-
* if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.</p>
|
|
1434
|
-
*/
|
|
574
|
+
|
|
1435
575
|
Type: ExecutionErrorType | string | undefined;
|
|
1436
|
-
|
|
1437
|
-
* <p>Specifies the descriptive message that corresponds to the <code>ErrorType</code>.</p>
|
|
1438
|
-
*/
|
|
576
|
+
|
|
1439
577
|
Message: string | undefined;
|
|
1440
578
|
}
|
|
1441
579
|
export declare namespace ExecutionError {
|
|
1442
|
-
|
|
1443
|
-
* @internal
|
|
1444
|
-
*/
|
|
580
|
+
|
|
1445
581
|
const filterSensitiveLog: (obj: ExecutionError) => any;
|
|
1446
582
|
}
|
|
1447
|
-
|
|
1448
|
-
* <p>Specifies the following details for the step: error (if any), outputs (if any), and the step type.</p>
|
|
1449
|
-
*/
|
|
583
|
+
|
|
1450
584
|
export interface ExecutionStepResult {
|
|
1451
|
-
|
|
1452
|
-
* <p>One of the available step types.</p>
|
|
1453
|
-
* <ul>
|
|
1454
|
-
* <li>
|
|
1455
|
-
* <p>
|
|
1456
|
-
* <i>Copy</i>: copy the file to another location</p>
|
|
1457
|
-
* </li>
|
|
1458
|
-
* <li>
|
|
1459
|
-
* <p>
|
|
1460
|
-
* <i>Custom</i>: custom step with a lambda target</p>
|
|
1461
|
-
* </li>
|
|
1462
|
-
* <li>
|
|
1463
|
-
* <p>
|
|
1464
|
-
* <i>Delete</i>: delete the file</p>
|
|
1465
|
-
* </li>
|
|
1466
|
-
* <li>
|
|
1467
|
-
* <p>
|
|
1468
|
-
* <i>Tag</i>: add a tag to the file</p>
|
|
1469
|
-
* </li>
|
|
1470
|
-
* </ul>
|
|
1471
|
-
*/
|
|
585
|
+
|
|
1472
586
|
StepType?: WorkflowStepType | string;
|
|
1473
|
-
|
|
1474
|
-
* <p>The values for the key/value pair applied as a tag to the file. Only applicable if the step type is <code>TAG</code>.</p>
|
|
1475
|
-
*/
|
|
587
|
+
|
|
1476
588
|
Outputs?: string;
|
|
1477
|
-
|
|
1478
|
-
* <p>Specifies the details for an error, if it occurred during execution of the specified workfow step.</p>
|
|
1479
|
-
*/
|
|
589
|
+
|
|
1480
590
|
Error?: ExecutionError;
|
|
1481
591
|
}
|
|
1482
592
|
export declare namespace ExecutionStepResult {
|
|
1483
|
-
|
|
1484
|
-
* @internal
|
|
1485
|
-
*/
|
|
593
|
+
|
|
1486
594
|
const filterSensitiveLog: (obj: ExecutionStepResult) => any;
|
|
1487
595
|
}
|
|
1488
|
-
|
|
1489
|
-
* <p>Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.</p>
|
|
1490
|
-
*/
|
|
596
|
+
|
|
1491
597
|
export interface ExecutionResults {
|
|
1492
|
-
|
|
1493
|
-
* <p>Specifies the details for the steps that are in the specified workflow.</p>
|
|
1494
|
-
*/
|
|
598
|
+
|
|
1495
599
|
Steps?: ExecutionStepResult[];
|
|
1496
|
-
|
|
1497
|
-
* <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p>
|
|
1498
|
-
*/
|
|
600
|
+
|
|
1499
601
|
OnExceptionSteps?: ExecutionStepResult[];
|
|
1500
602
|
}
|
|
1501
603
|
export declare namespace ExecutionResults {
|
|
1502
|
-
|
|
1503
|
-
* @internal
|
|
1504
|
-
*/
|
|
604
|
+
|
|
1505
605
|
const filterSensitiveLog: (obj: ExecutionResults) => any;
|
|
1506
606
|
}
|
|
1507
|
-
|
|
1508
|
-
* <p>Specifies the user name, server ID, and session ID for a workflow.</p>
|
|
1509
|
-
*/
|
|
607
|
+
|
|
1510
608
|
export interface UserDetails {
|
|
1511
|
-
|
|
1512
|
-
* <p>A unique string that identifies a user account associated with a server.</p>
|
|
1513
|
-
*/
|
|
609
|
+
|
|
1514
610
|
UserName: string | undefined;
|
|
1515
|
-
|
|
1516
|
-
* <p>The system-assigned unique identifier for a Transfer server instance. </p>
|
|
1517
|
-
*/
|
|
611
|
+
|
|
1518
612
|
ServerId: string | undefined;
|
|
1519
|
-
|
|
1520
|
-
* <p>The system-assigned unique identifier for a session that corresponds to the workflow.</p>
|
|
1521
|
-
*/
|
|
613
|
+
|
|
1522
614
|
SessionId?: string;
|
|
1523
615
|
}
|
|
1524
616
|
export declare namespace UserDetails {
|
|
1525
|
-
|
|
1526
|
-
* @internal
|
|
1527
|
-
*/
|
|
617
|
+
|
|
1528
618
|
const filterSensitiveLog: (obj: UserDetails) => any;
|
|
1529
619
|
}
|
|
1530
|
-
|
|
1531
|
-
* <p>A container object for the session details associated with a workflow.</p>
|
|
1532
|
-
*/
|
|
620
|
+
|
|
1533
621
|
export interface ServiceMetadata {
|
|
1534
|
-
|
|
1535
|
-
* <p>The Server ID (<code>ServerId</code>), Session ID (<code>SessionId</code>) and user (<code>UserName</code>) make up the <code>UserDetails</code>.</p>
|
|
1536
|
-
*/
|
|
622
|
+
|
|
1537
623
|
UserDetails: UserDetails | undefined;
|
|
1538
624
|
}
|
|
1539
625
|
export declare namespace ServiceMetadata {
|
|
1540
|
-
|
|
1541
|
-
* @internal
|
|
1542
|
-
*/
|
|
626
|
+
|
|
1543
627
|
const filterSensitiveLog: (obj: ServiceMetadata) => any;
|
|
1544
628
|
}
|
|
1545
629
|
export declare enum ExecutionStatus {
|
|
@@ -1548,136 +632,55 @@ export declare enum ExecutionStatus {
|
|
|
1548
632
|
HANDLING_EXCEPTION = "HANDLING_EXCEPTION",
|
|
1549
633
|
IN_PROGRESS = "IN_PROGRESS"
|
|
1550
634
|
}
|
|
1551
|
-
|
|
1552
|
-
* <p>The details for an execution object.</p>
|
|
1553
|
-
*/
|
|
635
|
+
|
|
1554
636
|
export interface DescribedExecution {
|
|
1555
|
-
|
|
1556
|
-
* <p>A unique identifier for the execution of a workflow.</p>
|
|
1557
|
-
*/
|
|
637
|
+
|
|
1558
638
|
ExecutionId?: string;
|
|
1559
|
-
|
|
1560
|
-
* <p>A structure that describes the Amazon S3 or EFS file location.
|
|
1561
|
-
* This is the file location when the execution begins: if the file is being copied,
|
|
1562
|
-
* this is the initial (as opposed to destination) file location.</p>
|
|
1563
|
-
*/
|
|
639
|
+
|
|
1564
640
|
InitialFileLocation?: FileLocation;
|
|
1565
|
-
|
|
1566
|
-
* <p>A container object for the session details associated with a workflow.</p>
|
|
1567
|
-
*/
|
|
641
|
+
|
|
1568
642
|
ServiceMetadata?: ServiceMetadata;
|
|
1569
|
-
|
|
1570
|
-
* <p>The IAM role associated with the execution.</p>
|
|
1571
|
-
*/
|
|
643
|
+
|
|
1572
644
|
ExecutionRole?: string;
|
|
1573
|
-
|
|
1574
|
-
* <p>The IAM logging role associated with the execution.</p>
|
|
1575
|
-
*/
|
|
645
|
+
|
|
1576
646
|
LoggingConfiguration?: LoggingConfiguration;
|
|
1577
|
-
|
|
1578
|
-
* <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
|
|
1579
|
-
* (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
|
|
1580
|
-
* your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
|
|
1581
|
-
* files and directories in your file system determine the level of access your users get when
|
|
1582
|
-
* transferring files into and out of your Amazon EFS file systems.</p>
|
|
1583
|
-
*/
|
|
647
|
+
|
|
1584
648
|
PosixProfile?: PosixProfile;
|
|
1585
|
-
|
|
1586
|
-
* <p>The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
|
|
1587
|
-
* </p>
|
|
1588
|
-
*/
|
|
649
|
+
|
|
1589
650
|
Status?: ExecutionStatus | string;
|
|
1590
|
-
|
|
1591
|
-
* <p>A structure that describes the execution results. This includes a list of the steps along with the details of each step,
|
|
1592
|
-
* error type and message (if any), and the <code>OnExceptionSteps</code> structure.</p>
|
|
1593
|
-
*/
|
|
651
|
+
|
|
1594
652
|
Results?: ExecutionResults;
|
|
1595
653
|
}
|
|
1596
654
|
export declare namespace DescribedExecution {
|
|
1597
|
-
|
|
1598
|
-
* @internal
|
|
1599
|
-
*/
|
|
655
|
+
|
|
1600
656
|
const filterSensitiveLog: (obj: DescribedExecution) => any;
|
|
1601
657
|
}
|
|
1602
|
-
|
|
1603
|
-
* <p>Describes the properties of a security policy that was specified. For more information
|
|
1604
|
-
* about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security
|
|
1605
|
-
* policies</a>.</p>
|
|
1606
|
-
*/
|
|
658
|
+
|
|
1607
659
|
export interface DescribedSecurityPolicy {
|
|
1608
|
-
|
|
1609
|
-
* <p>Specifies whether this policy enables Federal Information Processing Standards
|
|
1610
|
-
* (FIPS).</p>
|
|
1611
|
-
*/
|
|
660
|
+
|
|
1612
661
|
Fips?: boolean;
|
|
1613
|
-
|
|
1614
|
-
* <p>Specifies the name of the security policy that is attached to the server.</p>
|
|
1615
|
-
*/
|
|
662
|
+
|
|
1616
663
|
SecurityPolicyName: string | undefined;
|
|
1617
|
-
|
|
1618
|
-
* <p>Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security
|
|
1619
|
-
* policy that is attached to the server.</p>
|
|
1620
|
-
*/
|
|
664
|
+
|
|
1621
665
|
SshCiphers?: string[];
|
|
1622
|
-
|
|
1623
|
-
* <p>Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy
|
|
1624
|
-
* that is attached to the server.</p>
|
|
1625
|
-
*/
|
|
666
|
+
|
|
1626
667
|
SshKexs?: string[];
|
|
1627
|
-
|
|
1628
|
-
* <p>Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the
|
|
1629
|
-
* security policy that is attached to the server.</p>
|
|
1630
|
-
*/
|
|
668
|
+
|
|
1631
669
|
SshMacs?: string[];
|
|
1632
|
-
|
|
1633
|
-
* <p>Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the
|
|
1634
|
-
* security policy that is attached to the server.</p>
|
|
1635
|
-
*/
|
|
670
|
+
|
|
1636
671
|
TlsCiphers?: string[];
|
|
1637
672
|
}
|
|
1638
673
|
export declare namespace DescribedSecurityPolicy {
|
|
1639
|
-
|
|
1640
|
-
* @internal
|
|
1641
|
-
*/
|
|
674
|
+
|
|
1642
675
|
const filterSensitiveLog: (obj: DescribedSecurityPolicy) => any;
|
|
1643
676
|
}
|
|
1644
|
-
|
|
1645
|
-
* <p>
|
|
1646
|
-
* The protocol settings that are configured for your server.
|
|
1647
|
-
* </p>
|
|
1648
|
-
* <note>
|
|
1649
|
-
* <p>
|
|
1650
|
-
* This type is only valid in the <code>UpdateServer</code> API.
|
|
1651
|
-
* </p>
|
|
1652
|
-
* </note>
|
|
1653
|
-
*/
|
|
677
|
+
|
|
1654
678
|
export interface ProtocolDetails {
|
|
1655
|
-
|
|
1656
|
-
* <p>
|
|
1657
|
-
* Indicates passive mode, for FTP and FTPS protocols.
|
|
1658
|
-
* Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
|
|
1659
|
-
* For example:
|
|
1660
|
-
* </p>
|
|
1661
|
-
* <p>
|
|
1662
|
-
* <code>
|
|
1663
|
-
* aws transfer update-server --protocol-details PassiveIp=<i>0.0.0.0</i>
|
|
1664
|
-
* </code>
|
|
1665
|
-
* </p>
|
|
1666
|
-
* <p>Replace <code>
|
|
1667
|
-
* <i>0.0.0.0</i>
|
|
1668
|
-
* </code> in the example above with the actual IP address you want to use.</p>
|
|
1669
|
-
* <note>
|
|
1670
|
-
* <p>
|
|
1671
|
-
* If you change the <code>PassiveIp</code> value, you must stop and then restart your Transfer server for the change to take effect. For details on using Passive IP (PASV) in a NAT environment, see <a href="http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/">Configuring your FTPS server behind a firewall or NAT with Amazon Web Services Transfer Family</a>.
|
|
1672
|
-
* </p>
|
|
1673
|
-
* </note>
|
|
1674
|
-
*/
|
|
679
|
+
|
|
1675
680
|
PassiveIp?: string;
|
|
1676
681
|
}
|
|
1677
682
|
export declare namespace ProtocolDetails {
|
|
1678
|
-
|
|
1679
|
-
* @internal
|
|
1680
|
-
*/
|
|
683
|
+
|
|
1681
684
|
const filterSensitiveLog: (obj: ProtocolDetails) => any;
|
|
1682
685
|
}
|
|
1683
686
|
export declare enum State {
|
|
@@ -1688,1627 +691,654 @@ export declare enum State {
|
|
|
1688
691
|
STOPPING = "STOPPING",
|
|
1689
692
|
STOP_FAILED = "STOP_FAILED"
|
|
1690
693
|
}
|
|
1691
|
-
|
|
1692
|
-
* <p>Describes the properties of a file transfer protocol-enabled server that was
|
|
1693
|
-
* specified.</p>
|
|
1694
|
-
*/
|
|
694
|
+
|
|
1695
695
|
export interface DescribedServer {
|
|
1696
|
-
|
|
1697
|
-
* <p>Specifies the unique Amazon Resource Name (ARN) of the server.</p>
|
|
1698
|
-
*/
|
|
696
|
+
|
|
1699
697
|
Arn: string | undefined;
|
|
1700
|
-
|
|
1701
|
-
* <p>Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
|
|
1702
|
-
* <code>Protocols</code> is set to <code>FTPS</code>.</p>
|
|
1703
|
-
*/
|
|
698
|
+
|
|
1704
699
|
Certificate?: string;
|
|
1705
|
-
|
|
1706
|
-
* <p>
|
|
1707
|
-
* The protocol settings that are configured for your server.
|
|
1708
|
-
* </p>
|
|
1709
|
-
* <p>
|
|
1710
|
-
* Use the <code>PassiveIp</code> parameter to indicate passive mode.
|
|
1711
|
-
* Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
|
|
1712
|
-
* </p>
|
|
1713
|
-
*/
|
|
700
|
+
|
|
1714
701
|
ProtocolDetails?: ProtocolDetails;
|
|
1715
|
-
|
|
1716
|
-
* <p>Specifies the domain of the storage system that is used for file transfers.</p>
|
|
1717
|
-
*/
|
|
702
|
+
|
|
1718
703
|
Domain?: Domain | string;
|
|
1719
|
-
|
|
1720
|
-
* <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
|
1721
|
-
* When you host your endpoint within your VPC, you can make it accessible only to resources
|
|
1722
|
-
* within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over
|
|
1723
|
-
* the internet. Your VPC's default security groups are automatically assigned to your
|
|
1724
|
-
* endpoint.</p>
|
|
1725
|
-
*/
|
|
704
|
+
|
|
1726
705
|
EndpointDetails?: EndpointDetails;
|
|
1727
|
-
|
|
1728
|
-
* <p>Defines the type of endpoint that your server is connected to. If your server is connected
|
|
1729
|
-
* to a VPC endpoint, your server isn't accessible over the public internet.</p>
|
|
1730
|
-
*/
|
|
706
|
+
|
|
1731
707
|
EndpointType?: EndpointType | string;
|
|
1732
|
-
|
|
1733
|
-
* <p>Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value
|
|
1734
|
-
* is equivalent to the output of the <code>ssh-keygen -l -f my-new-server-key</code>
|
|
1735
|
-
* command.</p>
|
|
1736
|
-
*/
|
|
708
|
+
|
|
1737
709
|
HostKeyFingerprint?: string;
|
|
1738
|
-
|
|
1739
|
-
* <p>Specifies information to call a customer-supplied authentication API. This field is not
|
|
1740
|
-
* populated when the <code>IdentityProviderType</code> of a server is
|
|
1741
|
-
* <code>AWS_DIRECTORY_SERVICE</code> or <code>SERVICE_MANAGED</code>.</p>
|
|
1742
|
-
*/
|
|
710
|
+
|
|
1743
711
|
IdentityProviderDetails?: IdentityProviderDetails;
|
|
1744
|
-
|
|
1745
|
-
* <p>Specifies the mode of authentication for a server. The default value is
|
|
1746
|
-
* <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
|
|
1747
|
-
* the Amazon Web Services Transfer Family service.</p>
|
|
1748
|
-
* <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to
|
|
1749
|
-
* Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your
|
|
1750
|
-
* on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to
|
|
1751
|
-
* provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
1752
|
-
* <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The
|
|
1753
|
-
* <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call
|
|
1754
|
-
* for authentication using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
1755
|
-
*/
|
|
712
|
+
|
|
1756
713
|
IdentityProviderType?: IdentityProviderType | string;
|
|
1757
|
-
|
|
1758
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn
|
|
1759
|
-
* on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in
|
|
1760
|
-
* your CloudWatch logs.</p>
|
|
1761
|
-
*/
|
|
714
|
+
|
|
1762
715
|
LoggingRole?: string;
|
|
1763
|
-
|
|
1764
|
-
* <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
|
|
1765
|
-
* client can connect to your server's endpoint. The available protocols are:</p>
|
|
1766
|
-
*
|
|
1767
|
-
* <ul>
|
|
1768
|
-
* <li>
|
|
1769
|
-
* <p>
|
|
1770
|
-
* <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over
|
|
1771
|
-
* SSH</p>
|
|
1772
|
-
* </li>
|
|
1773
|
-
* <li>
|
|
1774
|
-
* <p>
|
|
1775
|
-
* <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS
|
|
1776
|
-
* encryption</p>
|
|
1777
|
-
* </li>
|
|
1778
|
-
* <li>
|
|
1779
|
-
* <p>
|
|
1780
|
-
* <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p>
|
|
1781
|
-
* </li>
|
|
1782
|
-
* </ul>
|
|
1783
|
-
*/
|
|
716
|
+
|
|
1784
717
|
Protocols?: (Protocol | string)[];
|
|
1785
|
-
|
|
1786
|
-
* <p>Specifies the name of the security policy that is attached to the server.</p>
|
|
1787
|
-
*/
|
|
718
|
+
|
|
1788
719
|
SecurityPolicyName?: string;
|
|
1789
|
-
|
|
1790
|
-
* <p>Specifies the unique system-assigned identifier for a server that you instantiate.</p>
|
|
1791
|
-
*/
|
|
720
|
+
|
|
1792
721
|
ServerId?: string;
|
|
1793
|
-
|
|
1794
|
-
* <p>Specifies the condition of a server for the server that was described. A value of
|
|
1795
|
-
* <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A
|
|
1796
|
-
* <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file
|
|
1797
|
-
* transfer operations.</p>
|
|
1798
|
-
*
|
|
1799
|
-
* <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicate that the server is
|
|
1800
|
-
* in an intermediate state, either not fully able to respond, or not fully offline. The values
|
|
1801
|
-
* of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error
|
|
1802
|
-
* condition.</p>
|
|
1803
|
-
*/
|
|
722
|
+
|
|
1804
723
|
State?: State | string;
|
|
1805
|
-
|
|
1806
|
-
* <p>Specifies the key-value pairs that you can use to search for and group servers that were
|
|
1807
|
-
* assigned to the server that was described.</p>
|
|
1808
|
-
*/
|
|
724
|
+
|
|
1809
725
|
Tags?: Tag[];
|
|
1810
|
-
|
|
1811
|
-
* <p>Specifies the number of users that are assigned to a server you specified with the
|
|
1812
|
-
* <code>ServerId</code>.</p>
|
|
1813
|
-
*/
|
|
726
|
+
|
|
1814
727
|
UserCount?: number;
|
|
1815
|
-
|
|
1816
|
-
* <p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>
|
|
1817
|
-
*/
|
|
728
|
+
|
|
1818
729
|
WorkflowDetails?: WorkflowDetails;
|
|
1819
730
|
}
|
|
1820
731
|
export declare namespace DescribedServer {
|
|
1821
|
-
|
|
1822
|
-
* @internal
|
|
1823
|
-
*/
|
|
732
|
+
|
|
1824
733
|
const filterSensitiveLog: (obj: DescribedServer) => any;
|
|
1825
734
|
}
|
|
1826
|
-
|
|
1827
|
-
* <p>Provides information about the public Secure Shell (SSH) key that is associated with a
|
|
1828
|
-
* user account for the specific file transfer protocol-enabled server (as identified by
|
|
1829
|
-
* <code>ServerId</code>). The information returned includes the date the key was imported, the
|
|
1830
|
-
* public key contents, and the public key ID. A user can store more than one SSH public key
|
|
1831
|
-
* associated with their user name on a specific server.</p>
|
|
1832
|
-
*/
|
|
735
|
+
|
|
1833
736
|
export interface SshPublicKey {
|
|
1834
|
-
|
|
1835
|
-
* <p>Specifies the date that the public key was added to the user account.</p>
|
|
1836
|
-
*/
|
|
737
|
+
|
|
1837
738
|
DateImported: Date | undefined;
|
|
1838
|
-
|
|
1839
|
-
* <p>Specifies the content of the SSH public key as specified by the
|
|
1840
|
-
* <code>PublicKeyId</code>.</p>
|
|
1841
|
-
*/
|
|
739
|
+
|
|
1842
740
|
SshPublicKeyBody: string | undefined;
|
|
1843
|
-
|
|
1844
|
-
* <p>Specifies the <code>SshPublicKeyId</code> parameter contains the identifier of the public
|
|
1845
|
-
* key.</p>
|
|
1846
|
-
*/
|
|
741
|
+
|
|
1847
742
|
SshPublicKeyId: string | undefined;
|
|
1848
743
|
}
|
|
1849
744
|
export declare namespace SshPublicKey {
|
|
1850
|
-
|
|
1851
|
-
* @internal
|
|
1852
|
-
*/
|
|
745
|
+
|
|
1853
746
|
const filterSensitiveLog: (obj: SshPublicKey) => any;
|
|
1854
747
|
}
|
|
1855
|
-
|
|
1856
|
-
* <p>Describes the properties of a user that was specified.</p>
|
|
1857
|
-
*/
|
|
748
|
+
|
|
1858
749
|
export interface DescribedUser {
|
|
1859
|
-
|
|
1860
|
-
* <p>Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be
|
|
1861
|
-
* described.</p>
|
|
1862
|
-
*/
|
|
750
|
+
|
|
1863
751
|
Arn: string | undefined;
|
|
1864
|
-
|
|
1865
|
-
* <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
|
|
1866
|
-
* <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
|
|
1867
|
-
*/
|
|
752
|
+
|
|
1868
753
|
HomeDirectory?: string;
|
|
1869
|
-
|
|
1870
|
-
* <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
|
|
1871
|
-
* be visible to your user and how you want to make them visible. You must specify the
|
|
1872
|
-
* <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
|
|
1873
|
-
* is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
|
|
1874
|
-
* only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity
|
|
1875
|
-
* and Access Management (IAM) role provides access to paths in <code>Target</code>. This value
|
|
1876
|
-
* can only be set when <code>HomeDirectoryType</code> is set to
|
|
1877
|
-
* <i>LOGICAL</i>.</p>
|
|
1878
|
-
*
|
|
1879
|
-
* <p>In most cases, you can use this value instead of the session policy to lock your user
|
|
1880
|
-
* down to the designated home directory ("<code>chroot</code>"). To do this, you can set
|
|
1881
|
-
* <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory
|
|
1882
|
-
* parameter value.</p>
|
|
1883
|
-
*/
|
|
754
|
+
|
|
1884
755
|
HomeDirectoryMappings?: HomeDirectoryMapEntry[];
|
|
1885
|
-
|
|
1886
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
|
|
1887
|
-
* If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
|
|
1888
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
|
|
1889
|
-
* S3 or EFS paths visible to your users.</p>
|
|
1890
|
-
*/
|
|
756
|
+
|
|
1891
757
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
1892
|
-
|
|
1893
|
-
* <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
|
|
1894
|
-
* access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
|
|
1895
|
-
* <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
|
|
1896
|
-
*/
|
|
758
|
+
|
|
1897
759
|
Policy?: string;
|
|
1898
|
-
|
|
1899
|
-
* <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID
|
|
1900
|
-
* (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
|
|
1901
|
-
* your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX
|
|
1902
|
-
* permissions that are set on files and directories in your file system determine the level of
|
|
1903
|
-
* access your users get when transferring files into and out of your Amazon EFS file
|
|
1904
|
-
* systems.</p>
|
|
1905
|
-
*/
|
|
760
|
+
|
|
1906
761
|
PosixProfile?: PosixProfile;
|
|
1907
|
-
|
|
1908
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
|
|
1909
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
|
|
1910
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
|
|
1911
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
1912
|
-
*/
|
|
762
|
+
|
|
1913
763
|
Role?: string;
|
|
1914
|
-
|
|
1915
|
-
* <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for the described
|
|
1916
|
-
* user.</p>
|
|
1917
|
-
*/
|
|
764
|
+
|
|
1918
765
|
SshPublicKeys?: SshPublicKey[];
|
|
1919
|
-
|
|
1920
|
-
* <p>Specifies the key-value pairs for the user requested. Tag can be used to search for and
|
|
1921
|
-
* group users for a variety of purposes.</p>
|
|
1922
|
-
*/
|
|
766
|
+
|
|
1923
767
|
Tags?: Tag[];
|
|
1924
|
-
|
|
1925
|
-
* <p>Specifies the name of the user that was requested to be described. User names are used for
|
|
1926
|
-
* authentication purposes. This is the string that will be used by your user when they log in to
|
|
1927
|
-
* your server.</p>
|
|
1928
|
-
*/
|
|
768
|
+
|
|
1929
769
|
UserName?: string;
|
|
1930
770
|
}
|
|
1931
771
|
export declare namespace DescribedUser {
|
|
1932
|
-
|
|
1933
|
-
* @internal
|
|
1934
|
-
*/
|
|
772
|
+
|
|
1935
773
|
const filterSensitiveLog: (obj: DescribedUser) => any;
|
|
1936
774
|
}
|
|
1937
|
-
|
|
1938
|
-
* <p>Describes the properties of the specified workflow</p>
|
|
1939
|
-
*/
|
|
775
|
+
|
|
1940
776
|
export interface DescribedWorkflow {
|
|
1941
|
-
|
|
1942
|
-
* <p>Specifies the unique Amazon Resource Name (ARN) for the workflow.</p>
|
|
1943
|
-
*/
|
|
777
|
+
|
|
1944
778
|
Arn: string | undefined;
|
|
1945
|
-
|
|
1946
|
-
* <p>Specifies the text description for the workflow.</p>
|
|
1947
|
-
*/
|
|
779
|
+
|
|
1948
780
|
Description?: string;
|
|
1949
|
-
|
|
1950
|
-
* <p>Specifies the details for the steps that are in the specified workflow.</p>
|
|
1951
|
-
*/
|
|
781
|
+
|
|
1952
782
|
Steps?: WorkflowStep[];
|
|
1953
|
-
|
|
1954
|
-
* <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p>
|
|
1955
|
-
*/
|
|
783
|
+
|
|
1956
784
|
OnExceptionSteps?: WorkflowStep[];
|
|
1957
|
-
|
|
1958
|
-
* <p>A unique identifier for the workflow.</p>
|
|
1959
|
-
*/
|
|
785
|
+
|
|
1960
786
|
WorkflowId?: string;
|
|
1961
|
-
|
|
1962
|
-
* <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</p>
|
|
1963
|
-
*/
|
|
787
|
+
|
|
1964
788
|
Tags?: Tag[];
|
|
1965
789
|
}
|
|
1966
790
|
export declare namespace DescribedWorkflow {
|
|
1967
|
-
|
|
1968
|
-
* @internal
|
|
1969
|
-
*/
|
|
791
|
+
|
|
1970
792
|
const filterSensitiveLog: (obj: DescribedWorkflow) => any;
|
|
1971
793
|
}
|
|
1972
794
|
export interface DescribeExecutionRequest {
|
|
1973
|
-
|
|
1974
|
-
* <p>A unique identifier for the execution of a workflow.</p>
|
|
1975
|
-
*/
|
|
795
|
+
|
|
1976
796
|
ExecutionId: string | undefined;
|
|
1977
|
-
|
|
1978
|
-
* <p>A unique identifier for the workflow.</p>
|
|
1979
|
-
*/
|
|
797
|
+
|
|
1980
798
|
WorkflowId: string | undefined;
|
|
1981
799
|
}
|
|
1982
800
|
export declare namespace DescribeExecutionRequest {
|
|
1983
|
-
|
|
1984
|
-
* @internal
|
|
1985
|
-
*/
|
|
801
|
+
|
|
1986
802
|
const filterSensitiveLog: (obj: DescribeExecutionRequest) => any;
|
|
1987
803
|
}
|
|
1988
804
|
export interface DescribeExecutionResponse {
|
|
1989
|
-
|
|
1990
|
-
* <p>A unique identifier for the workflow.</p>
|
|
1991
|
-
*/
|
|
805
|
+
|
|
1992
806
|
WorkflowId: string | undefined;
|
|
1993
|
-
|
|
1994
|
-
* <p>The structure that contains the details of the workflow' execution.</p>
|
|
1995
|
-
*/
|
|
807
|
+
|
|
1996
808
|
Execution: DescribedExecution | undefined;
|
|
1997
809
|
}
|
|
1998
810
|
export declare namespace DescribeExecutionResponse {
|
|
1999
|
-
|
|
2000
|
-
* @internal
|
|
2001
|
-
*/
|
|
811
|
+
|
|
2002
812
|
const filterSensitiveLog: (obj: DescribeExecutionResponse) => any;
|
|
2003
813
|
}
|
|
2004
814
|
export interface DescribeSecurityPolicyRequest {
|
|
2005
|
-
|
|
2006
|
-
* <p>Specifies the name of the security policy that is attached to the server.</p>
|
|
2007
|
-
*/
|
|
815
|
+
|
|
2008
816
|
SecurityPolicyName: string | undefined;
|
|
2009
817
|
}
|
|
2010
818
|
export declare namespace DescribeSecurityPolicyRequest {
|
|
2011
|
-
|
|
2012
|
-
* @internal
|
|
2013
|
-
*/
|
|
819
|
+
|
|
2014
820
|
const filterSensitiveLog: (obj: DescribeSecurityPolicyRequest) => any;
|
|
2015
821
|
}
|
|
2016
822
|
export interface DescribeSecurityPolicyResponse {
|
|
2017
|
-
|
|
2018
|
-
* <p>An array containing the properties of the security policy.</p>
|
|
2019
|
-
*/
|
|
823
|
+
|
|
2020
824
|
SecurityPolicy: DescribedSecurityPolicy | undefined;
|
|
2021
825
|
}
|
|
2022
826
|
export declare namespace DescribeSecurityPolicyResponse {
|
|
2023
|
-
|
|
2024
|
-
* @internal
|
|
2025
|
-
*/
|
|
827
|
+
|
|
2026
828
|
const filterSensitiveLog: (obj: DescribeSecurityPolicyResponse) => any;
|
|
2027
829
|
}
|
|
2028
830
|
export interface DescribeServerRequest {
|
|
2029
|
-
|
|
2030
|
-
* <p>A system-assigned unique identifier for a server.</p>
|
|
2031
|
-
*/
|
|
831
|
+
|
|
2032
832
|
ServerId: string | undefined;
|
|
2033
833
|
}
|
|
2034
834
|
export declare namespace DescribeServerRequest {
|
|
2035
|
-
|
|
2036
|
-
* @internal
|
|
2037
|
-
*/
|
|
835
|
+
|
|
2038
836
|
const filterSensitiveLog: (obj: DescribeServerRequest) => any;
|
|
2039
837
|
}
|
|
2040
838
|
export interface DescribeServerResponse {
|
|
2041
|
-
|
|
2042
|
-
* <p>An array containing the properties of a server with the <code>ServerID</code> you
|
|
2043
|
-
* specified.</p>
|
|
2044
|
-
*/
|
|
839
|
+
|
|
2045
840
|
Server: DescribedServer | undefined;
|
|
2046
841
|
}
|
|
2047
842
|
export declare namespace DescribeServerResponse {
|
|
2048
|
-
|
|
2049
|
-
* @internal
|
|
2050
|
-
*/
|
|
843
|
+
|
|
2051
844
|
const filterSensitiveLog: (obj: DescribeServerResponse) => any;
|
|
2052
845
|
}
|
|
2053
846
|
export interface DescribeUserRequest {
|
|
2054
|
-
|
|
2055
|
-
* <p>A system-assigned unique identifier for a server that has this user assigned.</p>
|
|
2056
|
-
*/
|
|
847
|
+
|
|
2057
848
|
ServerId: string | undefined;
|
|
2058
|
-
|
|
2059
|
-
* <p>The name of the user assigned to one or more servers. User names are part of the sign-in
|
|
2060
|
-
* credentials to use the Amazon Web Services Transfer Family service and perform file transfer tasks.</p>
|
|
2061
|
-
*/
|
|
849
|
+
|
|
2062
850
|
UserName: string | undefined;
|
|
2063
851
|
}
|
|
2064
852
|
export declare namespace DescribeUserRequest {
|
|
2065
|
-
|
|
2066
|
-
* @internal
|
|
2067
|
-
*/
|
|
853
|
+
|
|
2068
854
|
const filterSensitiveLog: (obj: DescribeUserRequest) => any;
|
|
2069
855
|
}
|
|
2070
856
|
export interface DescribeUserResponse {
|
|
2071
|
-
|
|
2072
|
-
* <p>A system-assigned unique identifier for a server that has this user assigned.</p>
|
|
2073
|
-
*/
|
|
857
|
+
|
|
2074
858
|
ServerId: string | undefined;
|
|
2075
|
-
|
|
2076
|
-
* <p>An array containing the properties of the user account for the <code>ServerID</code> value
|
|
2077
|
-
* that you specified.</p>
|
|
2078
|
-
*/
|
|
859
|
+
|
|
2079
860
|
User: DescribedUser | undefined;
|
|
2080
861
|
}
|
|
2081
862
|
export declare namespace DescribeUserResponse {
|
|
2082
|
-
|
|
2083
|
-
* @internal
|
|
2084
|
-
*/
|
|
863
|
+
|
|
2085
864
|
const filterSensitiveLog: (obj: DescribeUserResponse) => any;
|
|
2086
865
|
}
|
|
2087
866
|
export interface DescribeWorkflowRequest {
|
|
2088
|
-
|
|
2089
|
-
* <p>A unique identifier for the workflow.</p>
|
|
2090
|
-
*/
|
|
867
|
+
|
|
2091
868
|
WorkflowId: string | undefined;
|
|
2092
869
|
}
|
|
2093
870
|
export declare namespace DescribeWorkflowRequest {
|
|
2094
|
-
|
|
2095
|
-
* @internal
|
|
2096
|
-
*/
|
|
871
|
+
|
|
2097
872
|
const filterSensitiveLog: (obj: DescribeWorkflowRequest) => any;
|
|
2098
873
|
}
|
|
2099
874
|
export interface DescribeWorkflowResponse {
|
|
2100
|
-
|
|
2101
|
-
* <p>The structure that contains the details of the workflow.</p>
|
|
2102
|
-
*/
|
|
875
|
+
|
|
2103
876
|
Workflow: DescribedWorkflow | undefined;
|
|
2104
877
|
}
|
|
2105
878
|
export declare namespace DescribeWorkflowResponse {
|
|
2106
|
-
|
|
2107
|
-
* @internal
|
|
2108
|
-
*/
|
|
879
|
+
|
|
2109
880
|
const filterSensitiveLog: (obj: DescribeWorkflowResponse) => any;
|
|
2110
881
|
}
|
|
2111
882
|
export interface ImportSshPublicKeyRequest {
|
|
2112
|
-
|
|
2113
|
-
* <p>A system-assigned unique identifier for a server.</p>
|
|
2114
|
-
*/
|
|
883
|
+
|
|
2115
884
|
ServerId: string | undefined;
|
|
2116
|
-
|
|
2117
|
-
* <p>The public key portion of an SSH key pair.</p>
|
|
2118
|
-
*/
|
|
885
|
+
|
|
2119
886
|
SshPublicKeyBody: string | undefined;
|
|
2120
|
-
|
|
2121
|
-
* <p>The name of the user account that is assigned to one or more servers.</p>
|
|
2122
|
-
*/
|
|
887
|
+
|
|
2123
888
|
UserName: string | undefined;
|
|
2124
889
|
}
|
|
2125
890
|
export declare namespace ImportSshPublicKeyRequest {
|
|
2126
|
-
|
|
2127
|
-
* @internal
|
|
2128
|
-
*/
|
|
891
|
+
|
|
2129
892
|
const filterSensitiveLog: (obj: ImportSshPublicKeyRequest) => any;
|
|
2130
893
|
}
|
|
2131
|
-
|
|
2132
|
-
* <p>Identifies the user, the server they belong to, and the identifier of the SSH public key
|
|
2133
|
-
* associated with that user. A user can have more than one key on each server that they are
|
|
2134
|
-
* associated with.</p>
|
|
2135
|
-
*/
|
|
894
|
+
|
|
2136
895
|
export interface ImportSshPublicKeyResponse {
|
|
2137
|
-
|
|
2138
|
-
* <p>A system-assigned unique identifier for a server.</p>
|
|
2139
|
-
*/
|
|
896
|
+
|
|
2140
897
|
ServerId: string | undefined;
|
|
2141
|
-
|
|
2142
|
-
* <p>The name given to a public key by the system that was imported.</p>
|
|
2143
|
-
*/
|
|
898
|
+
|
|
2144
899
|
SshPublicKeyId: string | undefined;
|
|
2145
|
-
|
|
2146
|
-
* <p>A user name assigned to the <code>ServerID</code> value that you specified.</p>
|
|
2147
|
-
*/
|
|
900
|
+
|
|
2148
901
|
UserName: string | undefined;
|
|
2149
902
|
}
|
|
2150
903
|
export declare namespace ImportSshPublicKeyResponse {
|
|
2151
|
-
|
|
2152
|
-
* @internal
|
|
2153
|
-
*/
|
|
904
|
+
|
|
2154
905
|
const filterSensitiveLog: (obj: ImportSshPublicKeyResponse) => any;
|
|
2155
906
|
}
|
|
2156
|
-
|
|
2157
|
-
* <p>The <code>NextToken</code> parameter that was passed is invalid.</p>
|
|
2158
|
-
*/
|
|
907
|
+
|
|
2159
908
|
export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
|
|
2160
909
|
name: "InvalidNextTokenException";
|
|
2161
910
|
$fault: "client";
|
|
2162
911
|
Message: string | undefined;
|
|
2163
912
|
}
|
|
2164
913
|
export declare namespace InvalidNextTokenException {
|
|
2165
|
-
|
|
2166
|
-
* @internal
|
|
2167
|
-
*/
|
|
914
|
+
|
|
2168
915
|
const filterSensitiveLog: (obj: InvalidNextTokenException) => any;
|
|
2169
916
|
}
|
|
2170
917
|
export interface ListAccessesRequest {
|
|
2171
|
-
|
|
2172
|
-
* <p>Specifies the maximum number of access SIDs to return.</p>
|
|
2173
|
-
*/
|
|
918
|
+
|
|
2174
919
|
MaxResults?: number;
|
|
2175
|
-
|
|
2176
|
-
* <p>When you can get additional results from the <code>ListAccesses</code> call, a
|
|
2177
|
-
* <code>NextToken</code> parameter is returned in the output. You can then pass in a
|
|
2178
|
-
* subsequent command to the <code>NextToken</code> parameter to continue listing additional
|
|
2179
|
-
* accesses.</p>
|
|
2180
|
-
*/
|
|
920
|
+
|
|
2181
921
|
NextToken?: string;
|
|
2182
|
-
|
|
2183
|
-
* <p>A system-assigned unique identifier for a server that has users assigned to it.</p>
|
|
2184
|
-
*/
|
|
922
|
+
|
|
2185
923
|
ServerId: string | undefined;
|
|
2186
924
|
}
|
|
2187
925
|
export declare namespace ListAccessesRequest {
|
|
2188
|
-
|
|
2189
|
-
* @internal
|
|
2190
|
-
*/
|
|
926
|
+
|
|
2191
927
|
const filterSensitiveLog: (obj: ListAccessesRequest) => any;
|
|
2192
928
|
}
|
|
2193
|
-
|
|
2194
|
-
* <p>Lists the properties for one or more specified associated accesses.</p>
|
|
2195
|
-
*/
|
|
929
|
+
|
|
2196
930
|
export interface ListedAccess {
|
|
2197
|
-
|
|
2198
|
-
* <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
|
|
2199
|
-
* <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
|
|
2200
|
-
*/
|
|
931
|
+
|
|
2201
932
|
HomeDirectory?: string;
|
|
2202
|
-
|
|
2203
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
|
|
2204
|
-
* If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
|
|
2205
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
|
|
2206
|
-
* S3 or EFS paths visible to your users.</p>
|
|
2207
|
-
*/
|
|
933
|
+
|
|
2208
934
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
2209
|
-
|
|
2210
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
|
|
2211
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
|
|
2212
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
|
|
2213
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
2214
|
-
*/
|
|
935
|
+
|
|
2215
936
|
Role?: string;
|
|
2216
|
-
|
|
2217
|
-
* <p>A unique identifier that is required to identify specific groups within your directory.
|
|
2218
|
-
* The users of the group that you associate have access to your Amazon S3 or Amazon EFS
|
|
2219
|
-
* resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,
|
|
2220
|
-
* you can view the SID values by running the following command using Windows PowerShell.</p>
|
|
2221
|
-
*
|
|
2222
|
-
* <p>
|
|
2223
|
-
* <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code>
|
|
2224
|
-
* </p>
|
|
2225
|
-
*
|
|
2226
|
-
* <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
|
|
2227
|
-
*
|
|
2228
|
-
* <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
|
|
2229
|
-
* You can also include underscores or any of the following characters: =,.@:/-</p>
|
|
2230
|
-
*/
|
|
937
|
+
|
|
2231
938
|
ExternalId?: string;
|
|
2232
939
|
}
|
|
2233
940
|
export declare namespace ListedAccess {
|
|
2234
|
-
|
|
2235
|
-
* @internal
|
|
2236
|
-
*/
|
|
941
|
+
|
|
2237
942
|
const filterSensitiveLog: (obj: ListedAccess) => any;
|
|
2238
943
|
}
|
|
2239
944
|
export interface ListAccessesResponse {
|
|
2240
|
-
|
|
2241
|
-
* <p>When you can get additional results from the <code>ListAccesses</code> call, a
|
|
2242
|
-
* <code>NextToken</code> parameter is returned in the output. You can then pass in a
|
|
2243
|
-
* subsequent command to the <code>NextToken</code> parameter to continue listing additional
|
|
2244
|
-
* accesses.</p>
|
|
2245
|
-
*/
|
|
945
|
+
|
|
2246
946
|
NextToken?: string;
|
|
2247
|
-
|
|
2248
|
-
* <p>A system-assigned unique identifier for a server that has users assigned to it.</p>
|
|
2249
|
-
*/
|
|
947
|
+
|
|
2250
948
|
ServerId: string | undefined;
|
|
2251
|
-
|
|
2252
|
-
* <p>Returns the accesses and their properties for the <code>ServerId</code> value that you
|
|
2253
|
-
* specify.</p>
|
|
2254
|
-
*/
|
|
949
|
+
|
|
2255
950
|
Accesses: ListedAccess[] | undefined;
|
|
2256
951
|
}
|
|
2257
952
|
export declare namespace ListAccessesResponse {
|
|
2258
|
-
|
|
2259
|
-
* @internal
|
|
2260
|
-
*/
|
|
953
|
+
|
|
2261
954
|
const filterSensitiveLog: (obj: ListAccessesResponse) => any;
|
|
2262
955
|
}
|
|
2263
|
-
|
|
2264
|
-
* <p>Returns properties of the execution that is specified.</p>
|
|
2265
|
-
*/
|
|
956
|
+
|
|
2266
957
|
export interface ListedExecution {
|
|
2267
|
-
|
|
2268
|
-
* <p>A unique identifier for the execution of a workflow.</p>
|
|
2269
|
-
*/
|
|
958
|
+
|
|
2270
959
|
ExecutionId?: string;
|
|
2271
|
-
|
|
2272
|
-
* <p>A structure that describes the Amazon S3 or EFS file location.
|
|
2273
|
-
* This is the file location when the execution begins: if the file is being copied,
|
|
2274
|
-
* this is the initial (as opposed to destination) file location.</p>
|
|
2275
|
-
*/
|
|
960
|
+
|
|
2276
961
|
InitialFileLocation?: FileLocation;
|
|
2277
|
-
|
|
2278
|
-
* <p>A container object for the session details associated with a workflow.</p>
|
|
2279
|
-
*/
|
|
962
|
+
|
|
2280
963
|
ServiceMetadata?: ServiceMetadata;
|
|
2281
|
-
|
|
2282
|
-
* <p>The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.</p>
|
|
2283
|
-
*/
|
|
964
|
+
|
|
2284
965
|
Status?: ExecutionStatus | string;
|
|
2285
966
|
}
|
|
2286
967
|
export declare namespace ListedExecution {
|
|
2287
|
-
|
|
2288
|
-
* @internal
|
|
2289
|
-
*/
|
|
968
|
+
|
|
2290
969
|
const filterSensitiveLog: (obj: ListedExecution) => any;
|
|
2291
970
|
}
|
|
2292
|
-
|
|
2293
|
-
* <p>Returns properties of a file transfer protocol-enabled server that was specified.</p>
|
|
2294
|
-
*/
|
|
971
|
+
|
|
2295
972
|
export interface ListedServer {
|
|
2296
|
-
|
|
2297
|
-
* <p>Specifies the unique Amazon Resource Name (ARN) for a server to be listed.</p>
|
|
2298
|
-
*/
|
|
973
|
+
|
|
2299
974
|
Arn: string | undefined;
|
|
2300
|
-
|
|
2301
|
-
* <p>Specifies the domain of the storage system that is used for file transfers.</p>
|
|
2302
|
-
*/
|
|
975
|
+
|
|
2303
976
|
Domain?: Domain | string;
|
|
2304
|
-
|
|
2305
|
-
* <p>Specifies the mode of authentication for a server. The default value is
|
|
2306
|
-
* <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
|
|
2307
|
-
* the Amazon Web Services Transfer Family service.</p>
|
|
2308
|
-
* <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to
|
|
2309
|
-
* Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your
|
|
2310
|
-
* on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to
|
|
2311
|
-
* provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
2312
|
-
* <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The
|
|
2313
|
-
* <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call
|
|
2314
|
-
* for authentication using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
2315
|
-
*/
|
|
977
|
+
|
|
2316
978
|
IdentityProviderType?: IdentityProviderType | string;
|
|
2317
|
-
|
|
2318
|
-
* <p>Specifies the type of VPC endpoint that your server is connected to. If your server is
|
|
2319
|
-
* connected to a VPC endpoint, your server isn't accessible over the public internet.</p>
|
|
2320
|
-
*/
|
|
979
|
+
|
|
2321
980
|
EndpointType?: EndpointType | string;
|
|
2322
|
-
|
|
2323
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn
|
|
2324
|
-
* on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in
|
|
2325
|
-
* your CloudWatch logs.</p>
|
|
2326
|
-
*/
|
|
981
|
+
|
|
2327
982
|
LoggingRole?: string;
|
|
2328
|
-
|
|
2329
|
-
* <p>Specifies the unique system assigned identifier for the servers that were listed.</p>
|
|
2330
|
-
*/
|
|
983
|
+
|
|
2331
984
|
ServerId?: string;
|
|
2332
|
-
|
|
2333
|
-
* <p>Specifies the condition of a server for the server that was described. A value of
|
|
2334
|
-
* <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A
|
|
2335
|
-
* <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file
|
|
2336
|
-
* transfer operations.</p>
|
|
2337
|
-
*
|
|
2338
|
-
* <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicate that the server is
|
|
2339
|
-
* in an intermediate state, either not fully able to respond, or not fully offline. The values
|
|
2340
|
-
* of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error
|
|
2341
|
-
* condition.</p>
|
|
2342
|
-
*/
|
|
985
|
+
|
|
2343
986
|
State?: State | string;
|
|
2344
|
-
|
|
2345
|
-
* <p>Specifies the number of users that are assigned to a server you specified with the
|
|
2346
|
-
* <code>ServerId</code>.</p>
|
|
2347
|
-
*/
|
|
987
|
+
|
|
2348
988
|
UserCount?: number;
|
|
2349
989
|
}
|
|
2350
990
|
export declare namespace ListedServer {
|
|
2351
|
-
|
|
2352
|
-
* @internal
|
|
2353
|
-
*/
|
|
991
|
+
|
|
2354
992
|
const filterSensitiveLog: (obj: ListedServer) => any;
|
|
2355
993
|
}
|
|
2356
|
-
|
|
2357
|
-
* <p>Returns properties of the user that you specify.</p>
|
|
2358
|
-
*/
|
|
994
|
+
|
|
2359
995
|
export interface ListedUser {
|
|
2360
|
-
|
|
2361
|
-
* <p>Provides the unique Amazon Resource Name (ARN) for the user that you want to learn
|
|
2362
|
-
* about.</p>
|
|
2363
|
-
*/
|
|
996
|
+
|
|
2364
997
|
Arn: string | undefined;
|
|
2365
|
-
|
|
2366
|
-
* <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
|
|
2367
|
-
* <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
|
|
2368
|
-
*/
|
|
998
|
+
|
|
2369
999
|
HomeDirectory?: string;
|
|
2370
|
-
|
|
2371
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
|
|
2372
|
-
* If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
|
|
2373
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
|
|
2374
|
-
* S3 or EFS paths visible to your users.</p>
|
|
2375
|
-
*/
|
|
1000
|
+
|
|
2376
1001
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
2377
|
-
|
|
2378
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
|
|
2379
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
|
|
2380
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
|
|
2381
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
2382
|
-
* <note>
|
|
2383
|
-
*
|
|
2384
|
-
* <p>The IAM role that controls your users' access to your Amazon S3 bucket for servers with <code>Domain=S3</code>, or your EFS file system for servers with <code>Domain=EFS</code>.
|
|
2385
|
-
* </p>
|
|
2386
|
-
* <p>The policies attached to this role determine the level of access you want to provide your users when
|
|
2387
|
-
* transferring files into and out of your S3 buckets or EFS file systems.</p>
|
|
2388
|
-
*
|
|
2389
|
-
* </note>
|
|
2390
|
-
*/
|
|
1002
|
+
|
|
2391
1003
|
Role?: string;
|
|
2392
|
-
|
|
2393
|
-
* <p>Specifies the number of SSH public keys stored for the user you specified.</p>
|
|
2394
|
-
*/
|
|
1004
|
+
|
|
2395
1005
|
SshPublicKeyCount?: number;
|
|
2396
|
-
|
|
2397
|
-
* <p>Specifies the name of the user whose ARN was specified. User names are used for
|
|
2398
|
-
* authentication purposes.</p>
|
|
2399
|
-
*/
|
|
1006
|
+
|
|
2400
1007
|
UserName?: string;
|
|
2401
1008
|
}
|
|
2402
1009
|
export declare namespace ListedUser {
|
|
2403
|
-
|
|
2404
|
-
* @internal
|
|
2405
|
-
*/
|
|
1010
|
+
|
|
2406
1011
|
const filterSensitiveLog: (obj: ListedUser) => any;
|
|
2407
1012
|
}
|
|
2408
|
-
|
|
2409
|
-
* <p>Contains the ID, text description, and Amazon Resource Name (ARN) for the workflow.</p>
|
|
2410
|
-
*/
|
|
1013
|
+
|
|
2411
1014
|
export interface ListedWorkflow {
|
|
2412
|
-
|
|
2413
|
-
* <p>A unique identifier for the workflow.</p>
|
|
2414
|
-
*/
|
|
1015
|
+
|
|
2415
1016
|
WorkflowId?: string;
|
|
2416
|
-
|
|
2417
|
-
* <p>Specifies the text description for the workflow.</p>
|
|
2418
|
-
*/
|
|
1017
|
+
|
|
2419
1018
|
Description?: string;
|
|
2420
|
-
|
|
2421
|
-
* <p>Specifies the unique Amazon Resource Name (ARN) for the workflow.</p>
|
|
2422
|
-
*/
|
|
1019
|
+
|
|
2423
1020
|
Arn?: string;
|
|
2424
1021
|
}
|
|
2425
1022
|
export declare namespace ListedWorkflow {
|
|
2426
|
-
|
|
2427
|
-
* @internal
|
|
2428
|
-
*/
|
|
1023
|
+
|
|
2429
1024
|
const filterSensitiveLog: (obj: ListedWorkflow) => any;
|
|
2430
1025
|
}
|
|
2431
1026
|
export interface ListExecutionsRequest {
|
|
2432
|
-
|
|
2433
|
-
* <p>Specifies the aximum number of executions to return.</p>
|
|
2434
|
-
*/
|
|
1027
|
+
|
|
2435
1028
|
MaxResults?: number;
|
|
2436
|
-
|
|
2437
|
-
* <p>
|
|
2438
|
-
* <code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output.
|
|
2439
|
-
* You can then pass the <code>NextToken</code> parameter in a subsequent command to
|
|
2440
|
-
* continue listing additional executions.</p>
|
|
2441
|
-
* <p>
|
|
2442
|
-
* This is useful for pagination, for instance.
|
|
2443
|
-
* If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the <code>max-results</code>:
|
|
2444
|
-
* </p>
|
|
2445
|
-
* <p>
|
|
2446
|
-
* <code>aws transfer list-executions --max-results 10</code>
|
|
2447
|
-
* </p>
|
|
2448
|
-
* <p>
|
|
2449
|
-
* This returns details for the first 10 executions, as well as the pointer (<code>NextToken</code>) to the eleventh execution.
|
|
2450
|
-
* You can now call the API again, suppling the <code>NextToken</code> value you received:
|
|
2451
|
-
* </p>
|
|
2452
|
-
* <p>
|
|
2453
|
-
* <code>aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult</code>
|
|
2454
|
-
* </p>
|
|
2455
|
-
* <p>
|
|
2456
|
-
* This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details
|
|
2457
|
-
* for all 100 executions have been returned.
|
|
2458
|
-
* </p>
|
|
2459
|
-
*/
|
|
1029
|
+
|
|
2460
1030
|
NextToken?: string;
|
|
2461
|
-
|
|
2462
|
-
* <p>A unique identifier for the workflow.</p>
|
|
2463
|
-
*/
|
|
1031
|
+
|
|
2464
1032
|
WorkflowId: string | undefined;
|
|
2465
1033
|
}
|
|
2466
1034
|
export declare namespace ListExecutionsRequest {
|
|
2467
|
-
|
|
2468
|
-
* @internal
|
|
2469
|
-
*/
|
|
1035
|
+
|
|
2470
1036
|
const filterSensitiveLog: (obj: ListExecutionsRequest) => any;
|
|
2471
1037
|
}
|
|
2472
1038
|
export interface ListExecutionsResponse {
|
|
2473
|
-
|
|
2474
|
-
* <p>
|
|
2475
|
-
* <code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output.
|
|
2476
|
-
* You can then pass the <code>NextToken</code> parameter in a subsequent command to
|
|
2477
|
-
* continue listing additional executions.</p>
|
|
2478
|
-
*/
|
|
1039
|
+
|
|
2479
1040
|
NextToken?: string;
|
|
2480
|
-
|
|
2481
|
-
* <p>A unique identifier for the workflow.</p>
|
|
2482
|
-
*/
|
|
1041
|
+
|
|
2483
1042
|
WorkflowId: string | undefined;
|
|
2484
|
-
|
|
2485
|
-
* <p>Returns the details for each execution.</p>
|
|
2486
|
-
* <ul>
|
|
2487
|
-
* <li>
|
|
2488
|
-
* <p>
|
|
2489
|
-
* <b>NextToken</b>: returned from a call to several APIs,
|
|
2490
|
-
* you can use pass it to a subsequent command to continue listing additional executions.</p>
|
|
2491
|
-
* </li>
|
|
2492
|
-
* <li>
|
|
2493
|
-
* <p>
|
|
2494
|
-
* <b>StartTime</b>: timestamp indicating when the execution began.</p>
|
|
2495
|
-
* </li>
|
|
2496
|
-
* <li>
|
|
2497
|
-
* <p>
|
|
2498
|
-
* <b>Executions</b>: details of the execution, including the execution ID, initial file location,
|
|
2499
|
-
* and Service metadata.</p>
|
|
2500
|
-
* </li>
|
|
2501
|
-
* <li>
|
|
2502
|
-
* <p>
|
|
2503
|
-
* <b>Status</b>: one of the following values:
|
|
2504
|
-
* <code>IN_PROGRESS</code>, <code>COMPLETED</code>, <code>EXCEPTION</code>, <code>HANDLING_EXEPTION</code>.
|
|
2505
|
-
* </p>
|
|
2506
|
-
* </li>
|
|
2507
|
-
* </ul>
|
|
2508
|
-
*/
|
|
1043
|
+
|
|
2509
1044
|
Executions: ListedExecution[] | undefined;
|
|
2510
1045
|
}
|
|
2511
1046
|
export declare namespace ListExecutionsResponse {
|
|
2512
|
-
|
|
2513
|
-
* @internal
|
|
2514
|
-
*/
|
|
1047
|
+
|
|
2515
1048
|
const filterSensitiveLog: (obj: ListExecutionsResponse) => any;
|
|
2516
1049
|
}
|
|
2517
1050
|
export interface ListSecurityPoliciesRequest {
|
|
2518
|
-
|
|
2519
|
-
* <p>Specifies the number of security policies to return as a response to the
|
|
2520
|
-
* <code>ListSecurityPolicies</code> query.</p>
|
|
2521
|
-
*/
|
|
1051
|
+
|
|
2522
1052
|
MaxResults?: number;
|
|
2523
|
-
|
|
2524
|
-
* <p>When additional results are obtained from the <code>ListSecurityPolicies</code> command, a
|
|
2525
|
-
* <code>NextToken</code> parameter is returned in the output. You can then pass the
|
|
2526
|
-
* <code>NextToken</code> parameter in a subsequent command to continue listing additional
|
|
2527
|
-
* security policies.</p>
|
|
2528
|
-
*/
|
|
1053
|
+
|
|
2529
1054
|
NextToken?: string;
|
|
2530
1055
|
}
|
|
2531
1056
|
export declare namespace ListSecurityPoliciesRequest {
|
|
2532
|
-
|
|
2533
|
-
* @internal
|
|
2534
|
-
*/
|
|
1057
|
+
|
|
2535
1058
|
const filterSensitiveLog: (obj: ListSecurityPoliciesRequest) => any;
|
|
2536
1059
|
}
|
|
2537
1060
|
export interface ListSecurityPoliciesResponse {
|
|
2538
|
-
|
|
2539
|
-
* <p>When you can get additional results from the <code>ListSecurityPolicies</code> operation,
|
|
2540
|
-
* a <code>NextToken</code> parameter is returned in the output. In a following command, you can
|
|
2541
|
-
* pass in the <code>NextToken</code> parameter to continue listing security policies.</p>
|
|
2542
|
-
*/
|
|
1061
|
+
|
|
2543
1062
|
NextToken?: string;
|
|
2544
|
-
|
|
2545
|
-
* <p>An array of security policies that were listed.</p>
|
|
2546
|
-
*/
|
|
1063
|
+
|
|
2547
1064
|
SecurityPolicyNames: string[] | undefined;
|
|
2548
1065
|
}
|
|
2549
1066
|
export declare namespace ListSecurityPoliciesResponse {
|
|
2550
|
-
|
|
2551
|
-
* @internal
|
|
2552
|
-
*/
|
|
1067
|
+
|
|
2553
1068
|
const filterSensitiveLog: (obj: ListSecurityPoliciesResponse) => any;
|
|
2554
1069
|
}
|
|
2555
1070
|
export interface ListServersRequest {
|
|
2556
|
-
|
|
2557
|
-
* <p>Specifies the number of servers to return as a response to the <code>ListServers</code>
|
|
2558
|
-
* query.</p>
|
|
2559
|
-
*/
|
|
1071
|
+
|
|
2560
1072
|
MaxResults?: number;
|
|
2561
|
-
|
|
2562
|
-
* <p>When additional results are obtained from the <code>ListServers</code> command, a
|
|
2563
|
-
* <code>NextToken</code> parameter is returned in the output. You can then pass the
|
|
2564
|
-
* <code>NextToken</code> parameter in a subsequent command to continue listing additional
|
|
2565
|
-
* servers.</p>
|
|
2566
|
-
*/
|
|
1073
|
+
|
|
2567
1074
|
NextToken?: string;
|
|
2568
1075
|
}
|
|
2569
1076
|
export declare namespace ListServersRequest {
|
|
2570
|
-
|
|
2571
|
-
* @internal
|
|
2572
|
-
*/
|
|
1077
|
+
|
|
2573
1078
|
const filterSensitiveLog: (obj: ListServersRequest) => any;
|
|
2574
1079
|
}
|
|
2575
1080
|
export interface ListServersResponse {
|
|
2576
|
-
|
|
2577
|
-
* <p>When you can get additional results from the <code>ListServers</code> operation, a
|
|
2578
|
-
* <code>NextToken</code> parameter is returned in the output. In a following command, you can
|
|
2579
|
-
* pass in the <code>NextToken</code> parameter to continue listing additional servers.</p>
|
|
2580
|
-
*/
|
|
1081
|
+
|
|
2581
1082
|
NextToken?: string;
|
|
2582
|
-
|
|
2583
|
-
* <p>An array of servers that were listed.</p>
|
|
2584
|
-
*/
|
|
1083
|
+
|
|
2585
1084
|
Servers: ListedServer[] | undefined;
|
|
2586
1085
|
}
|
|
2587
1086
|
export declare namespace ListServersResponse {
|
|
2588
|
-
|
|
2589
|
-
* @internal
|
|
2590
|
-
*/
|
|
1087
|
+
|
|
2591
1088
|
const filterSensitiveLog: (obj: ListServersResponse) => any;
|
|
2592
1089
|
}
|
|
2593
1090
|
export interface ListTagsForResourceRequest {
|
|
2594
|
-
|
|
2595
|
-
* <p>Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an
|
|
2596
|
-
* identifier for a specific Amazon Web Services resource, such as a server, user, or role.</p>
|
|
2597
|
-
*/
|
|
1091
|
+
|
|
2598
1092
|
Arn: string | undefined;
|
|
2599
|
-
|
|
2600
|
-
* <p>Specifies the number of tags to return as a response to the
|
|
2601
|
-
* <code>ListTagsForResource</code> request.</p>
|
|
2602
|
-
*/
|
|
1093
|
+
|
|
2603
1094
|
MaxResults?: number;
|
|
2604
|
-
|
|
2605
|
-
* <p>When you request additional results from the <code>ListTagsForResource</code> operation, a
|
|
2606
|
-
* <code>NextToken</code> parameter is returned in the input. You can then pass in a subsequent
|
|
2607
|
-
* command to the <code>NextToken</code> parameter to continue listing additional tags.</p>
|
|
2608
|
-
*/
|
|
1095
|
+
|
|
2609
1096
|
NextToken?: string;
|
|
2610
1097
|
}
|
|
2611
1098
|
export declare namespace ListTagsForResourceRequest {
|
|
2612
|
-
|
|
2613
|
-
* @internal
|
|
2614
|
-
*/
|
|
1099
|
+
|
|
2615
1100
|
const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
|
|
2616
1101
|
}
|
|
2617
1102
|
export interface ListTagsForResourceResponse {
|
|
2618
|
-
|
|
2619
|
-
* <p>The ARN you specified to list the tags of.</p>
|
|
2620
|
-
*/
|
|
1103
|
+
|
|
2621
1104
|
Arn?: string;
|
|
2622
|
-
|
|
2623
|
-
* <p>When you can get additional results from the <code>ListTagsForResource</code> call, a
|
|
2624
|
-
* <code>NextToken</code> parameter is returned in the output. You can then pass in a
|
|
2625
|
-
* subsequent command to the <code>NextToken</code> parameter to continue listing additional
|
|
2626
|
-
* tags.</p>
|
|
2627
|
-
*/
|
|
1105
|
+
|
|
2628
1106
|
NextToken?: string;
|
|
2629
|
-
|
|
2630
|
-
* <p>Key-value pairs that are assigned to a resource, usually for the purpose of grouping and
|
|
2631
|
-
* searching for items. Tags are metadata that you define.</p>
|
|
2632
|
-
*/
|
|
1107
|
+
|
|
2633
1108
|
Tags?: Tag[];
|
|
2634
1109
|
}
|
|
2635
1110
|
export declare namespace ListTagsForResourceResponse {
|
|
2636
|
-
|
|
2637
|
-
* @internal
|
|
2638
|
-
*/
|
|
1111
|
+
|
|
2639
1112
|
const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
|
|
2640
1113
|
}
|
|
2641
1114
|
export interface ListUsersRequest {
|
|
2642
|
-
|
|
2643
|
-
* <p>Specifies the number of users to return as a response to the <code>ListUsers</code>
|
|
2644
|
-
* request.</p>
|
|
2645
|
-
*/
|
|
1115
|
+
|
|
2646
1116
|
MaxResults?: number;
|
|
2647
|
-
|
|
2648
|
-
* <p>When you can get additional results from the <code>ListUsers</code> call, a
|
|
2649
|
-
* <code>NextToken</code> parameter is returned in the output. You can then pass in a
|
|
2650
|
-
* subsequent command to the <code>NextToken</code> parameter to continue listing additional
|
|
2651
|
-
* users.</p>
|
|
2652
|
-
*/
|
|
1117
|
+
|
|
2653
1118
|
NextToken?: string;
|
|
2654
|
-
|
|
2655
|
-
* <p>A system-assigned unique identifier for a server that has users assigned to it.</p>
|
|
2656
|
-
*/
|
|
1119
|
+
|
|
2657
1120
|
ServerId: string | undefined;
|
|
2658
1121
|
}
|
|
2659
1122
|
export declare namespace ListUsersRequest {
|
|
2660
|
-
|
|
2661
|
-
* @internal
|
|
2662
|
-
*/
|
|
1123
|
+
|
|
2663
1124
|
const filterSensitiveLog: (obj: ListUsersRequest) => any;
|
|
2664
1125
|
}
|
|
2665
1126
|
export interface ListUsersResponse {
|
|
2666
|
-
|
|
2667
|
-
* <p>When you can get additional results from the <code>ListUsers</code> call, a
|
|
2668
|
-
* <code>NextToken</code> parameter is returned in the output. You can then pass in a
|
|
2669
|
-
* subsequent command to the <code>NextToken</code> parameter to continue listing additional
|
|
2670
|
-
* users.</p>
|
|
2671
|
-
*/
|
|
1127
|
+
|
|
2672
1128
|
NextToken?: string;
|
|
2673
|
-
|
|
2674
|
-
* <p>A system-assigned unique identifier for a server that the users are assigned to.</p>
|
|
2675
|
-
*/
|
|
1129
|
+
|
|
2676
1130
|
ServerId: string | undefined;
|
|
2677
|
-
|
|
2678
|
-
* <p>Returns the user accounts and their properties for the <code>ServerId</code> value that
|
|
2679
|
-
* you specify.</p>
|
|
2680
|
-
*/
|
|
1131
|
+
|
|
2681
1132
|
Users: ListedUser[] | undefined;
|
|
2682
1133
|
}
|
|
2683
1134
|
export declare namespace ListUsersResponse {
|
|
2684
|
-
|
|
2685
|
-
* @internal
|
|
2686
|
-
*/
|
|
1135
|
+
|
|
2687
1136
|
const filterSensitiveLog: (obj: ListUsersResponse) => any;
|
|
2688
1137
|
}
|
|
2689
1138
|
export interface ListWorkflowsRequest {
|
|
2690
|
-
|
|
2691
|
-
* <p>Specifies the maximum number of workflows to return.</p>
|
|
2692
|
-
*/
|
|
1139
|
+
|
|
2693
1140
|
MaxResults?: number;
|
|
2694
|
-
|
|
2695
|
-
* <p>
|
|
2696
|
-
* <code>ListWorkflows</code> returns the <code>NextToken</code> parameter in the output.
|
|
2697
|
-
* You can then pass the <code>NextToken</code> parameter in a subsequent command to
|
|
2698
|
-
* continue listing additional workflows.</p>
|
|
2699
|
-
*/
|
|
1141
|
+
|
|
2700
1142
|
NextToken?: string;
|
|
2701
1143
|
}
|
|
2702
1144
|
export declare namespace ListWorkflowsRequest {
|
|
2703
|
-
|
|
2704
|
-
* @internal
|
|
2705
|
-
*/
|
|
1145
|
+
|
|
2706
1146
|
const filterSensitiveLog: (obj: ListWorkflowsRequest) => any;
|
|
2707
1147
|
}
|
|
2708
1148
|
export interface ListWorkflowsResponse {
|
|
2709
|
-
|
|
2710
|
-
* <p>
|
|
2711
|
-
* <code>ListWorkflows</code> returns the <code>NextToken</code> parameter in the output.
|
|
2712
|
-
* You can then pass the <code>NextToken</code> parameter in a subsequent command to
|
|
2713
|
-
* continue listing additional workflows.</p>
|
|
2714
|
-
*/
|
|
1149
|
+
|
|
2715
1150
|
NextToken?: string;
|
|
2716
|
-
|
|
2717
|
-
* <p>Returns the <code>Arn</code>, <code>WorkflowId</code>, and <code>Description</code> for each workflow.</p>
|
|
2718
|
-
*/
|
|
1151
|
+
|
|
2719
1152
|
Workflows: ListedWorkflow[] | undefined;
|
|
2720
1153
|
}
|
|
2721
1154
|
export declare namespace ListWorkflowsResponse {
|
|
2722
|
-
|
|
2723
|
-
* @internal
|
|
2724
|
-
*/
|
|
1155
|
+
|
|
2725
1156
|
const filterSensitiveLog: (obj: ListWorkflowsResponse) => any;
|
|
2726
1157
|
}
|
|
2727
1158
|
export interface SendWorkflowStepStateRequest {
|
|
2728
|
-
|
|
2729
|
-
* <p>A unique identifier for the workflow.</p>
|
|
2730
|
-
*/
|
|
1159
|
+
|
|
2731
1160
|
WorkflowId: string | undefined;
|
|
2732
|
-
|
|
2733
|
-
* <p>A unique identifier for the execution of a workflow.</p>
|
|
2734
|
-
*/
|
|
1161
|
+
|
|
2735
1162
|
ExecutionId: string | undefined;
|
|
2736
|
-
|
|
2737
|
-
* <p>Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.</p>
|
|
2738
|
-
*/
|
|
1163
|
+
|
|
2739
1164
|
Token: string | undefined;
|
|
2740
|
-
|
|
2741
|
-
* <p>Indicates whether the specified step succeeded or failed.</p>
|
|
2742
|
-
*/
|
|
1165
|
+
|
|
2743
1166
|
Status: CustomStepStatus | string | undefined;
|
|
2744
1167
|
}
|
|
2745
1168
|
export declare namespace SendWorkflowStepStateRequest {
|
|
2746
|
-
|
|
2747
|
-
* @internal
|
|
2748
|
-
*/
|
|
1169
|
+
|
|
2749
1170
|
const filterSensitiveLog: (obj: SendWorkflowStepStateRequest) => any;
|
|
2750
1171
|
}
|
|
2751
1172
|
export interface SendWorkflowStepStateResponse {
|
|
2752
1173
|
}
|
|
2753
1174
|
export declare namespace SendWorkflowStepStateResponse {
|
|
2754
|
-
|
|
2755
|
-
* @internal
|
|
2756
|
-
*/
|
|
1175
|
+
|
|
2757
1176
|
const filterSensitiveLog: (obj: SendWorkflowStepStateResponse) => any;
|
|
2758
1177
|
}
|
|
2759
1178
|
export interface StartServerRequest {
|
|
2760
|
-
|
|
2761
|
-
* <p>A system-assigned unique identifier for a server that you start.</p>
|
|
2762
|
-
*/
|
|
1179
|
+
|
|
2763
1180
|
ServerId: string | undefined;
|
|
2764
1181
|
}
|
|
2765
1182
|
export declare namespace StartServerRequest {
|
|
2766
|
-
|
|
2767
|
-
* @internal
|
|
2768
|
-
*/
|
|
1183
|
+
|
|
2769
1184
|
const filterSensitiveLog: (obj: StartServerRequest) => any;
|
|
2770
1185
|
}
|
|
2771
1186
|
export interface StopServerRequest {
|
|
2772
|
-
|
|
2773
|
-
* <p>A system-assigned unique identifier for a server that you stopped.</p>
|
|
2774
|
-
*/
|
|
1187
|
+
|
|
2775
1188
|
ServerId: string | undefined;
|
|
2776
1189
|
}
|
|
2777
1190
|
export declare namespace StopServerRequest {
|
|
2778
|
-
|
|
2779
|
-
* @internal
|
|
2780
|
-
*/
|
|
1191
|
+
|
|
2781
1192
|
const filterSensitiveLog: (obj: StopServerRequest) => any;
|
|
2782
1193
|
}
|
|
2783
1194
|
export interface TagResourceRequest {
|
|
2784
|
-
|
|
2785
|
-
* <p>An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or
|
|
2786
|
-
* role.</p>
|
|
2787
|
-
*/
|
|
1195
|
+
|
|
2788
1196
|
Arn: string | undefined;
|
|
2789
|
-
|
|
2790
|
-
* <p>Key-value pairs assigned to ARNs that you can use to group and search for resources by
|
|
2791
|
-
* type. You can attach this metadata to user accounts for any purpose.</p>
|
|
2792
|
-
*/
|
|
1197
|
+
|
|
2793
1198
|
Tags: Tag[] | undefined;
|
|
2794
1199
|
}
|
|
2795
1200
|
export declare namespace TagResourceRequest {
|
|
2796
|
-
|
|
2797
|
-
* @internal
|
|
2798
|
-
*/
|
|
1201
|
+
|
|
2799
1202
|
const filterSensitiveLog: (obj: TagResourceRequest) => any;
|
|
2800
1203
|
}
|
|
2801
1204
|
export interface TestIdentityProviderRequest {
|
|
2802
|
-
|
|
2803
|
-
* <p>A system-assigned identifier for a specific server. That server's user authentication
|
|
2804
|
-
* method is tested with a user name and password.</p>
|
|
2805
|
-
*/
|
|
1205
|
+
|
|
2806
1206
|
ServerId: string | undefined;
|
|
2807
|
-
|
|
2808
|
-
* <p>The type of file transfer protocol to be tested.</p>
|
|
2809
|
-
*
|
|
2810
|
-
* <p>The available protocols are:</p>
|
|
2811
|
-
*
|
|
2812
|
-
* <ul>
|
|
2813
|
-
* <li>
|
|
2814
|
-
* <p>Secure Shell (SSH) File Transfer Protocol (SFTP)</p>
|
|
2815
|
-
* </li>
|
|
2816
|
-
* <li>
|
|
2817
|
-
* <p>File Transfer Protocol Secure (FTPS)</p>
|
|
2818
|
-
* </li>
|
|
2819
|
-
* <li>
|
|
2820
|
-
* <p>File Transfer Protocol (FTP)</p>
|
|
2821
|
-
* </li>
|
|
2822
|
-
* </ul>
|
|
2823
|
-
*/
|
|
1207
|
+
|
|
2824
1208
|
ServerProtocol?: Protocol | string;
|
|
2825
|
-
|
|
2826
|
-
* <p>The source IP address of the user account to be tested.</p>
|
|
2827
|
-
*/
|
|
1209
|
+
|
|
2828
1210
|
SourceIp?: string;
|
|
2829
|
-
|
|
2830
|
-
* <p>The name of the user account to be tested.</p>
|
|
2831
|
-
*/
|
|
1211
|
+
|
|
2832
1212
|
UserName: string | undefined;
|
|
2833
|
-
|
|
2834
|
-
* <p>The password of the user account to be tested.</p>
|
|
2835
|
-
*/
|
|
1213
|
+
|
|
2836
1214
|
UserPassword?: string;
|
|
2837
1215
|
}
|
|
2838
1216
|
export declare namespace TestIdentityProviderRequest {
|
|
2839
|
-
|
|
2840
|
-
* @internal
|
|
2841
|
-
*/
|
|
1217
|
+
|
|
2842
1218
|
const filterSensitiveLog: (obj: TestIdentityProviderRequest) => any;
|
|
2843
1219
|
}
|
|
2844
1220
|
export interface TestIdentityProviderResponse {
|
|
2845
|
-
|
|
2846
|
-
* <p>The response that is returned from your API Gateway.</p>
|
|
2847
|
-
*/
|
|
1221
|
+
|
|
2848
1222
|
Response?: string;
|
|
2849
|
-
|
|
2850
|
-
* <p>The HTTP status code that is the response from your API Gateway.</p>
|
|
2851
|
-
*/
|
|
1223
|
+
|
|
2852
1224
|
StatusCode: number | undefined;
|
|
2853
|
-
|
|
2854
|
-
* <p>A message that indicates whether the test was successful or not.</p>
|
|
2855
|
-
*/
|
|
1225
|
+
|
|
2856
1226
|
Message?: string;
|
|
2857
|
-
|
|
2858
|
-
* <p>The endpoint of the service used to authenticate a user.</p>
|
|
2859
|
-
*/
|
|
1227
|
+
|
|
2860
1228
|
Url: string | undefined;
|
|
2861
1229
|
}
|
|
2862
1230
|
export declare namespace TestIdentityProviderResponse {
|
|
2863
|
-
|
|
2864
|
-
* @internal
|
|
2865
|
-
*/
|
|
1231
|
+
|
|
2866
1232
|
const filterSensitiveLog: (obj: TestIdentityProviderResponse) => any;
|
|
2867
1233
|
}
|
|
2868
1234
|
export interface UntagResourceRequest {
|
|
2869
|
-
|
|
2870
|
-
* <p>The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is
|
|
2871
|
-
* an identifier for a specific Amazon Web Services resource, such as a server, user, or role.</p>
|
|
2872
|
-
*/
|
|
1235
|
+
|
|
2873
1236
|
Arn: string | undefined;
|
|
2874
|
-
|
|
2875
|
-
* <p>TagKeys are key-value pairs assigned to ARNs that can be used to group and search for
|
|
2876
|
-
* resources by type. This metadata can be attached to resources for any purpose.</p>
|
|
2877
|
-
*/
|
|
1237
|
+
|
|
2878
1238
|
TagKeys: string[] | undefined;
|
|
2879
1239
|
}
|
|
2880
1240
|
export declare namespace UntagResourceRequest {
|
|
2881
|
-
|
|
2882
|
-
* @internal
|
|
2883
|
-
*/
|
|
1241
|
+
|
|
2884
1242
|
const filterSensitiveLog: (obj: UntagResourceRequest) => any;
|
|
2885
1243
|
}
|
|
2886
1244
|
export interface UpdateAccessRequest {
|
|
2887
|
-
|
|
2888
|
-
* <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
|
|
2889
|
-
* <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
|
|
2890
|
-
*/
|
|
1245
|
+
|
|
2891
1246
|
HomeDirectory?: string;
|
|
2892
|
-
|
|
2893
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
|
|
2894
|
-
* If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
|
|
2895
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
|
|
2896
|
-
* S3 or EFS paths visible to your users.</p>
|
|
2897
|
-
*/
|
|
1247
|
+
|
|
2898
1248
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
2899
|
-
|
|
2900
|
-
* <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
|
|
2901
|
-
* be visible to your user and how you want to make them visible. You must specify the
|
|
2902
|
-
* <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
|
|
2903
|
-
* is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
|
|
2904
|
-
* only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity
|
|
2905
|
-
* and Access Management (IAM) role provides access to paths in <code>Target</code>. This value
|
|
2906
|
-
* can only be set when <code>HomeDirectoryType</code> is set to
|
|
2907
|
-
* <i>LOGICAL</i>.</p>
|
|
2908
|
-
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>
|
|
2909
|
-
* <p>
|
|
2910
|
-
* <code>[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]</code>
|
|
2911
|
-
* </p>
|
|
2912
|
-
* <p>In most cases, you can use this value instead of the session policy to lock down your
|
|
2913
|
-
* user to the designated home directory ("<code>chroot</code>"). To do this, you can set
|
|
2914
|
-
* <code>Entry</code> to <code>/</code> and set <code>Target</code> to the
|
|
2915
|
-
* <code>HomeDirectory</code> parameter value.</p>
|
|
2916
|
-
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>
|
|
2917
|
-
* <p>
|
|
2918
|
-
* <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
|
|
2919
|
-
* </p>
|
|
2920
|
-
*
|
|
2921
|
-
* <note>
|
|
2922
|
-
* <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
|
|
2923
|
-
* ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
|
|
2924
|
-
* holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
|
|
2925
|
-
* <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
|
|
2926
|
-
* following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
|
|
2927
|
-
* sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
|
|
2928
|
-
* </note>
|
|
2929
|
-
*/
|
|
1249
|
+
|
|
2930
1250
|
HomeDirectoryMappings?: HomeDirectoryMapEntry[];
|
|
2931
|
-
|
|
2932
|
-
* <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
|
|
2933
|
-
* access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
|
|
2934
|
-
* <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
|
|
2935
|
-
*
|
|
2936
|
-
*
|
|
2937
|
-
* <note>
|
|
2938
|
-
* <p>This only applies when the domain of <code>ServerId</code> is S3. EFS does not use session policies.</p>
|
|
2939
|
-
* <p>For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead
|
|
2940
|
-
* of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass
|
|
2941
|
-
* it in the <code>Policy</code> argument.</p>
|
|
2942
|
-
* <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html">Example
|
|
2943
|
-
* session policy</a>.</p>
|
|
2944
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Amazon Web ServicesSecurity Token Service API
|
|
2945
|
-
* Reference</i>.</p>
|
|
2946
|
-
* </note>
|
|
2947
|
-
*/
|
|
1251
|
+
|
|
2948
1252
|
Policy?: string;
|
|
2949
|
-
|
|
2950
|
-
* <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
|
|
2951
|
-
* (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
|
|
2952
|
-
* your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
|
|
2953
|
-
* files and directories in your file system determine the level of access your users get when
|
|
2954
|
-
* transferring files into and out of your Amazon EFS file systems.</p>
|
|
2955
|
-
*/
|
|
1253
|
+
|
|
2956
1254
|
PosixProfile?: PosixProfile;
|
|
2957
|
-
|
|
2958
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
|
|
2959
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
|
|
2960
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
|
|
2961
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
2962
|
-
*/
|
|
1255
|
+
|
|
2963
1256
|
Role?: string;
|
|
2964
|
-
|
|
2965
|
-
* <p>A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.</p>
|
|
2966
|
-
*/
|
|
1257
|
+
|
|
2967
1258
|
ServerId: string | undefined;
|
|
2968
|
-
|
|
2969
|
-
* <p>A unique identifier that is required to identify specific groups within your directory.
|
|
2970
|
-
* The users of the group that you associate have access to your Amazon S3 or Amazon EFS
|
|
2971
|
-
* resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,
|
|
2972
|
-
* you can view the SID values by running the following command using Windows PowerShell.</p>
|
|
2973
|
-
*
|
|
2974
|
-
* <p>
|
|
2975
|
-
* <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code>
|
|
2976
|
-
* </p>
|
|
2977
|
-
*
|
|
2978
|
-
* <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
|
|
2979
|
-
*
|
|
2980
|
-
* <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
|
|
2981
|
-
* You can also include underscores or any of the following characters: =,.@:/-</p>
|
|
2982
|
-
*/
|
|
1259
|
+
|
|
2983
1260
|
ExternalId: string | undefined;
|
|
2984
1261
|
}
|
|
2985
1262
|
export declare namespace UpdateAccessRequest {
|
|
2986
|
-
|
|
2987
|
-
* @internal
|
|
2988
|
-
*/
|
|
1263
|
+
|
|
2989
1264
|
const filterSensitiveLog: (obj: UpdateAccessRequest) => any;
|
|
2990
1265
|
}
|
|
2991
1266
|
export interface UpdateAccessResponse {
|
|
2992
|
-
|
|
2993
|
-
* <p>The ID of the server that the user is attached to.</p>
|
|
2994
|
-
*/
|
|
1267
|
+
|
|
2995
1268
|
ServerId: string | undefined;
|
|
2996
|
-
|
|
2997
|
-
* <p>The external ID of the group whose users have access to your Amazon S3 or Amazon EFS
|
|
2998
|
-
* resources over the enabled protocols using Amazon Web ServicesTransfer Family.</p>
|
|
2999
|
-
*/
|
|
1269
|
+
|
|
3000
1270
|
ExternalId: string | undefined;
|
|
3001
1271
|
}
|
|
3002
1272
|
export declare namespace UpdateAccessResponse {
|
|
3003
|
-
|
|
3004
|
-
* @internal
|
|
3005
|
-
*/
|
|
1273
|
+
|
|
3006
1274
|
const filterSensitiveLog: (obj: UpdateAccessResponse) => any;
|
|
3007
1275
|
}
|
|
3008
1276
|
export interface UpdateServerRequest {
|
|
3009
|
-
|
|
3010
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required
|
|
3011
|
-
* when <code>Protocols</code> is set to <code>FTPS</code>.</p>
|
|
3012
|
-
*
|
|
3013
|
-
* <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a>
|
|
3014
|
-
* in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
|
|
3015
|
-
*
|
|
3016
|
-
* <p>To import an existing certificate into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into ACM</a>
|
|
3017
|
-
* in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
|
|
3018
|
-
*
|
|
3019
|
-
* <p>To request a private certificate to use FTPS through private IP addresses, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request a
|
|
3020
|
-
* private certificate</a> in the <i> Amazon Web ServicesCertificate Manager User
|
|
3021
|
-
* Guide</i>.</p>
|
|
3022
|
-
*
|
|
3023
|
-
* <p>Certificates with the following cryptographic algorithms and key sizes are
|
|
3024
|
-
* supported:</p>
|
|
3025
|
-
*
|
|
3026
|
-
* <ul>
|
|
3027
|
-
* <li>
|
|
3028
|
-
* <p>2048-bit RSA (RSA_2048)</p>
|
|
3029
|
-
* </li>
|
|
3030
|
-
* <li>
|
|
3031
|
-
* <p>4096-bit RSA (RSA_4096)</p>
|
|
3032
|
-
* </li>
|
|
3033
|
-
* <li>
|
|
3034
|
-
* <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p>
|
|
3035
|
-
* </li>
|
|
3036
|
-
* <li>
|
|
3037
|
-
* <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p>
|
|
3038
|
-
* </li>
|
|
3039
|
-
* <li>
|
|
3040
|
-
* <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p>
|
|
3041
|
-
* </li>
|
|
3042
|
-
* </ul>
|
|
3043
|
-
*
|
|
3044
|
-
* <note>
|
|
3045
|
-
* <p>The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP
|
|
3046
|
-
* address specified and information about the issuer.</p>
|
|
3047
|
-
* </note>
|
|
3048
|
-
*/
|
|
1277
|
+
|
|
3049
1278
|
Certificate?: string;
|
|
3050
|
-
|
|
3051
|
-
* <p>
|
|
3052
|
-
* The protocol settings that are configured for your server.
|
|
3053
|
-
* </p>
|
|
3054
|
-
* <p>
|
|
3055
|
-
* Use the <code>PassiveIp</code> parameter to indicate passive mode (for FTP and FTPS protocols).
|
|
3056
|
-
* Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
|
|
3057
|
-
* </p>
|
|
3058
|
-
*/
|
|
1279
|
+
|
|
3059
1280
|
ProtocolDetails?: ProtocolDetails;
|
|
3060
|
-
|
|
3061
|
-
* <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
|
3062
|
-
* When you host your endpoint within your VPC, you can make it accessible only to resources
|
|
3063
|
-
* within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over
|
|
3064
|
-
* the internet. Your VPC's default security groups are automatically assigned to your
|
|
3065
|
-
* endpoint.</p>
|
|
3066
|
-
*/
|
|
1281
|
+
|
|
3067
1282
|
EndpointDetails?: EndpointDetails;
|
|
3068
|
-
|
|
3069
|
-
* <p>The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)
|
|
3070
|
-
* or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and
|
|
3071
|
-
* resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.</p>
|
|
3072
|
-
* <note>
|
|
3073
|
-
* <p> After May 19, 2021, you won't be able to create a server using
|
|
3074
|
-
* <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Servicesaccount if your account hasn't already
|
|
3075
|
-
* done so before May 19, 2021. If you have already created servers with
|
|
3076
|
-
* <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Servicesaccount on or before May 19, 2021,
|
|
3077
|
-
* you will not be affected. After this date, use
|
|
3078
|
-
* <code>EndpointType</code>=<code>VPC</code>.</p>
|
|
3079
|
-
*
|
|
3080
|
-
* <p>For more information, see
|
|
3081
|
-
* https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
|
|
3082
|
-
* <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. With
|
|
3083
|
-
* this endpoint type, you have the option to directly associate up to three Elastic IPv4
|
|
3084
|
-
* addresses (BYO IP included) with your server's endpoint and use VPC security groups to
|
|
3085
|
-
* restrict traffic by the client's public IP address. This is not possible with
|
|
3086
|
-
* <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p>
|
|
3087
|
-
* </note>
|
|
3088
|
-
*/
|
|
1283
|
+
|
|
3089
1284
|
EndpointType?: EndpointType | string;
|
|
3090
|
-
|
|
3091
|
-
* <p>The RSA private key as generated by <code>ssh-keygen -N "" -m PEM -f
|
|
3092
|
-
* my-new-server-key</code>.</p>
|
|
3093
|
-
*
|
|
3094
|
-
* <important>
|
|
3095
|
-
* <p>If you aren't planning to migrate existing users from an existing server to a new
|
|
3096
|
-
* server, don't update the host key. Accidentally changing a server's host key can
|
|
3097
|
-
* be disruptive.</p>
|
|
3098
|
-
* </important>
|
|
3099
|
-
*
|
|
3100
|
-
*
|
|
3101
|
-
*
|
|
3102
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change the host key for your SFTP-enabled server</a> in the <i>Amazon Web ServicesTransfer
|
|
3103
|
-
* Family User Guide</i>.</p>
|
|
3104
|
-
*/
|
|
1285
|
+
|
|
3105
1286
|
HostKey?: string;
|
|
3106
|
-
|
|
3107
|
-
* <p>An array containing all of the information required to call a customer's
|
|
3108
|
-
* authentication API method.</p>
|
|
3109
|
-
*/
|
|
1287
|
+
|
|
3110
1288
|
IdentityProviderDetails?: IdentityProviderDetails;
|
|
3111
|
-
|
|
3112
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn
|
|
3113
|
-
* on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in
|
|
3114
|
-
* your CloudWatch logs.</p>
|
|
3115
|
-
*/
|
|
1289
|
+
|
|
3116
1290
|
LoggingRole?: string;
|
|
3117
|
-
|
|
3118
|
-
* <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
|
|
3119
|
-
* client can connect to your server's endpoint. The available protocols are:</p>
|
|
3120
|
-
*
|
|
3121
|
-
* <ul>
|
|
3122
|
-
* <li>
|
|
3123
|
-
* <p>Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH</p>
|
|
3124
|
-
* </li>
|
|
3125
|
-
* <li>
|
|
3126
|
-
* <p>File Transfer Protocol Secure (FTPS): File transfer with TLS encryption</p>
|
|
3127
|
-
* </li>
|
|
3128
|
-
* <li>
|
|
3129
|
-
* <p>File Transfer Protocol (FTP): Unencrypted file transfer</p>
|
|
3130
|
-
* </li>
|
|
3131
|
-
* </ul>
|
|
3132
|
-
*
|
|
3133
|
-
* <note>
|
|
3134
|
-
* <p>If you select <code>FTPS</code>, you must choose a certificate stored in Amazon Web ServicesCertificate
|
|
3135
|
-
* Manager (ACM) which will be used to identify your server when clients connect to it over
|
|
3136
|
-
* FTPS.</p>
|
|
3137
|
-
*
|
|
3138
|
-
*
|
|
3139
|
-
* <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the
|
|
3140
|
-
* <code>EndpointType</code> must be <code>VPC</code> and the
|
|
3141
|
-
* <code>IdentityProviderType</code> must be <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>.</p>
|
|
3142
|
-
*
|
|
3143
|
-
* <p>If <code>Protocol</code> includes <code>FTP</code>, then
|
|
3144
|
-
* <code>AddressAllocationIds</code> cannot be associated.</p>
|
|
3145
|
-
*
|
|
3146
|
-
* <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code>
|
|
3147
|
-
* can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to
|
|
3148
|
-
* <code>SERVICE_MANAGED</code>.</p>
|
|
3149
|
-
* </note>
|
|
3150
|
-
*/
|
|
1291
|
+
|
|
3151
1292
|
Protocols?: (Protocol | string)[];
|
|
3152
|
-
|
|
3153
|
-
* <p>Specifies the name of the security policy that is attached to the server.</p>
|
|
3154
|
-
*/
|
|
1293
|
+
|
|
3155
1294
|
SecurityPolicyName?: string;
|
|
3156
|
-
|
|
3157
|
-
* <p>A system-assigned unique identifier for a server instance that the user account is
|
|
3158
|
-
* assigned to.</p>
|
|
3159
|
-
*/
|
|
1295
|
+
|
|
3160
1296
|
ServerId: string | undefined;
|
|
3161
|
-
|
|
3162
|
-
* <p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>
|
|
3163
|
-
*/
|
|
1297
|
+
|
|
3164
1298
|
WorkflowDetails?: WorkflowDetails;
|
|
3165
1299
|
}
|
|
3166
1300
|
export declare namespace UpdateServerRequest {
|
|
3167
|
-
|
|
3168
|
-
* @internal
|
|
3169
|
-
*/
|
|
1301
|
+
|
|
3170
1302
|
const filterSensitiveLog: (obj: UpdateServerRequest) => any;
|
|
3171
1303
|
}
|
|
3172
1304
|
export interface UpdateServerResponse {
|
|
3173
|
-
|
|
3174
|
-
* <p>A system-assigned unique identifier for a server that the user account is assigned
|
|
3175
|
-
* to.</p>
|
|
3176
|
-
*/
|
|
1305
|
+
|
|
3177
1306
|
ServerId: string | undefined;
|
|
3178
1307
|
}
|
|
3179
1308
|
export declare namespace UpdateServerResponse {
|
|
3180
|
-
|
|
3181
|
-
* @internal
|
|
3182
|
-
*/
|
|
1309
|
+
|
|
3183
1310
|
const filterSensitiveLog: (obj: UpdateServerResponse) => any;
|
|
3184
1311
|
}
|
|
3185
1312
|
export interface UpdateUserRequest {
|
|
3186
|
-
|
|
3187
|
-
* <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
|
|
3188
|
-
* <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
|
|
3189
|
-
*/
|
|
1313
|
+
|
|
3190
1314
|
HomeDirectory?: string;
|
|
3191
|
-
|
|
3192
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
|
|
3193
|
-
* If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
|
|
3194
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
|
|
3195
|
-
* S3 or EFS paths visible to your users.</p>
|
|
3196
|
-
*/
|
|
1315
|
+
|
|
3197
1316
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
3198
|
-
|
|
3199
|
-
* <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
|
|
3200
|
-
* be visible to your user and how you want to make them visible. You must specify the
|
|
3201
|
-
* <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
|
|
3202
|
-
* is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
|
|
3203
|
-
* only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity
|
|
3204
|
-
* and Access Management (IAM) role provides access to paths in <code>Target</code>. This value
|
|
3205
|
-
* can only be set when <code>HomeDirectoryType</code> is set to
|
|
3206
|
-
* <i>LOGICAL</i>.</p>
|
|
3207
|
-
*
|
|
3208
|
-
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>
|
|
3209
|
-
* <p>
|
|
3210
|
-
* <code>[ { "Entry": "/directory1", "Target":
|
|
3211
|
-
* "/bucket_name/home/mydirectory" } ]</code>
|
|
3212
|
-
* </p>
|
|
3213
|
-
*
|
|
3214
|
-
* <p>In most cases, you can use this value instead of the session policy to lock down your
|
|
3215
|
-
* user to the designated home directory ("<code>chroot</code>"). To do this, you can set
|
|
3216
|
-
* <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory
|
|
3217
|
-
* parameter value.</p>
|
|
3218
|
-
*
|
|
3219
|
-
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>
|
|
3220
|
-
* <p>
|
|
3221
|
-
* <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
|
|
3222
|
-
* </p>
|
|
3223
|
-
*
|
|
3224
|
-
* <note>
|
|
3225
|
-
* <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
|
|
3226
|
-
* ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
|
|
3227
|
-
* holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
|
|
3228
|
-
* <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
|
|
3229
|
-
* following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
|
|
3230
|
-
* sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
|
|
3231
|
-
* </note>
|
|
3232
|
-
*/
|
|
1317
|
+
|
|
3233
1318
|
HomeDirectoryMappings?: HomeDirectoryMapEntry[];
|
|
3234
|
-
|
|
3235
|
-
* <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
|
|
3236
|
-
* access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
|
|
3237
|
-
* <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
|
|
3238
|
-
*
|
|
3239
|
-
* <note>
|
|
3240
|
-
* <p>This only applies when the domain of <code>ServerId</code> is S3. EFS does not use session policies.</p>
|
|
3241
|
-
* <p>For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead
|
|
3242
|
-
* of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass
|
|
3243
|
-
* it in the <code>Policy</code> argument.</p>
|
|
3244
|
-
*
|
|
3245
|
-
*
|
|
3246
|
-
*
|
|
3247
|
-
* <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy">Creating a session
|
|
3248
|
-
* policy</a>.</p>
|
|
3249
|
-
*
|
|
3250
|
-
*
|
|
3251
|
-
*
|
|
3252
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Amazon Web Services
|
|
3253
|
-
* Security Token Service API Reference</i>.</p>
|
|
3254
|
-
* </note>
|
|
3255
|
-
*/
|
|
1319
|
+
|
|
3256
1320
|
Policy?: string;
|
|
3257
|
-
|
|
3258
|
-
* <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID
|
|
3259
|
-
* (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
|
|
3260
|
-
* your users' access to your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions
|
|
3261
|
-
* that are set on files and directories in your file system determines the level of access your
|
|
3262
|
-
* users get when transferring files into and out of your Amazon EFS file systems.</p>
|
|
3263
|
-
*/
|
|
1321
|
+
|
|
3264
1322
|
PosixProfile?: PosixProfile;
|
|
3265
|
-
|
|
3266
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
|
|
3267
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
|
|
3268
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
|
|
3269
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
3270
|
-
*/
|
|
1323
|
+
|
|
3271
1324
|
Role?: string;
|
|
3272
|
-
|
|
3273
|
-
* <p>A system-assigned unique identifier for a server instance that the user account is
|
|
3274
|
-
* assigned to.</p>
|
|
3275
|
-
*/
|
|
1325
|
+
|
|
3276
1326
|
ServerId: string | undefined;
|
|
3277
|
-
|
|
3278
|
-
* <p>A unique string that identifies a user and is associated with a server as specified by the
|
|
3279
|
-
* <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 100 characters
|
|
3280
|
-
* long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen
|
|
3281
|
-
* '-', period '.', and at sign '@'. The user name can't start
|
|
3282
|
-
* with a hyphen, period, or at sign.</p>
|
|
3283
|
-
*/
|
|
1327
|
+
|
|
3284
1328
|
UserName: string | undefined;
|
|
3285
1329
|
}
|
|
3286
1330
|
export declare namespace UpdateUserRequest {
|
|
3287
|
-
|
|
3288
|
-
* @internal
|
|
3289
|
-
*/
|
|
1331
|
+
|
|
3290
1332
|
const filterSensitiveLog: (obj: UpdateUserRequest) => any;
|
|
3291
1333
|
}
|
|
3292
|
-
|
|
3293
|
-
* <p>
|
|
3294
|
-
* <code>UpdateUserResponse</code> returns the user name and identifier for the request to
|
|
3295
|
-
* update a user's properties.</p>
|
|
3296
|
-
*/
|
|
1334
|
+
|
|
3297
1335
|
export interface UpdateUserResponse {
|
|
3298
|
-
|
|
3299
|
-
* <p>A system-assigned unique identifier for a server instance that the user account is
|
|
3300
|
-
* assigned to.</p>
|
|
3301
|
-
*/
|
|
1336
|
+
|
|
3302
1337
|
ServerId: string | undefined;
|
|
3303
|
-
|
|
3304
|
-
* <p>The unique identifier for a user that is assigned to a server instance that was specified
|
|
3305
|
-
* in the request.</p>
|
|
3306
|
-
*/
|
|
1338
|
+
|
|
3307
1339
|
UserName: string | undefined;
|
|
3308
1340
|
}
|
|
3309
1341
|
export declare namespace UpdateUserResponse {
|
|
3310
|
-
|
|
3311
|
-
* @internal
|
|
3312
|
-
*/
|
|
1342
|
+
|
|
3313
1343
|
const filterSensitiveLog: (obj: UpdateUserResponse) => any;
|
|
3314
1344
|
}
|