@aws-sdk/client-transfer 3.131.0 → 3.142.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 +34 -0
- package/README.md +10 -10
- package/dist-cjs/Transfer.js +315 -0
- package/dist-cjs/commands/CreateAccessCommand.js +2 -2
- package/dist-cjs/commands/CreateAgreementCommand.js +36 -0
- package/dist-cjs/commands/CreateConnectorCommand.js +36 -0
- package/dist-cjs/commands/CreateProfileCommand.js +36 -0
- package/dist-cjs/commands/CreateServerCommand.js +2 -2
- package/dist-cjs/commands/CreateUserCommand.js +2 -2
- package/dist-cjs/commands/CreateWorkflowCommand.js +2 -2
- package/dist-cjs/commands/DeleteAccessCommand.js +1 -1
- package/dist-cjs/commands/DeleteAgreementCommand.js +36 -0
- package/dist-cjs/commands/DeleteCertificateCommand.js +36 -0
- package/dist-cjs/commands/DeleteConnectorCommand.js +36 -0
- package/dist-cjs/commands/DeleteProfileCommand.js +36 -0
- package/dist-cjs/commands/DeleteServerCommand.js +1 -1
- package/dist-cjs/commands/DeleteSshPublicKeyCommand.js +1 -1
- package/dist-cjs/commands/DeleteUserCommand.js +1 -1
- package/dist-cjs/commands/DeleteWorkflowCommand.js +1 -1
- package/dist-cjs/commands/DescribeAccessCommand.js +2 -2
- package/dist-cjs/commands/DescribeAgreementCommand.js +36 -0
- package/dist-cjs/commands/DescribeCertificateCommand.js +36 -0
- package/dist-cjs/commands/DescribeConnectorCommand.js +36 -0
- package/dist-cjs/commands/DescribeExecutionCommand.js +2 -2
- package/dist-cjs/commands/DescribeProfileCommand.js +36 -0
- package/dist-cjs/commands/DescribeSecurityPolicyCommand.js +2 -2
- package/dist-cjs/commands/DescribeServerCommand.js +2 -2
- package/dist-cjs/commands/DescribeUserCommand.js +2 -2
- package/dist-cjs/commands/DescribeWorkflowCommand.js +2 -2
- package/dist-cjs/commands/ImportCertificateCommand.js +36 -0
- package/dist-cjs/commands/ImportSshPublicKeyCommand.js +2 -2
- package/dist-cjs/commands/ListAccessesCommand.js +2 -2
- package/dist-cjs/commands/ListAgreementsCommand.js +36 -0
- package/dist-cjs/commands/ListCertificatesCommand.js +36 -0
- package/dist-cjs/commands/ListConnectorsCommand.js +36 -0
- package/dist-cjs/commands/ListExecutionsCommand.js +2 -2
- package/dist-cjs/commands/ListProfilesCommand.js +36 -0
- package/dist-cjs/commands/ListSecurityPoliciesCommand.js +2 -2
- package/dist-cjs/commands/ListServersCommand.js +2 -2
- package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -2
- package/dist-cjs/commands/ListUsersCommand.js +2 -2
- package/dist-cjs/commands/ListWorkflowsCommand.js +2 -2
- package/dist-cjs/commands/SendWorkflowStepStateCommand.js +2 -2
- package/dist-cjs/commands/StartFileTransferCommand.js +36 -0
- package/dist-cjs/commands/StartServerCommand.js +1 -1
- package/dist-cjs/commands/StopServerCommand.js +1 -1
- package/dist-cjs/commands/TagResourceCommand.js +1 -1
- package/dist-cjs/commands/TestIdentityProviderCommand.js +2 -2
- package/dist-cjs/commands/UntagResourceCommand.js +1 -1
- package/dist-cjs/commands/UpdateAccessCommand.js +2 -2
- package/dist-cjs/commands/UpdateAgreementCommand.js +36 -0
- package/dist-cjs/commands/UpdateCertificateCommand.js +36 -0
- package/dist-cjs/commands/UpdateConnectorCommand.js +36 -0
- package/dist-cjs/commands/UpdateProfileCommand.js +36 -0
- package/dist-cjs/commands/UpdateServerCommand.js +2 -2
- package/dist-cjs/commands/UpdateUserCommand.js +2 -2
- package/dist-cjs/commands/index.js +21 -0
- package/dist-cjs/models/models_0.js +633 -558
- package/dist-cjs/pagination/ListAgreementsPaginator.js +36 -0
- package/dist-cjs/pagination/ListCertificatesPaginator.js +36 -0
- package/dist-cjs/pagination/ListConnectorsPaginator.js +36 -0
- package/dist-cjs/pagination/ListProfilesPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +4 -0
- package/dist-cjs/protocols/Aws_json1_1.js +1840 -383
- package/dist-es/Transfer.js +315 -0
- package/dist-es/commands/CreateAccessCommand.js +3 -3
- package/dist-es/commands/CreateAgreementCommand.js +39 -0
- package/dist-es/commands/CreateConnectorCommand.js +39 -0
- package/dist-es/commands/CreateProfileCommand.js +39 -0
- package/dist-es/commands/CreateServerCommand.js +3 -3
- package/dist-es/commands/CreateUserCommand.js +3 -3
- package/dist-es/commands/CreateWorkflowCommand.js +3 -3
- package/dist-es/commands/DeleteAccessCommand.js +2 -2
- package/dist-es/commands/DeleteAgreementCommand.js +39 -0
- package/dist-es/commands/DeleteCertificateCommand.js +39 -0
- package/dist-es/commands/DeleteConnectorCommand.js +39 -0
- package/dist-es/commands/DeleteProfileCommand.js +39 -0
- package/dist-es/commands/DeleteServerCommand.js +2 -2
- package/dist-es/commands/DeleteSshPublicKeyCommand.js +2 -2
- package/dist-es/commands/DeleteUserCommand.js +2 -2
- package/dist-es/commands/DeleteWorkflowCommand.js +2 -2
- package/dist-es/commands/DescribeAccessCommand.js +3 -3
- package/dist-es/commands/DescribeAgreementCommand.js +39 -0
- package/dist-es/commands/DescribeCertificateCommand.js +39 -0
- package/dist-es/commands/DescribeConnectorCommand.js +39 -0
- package/dist-es/commands/DescribeExecutionCommand.js +3 -3
- package/dist-es/commands/DescribeProfileCommand.js +39 -0
- package/dist-es/commands/DescribeSecurityPolicyCommand.js +3 -3
- package/dist-es/commands/DescribeServerCommand.js +3 -3
- package/dist-es/commands/DescribeUserCommand.js +3 -3
- package/dist-es/commands/DescribeWorkflowCommand.js +3 -3
- package/dist-es/commands/ImportCertificateCommand.js +39 -0
- package/dist-es/commands/ImportSshPublicKeyCommand.js +3 -3
- package/dist-es/commands/ListAccessesCommand.js +3 -3
- package/dist-es/commands/ListAgreementsCommand.js +39 -0
- package/dist-es/commands/ListCertificatesCommand.js +39 -0
- package/dist-es/commands/ListConnectorsCommand.js +39 -0
- package/dist-es/commands/ListExecutionsCommand.js +3 -3
- package/dist-es/commands/ListProfilesCommand.js +39 -0
- package/dist-es/commands/ListSecurityPoliciesCommand.js +3 -3
- package/dist-es/commands/ListServersCommand.js +3 -3
- package/dist-es/commands/ListTagsForResourceCommand.js +3 -3
- package/dist-es/commands/ListUsersCommand.js +3 -3
- package/dist-es/commands/ListWorkflowsCommand.js +3 -3
- package/dist-es/commands/SendWorkflowStepStateCommand.js +3 -3
- package/dist-es/commands/StartFileTransferCommand.js +39 -0
- package/dist-es/commands/StartServerCommand.js +2 -2
- package/dist-es/commands/StopServerCommand.js +2 -2
- package/dist-es/commands/TagResourceCommand.js +2 -2
- package/dist-es/commands/TestIdentityProviderCommand.js +3 -3
- package/dist-es/commands/UntagResourceCommand.js +2 -2
- package/dist-es/commands/UpdateAccessCommand.js +3 -3
- package/dist-es/commands/UpdateAgreementCommand.js +39 -0
- package/dist-es/commands/UpdateCertificateCommand.js +39 -0
- package/dist-es/commands/UpdateConnectorCommand.js +39 -0
- package/dist-es/commands/UpdateProfileCommand.js +39 -0
- package/dist-es/commands/UpdateServerCommand.js +3 -3
- package/dist-es/commands/UpdateUserCommand.js +3 -3
- package/dist-es/commands/index.js +21 -0
- package/dist-es/models/models_0.js +203 -368
- package/dist-es/pagination/ListAgreementsPaginator.js +75 -0
- package/dist-es/pagination/ListCertificatesPaginator.js +75 -0
- package/dist-es/pagination/ListConnectorsPaginator.js +75 -0
- package/dist-es/pagination/ListProfilesPaginator.js +75 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +2633 -716
- package/dist-types/Transfer.d.ts +190 -13
- package/dist-types/TransferClient.d.ts +32 -11
- package/dist-types/commands/CreateAccessCommand.d.ts +1 -1
- package/dist-types/commands/CreateAgreementCommand.d.ts +40 -0
- package/dist-types/commands/CreateConnectorCommand.d.ts +37 -0
- package/dist-types/commands/CreateProfileCommand.d.ts +36 -0
- package/dist-types/commands/CreateUserCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAgreementCommand.d.ts +35 -0
- package/dist-types/commands/DeleteCertificateCommand.d.ts +36 -0
- package/dist-types/commands/DeleteConnectorCommand.d.ts +35 -0
- package/dist-types/commands/DeleteProfileCommand.d.ts +35 -0
- package/dist-types/commands/DescribeAccessCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAgreementCommand.d.ts +35 -0
- package/dist-types/commands/DescribeCertificateCommand.d.ts +35 -0
- package/dist-types/commands/DescribeConnectorCommand.d.ts +36 -0
- package/dist-types/commands/DescribeProfileCommand.d.ts +35 -0
- package/dist-types/commands/ImportCertificateCommand.d.ts +37 -0
- package/dist-types/commands/ListAgreementsCommand.d.ts +39 -0
- package/dist-types/commands/ListCertificatesCommand.d.ts +39 -0
- package/dist-types/commands/ListConnectorsCommand.d.ts +35 -0
- package/dist-types/commands/ListProfilesCommand.d.ts +38 -0
- package/dist-types/commands/StartFileTransferCommand.d.ts +36 -0
- package/dist-types/commands/StopServerCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgreementCommand.d.ts +37 -0
- package/dist-types/commands/UpdateCertificateCommand.d.ts +35 -0
- package/dist-types/commands/UpdateConnectorCommand.d.ts +37 -0
- package/dist-types/commands/UpdateProfileCommand.d.ts +37 -0
- package/dist-types/commands/index.d.ts +21 -0
- package/dist-types/models/models_0.d.ts +1717 -788
- package/dist-types/pagination/ListAgreementsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListCertificatesPaginator.d.ts +4 -0
- package/dist-types/pagination/ListConnectorsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListProfilesPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +63 -0
- package/dist-types/ts3.4/Transfer.d.ts +105 -0
- package/dist-types/ts3.4/TransferClient.d.ts +23 -2
- package/dist-types/ts3.4/commands/CreateAgreementCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateConnectorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateProfileCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteAgreementCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteCertificateCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteConnectorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteProfileCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeAgreementCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeCertificateCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeConnectorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeProfileCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ImportCertificateCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListAgreementsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListCertificatesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListConnectorsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListProfilesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/StartFileTransferCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateAgreementCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateCertificateCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateConnectorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateProfileCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +21 -0
- package/dist-types/ts3.4/models/models_0.d.ts +733 -357
- package/dist-types/ts3.4/pagination/ListAgreementsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListCertificatesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListConnectorsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListProfilesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +63 -0
- package/package.json +6 -6
|
@@ -12,6 +12,103 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
12
12
|
*/
|
|
13
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
14
|
}
|
|
15
|
+
export declare enum AgreementStatusType {
|
|
16
|
+
ACTIVE = "ACTIVE",
|
|
17
|
+
INACTIVE = "INACTIVE"
|
|
18
|
+
}
|
|
19
|
+
export declare enum CompressionEnum {
|
|
20
|
+
DISABLED = "DISABLED",
|
|
21
|
+
ZLIB = "ZLIB"
|
|
22
|
+
}
|
|
23
|
+
export declare enum EncryptionAlg {
|
|
24
|
+
AES128_CBC = "AES128_CBC",
|
|
25
|
+
AES192_CBC = "AES192_CBC",
|
|
26
|
+
AES256_CBC = "AES256_CBC"
|
|
27
|
+
}
|
|
28
|
+
export declare enum MdnResponse {
|
|
29
|
+
NONE = "NONE",
|
|
30
|
+
SYNC = "SYNC"
|
|
31
|
+
}
|
|
32
|
+
export declare enum MdnSigningAlg {
|
|
33
|
+
DEFAULT = "DEFAULT",
|
|
34
|
+
NONE = "NONE",
|
|
35
|
+
SHA1 = "SHA1",
|
|
36
|
+
SHA256 = "SHA256",
|
|
37
|
+
SHA384 = "SHA384",
|
|
38
|
+
SHA512 = "SHA512"
|
|
39
|
+
}
|
|
40
|
+
export declare enum SigningAlg {
|
|
41
|
+
NONE = "NONE",
|
|
42
|
+
SHA1 = "SHA1",
|
|
43
|
+
SHA256 = "SHA256",
|
|
44
|
+
SHA384 = "SHA384",
|
|
45
|
+
SHA512 = "SHA512"
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* <p>Contains the details for a connector object. The connector object is used for AS2 outbound
|
|
49
|
+
* processes, to connect the Transfer Family customer with the trading partner.</p>
|
|
50
|
+
*/
|
|
51
|
+
export interface As2ConnectorConfig {
|
|
52
|
+
/**
|
|
53
|
+
* <p>A unique identifier for the AS2 process.</p>
|
|
54
|
+
*/
|
|
55
|
+
LocalProfileId?: string;
|
|
56
|
+
/**
|
|
57
|
+
* <p>A unique identifier for the partner for the connector.</p>
|
|
58
|
+
*/
|
|
59
|
+
PartnerProfileId?: string;
|
|
60
|
+
/**
|
|
61
|
+
* <p>A short description to help identify the connector.</p>
|
|
62
|
+
*/
|
|
63
|
+
MessageSubject?: string;
|
|
64
|
+
/**
|
|
65
|
+
* <p>Specifies whether the AS2 file is compressed.</p>
|
|
66
|
+
*/
|
|
67
|
+
Compression?: CompressionEnum | string;
|
|
68
|
+
/**
|
|
69
|
+
* <p>The algorithm that is used to encrypt the file.</p>
|
|
70
|
+
*/
|
|
71
|
+
EncryptionAlgorithm?: EncryptionAlg | string;
|
|
72
|
+
/**
|
|
73
|
+
* <p>The algorithm that is used to sign the AS2 transfers for this partner profile.</p>
|
|
74
|
+
*/
|
|
75
|
+
SigningAlgorithm?: SigningAlg | string;
|
|
76
|
+
/**
|
|
77
|
+
* <p>The signing algorithm for the MDN response.</p>
|
|
78
|
+
*/
|
|
79
|
+
MdnSigningAlgorithm?: MdnSigningAlg | string;
|
|
80
|
+
/**
|
|
81
|
+
* <p>Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether
|
|
82
|
+
* the partner response for transfers is synchronous or asynchronous. Specify either of the following values:</p>
|
|
83
|
+
* <ul>
|
|
84
|
+
* <li>
|
|
85
|
+
* <p>
|
|
86
|
+
* <code>SYNC</code>: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).</p>
|
|
87
|
+
* </li>
|
|
88
|
+
* <li>
|
|
89
|
+
* <p>
|
|
90
|
+
* <code>NONE</code>: Specifies that no MDN response is required.</p>
|
|
91
|
+
* </li>
|
|
92
|
+
* </ul>
|
|
93
|
+
*/
|
|
94
|
+
MdnResponse?: MdnResponse | string;
|
|
95
|
+
}
|
|
96
|
+
export declare enum As2Transport {
|
|
97
|
+
HTTP = "HTTP"
|
|
98
|
+
}
|
|
99
|
+
export declare enum CertificateStatusType {
|
|
100
|
+
ACTIVE = "ACTIVE",
|
|
101
|
+
INACTIVE = "INACTIVE",
|
|
102
|
+
PENDING_ROTATION = "PENDING_ROTATION"
|
|
103
|
+
}
|
|
104
|
+
export declare enum CertificateType {
|
|
105
|
+
CERTIFICATE = "CERTIFICATE",
|
|
106
|
+
CERTIFICATE_WITH_PRIVATE_KEY = "CERTIFICATE_WITH_PRIVATE_KEY"
|
|
107
|
+
}
|
|
108
|
+
export declare enum CertificateUsageType {
|
|
109
|
+
ENCRYPTION = "ENCRYPTION",
|
|
110
|
+
SIGNING = "SIGNING"
|
|
111
|
+
}
|
|
15
112
|
/**
|
|
16
113
|
* <p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer
|
|
17
114
|
* protocol-enabled server that has VPC as the endpoint type and the server's
|
|
@@ -42,12 +139,6 @@ export interface EfsFileLocation {
|
|
|
42
139
|
*/
|
|
43
140
|
Path?: string;
|
|
44
141
|
}
|
|
45
|
-
export declare namespace EfsFileLocation {
|
|
46
|
-
/**
|
|
47
|
-
* @internal
|
|
48
|
-
*/
|
|
49
|
-
const filterSensitiveLog: (obj: EfsFileLocation) => any;
|
|
50
|
-
}
|
|
51
142
|
/**
|
|
52
143
|
* <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>
|
|
53
144
|
* <p>
|
|
@@ -67,16 +158,10 @@ export interface S3InputFileLocation {
|
|
|
67
158
|
*/
|
|
68
159
|
Bucket?: string;
|
|
69
160
|
/**
|
|
70
|
-
* <p>The name assigned to the file when it was created in S3. You use the object key to retrieve the object.</p>
|
|
161
|
+
* <p>The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.</p>
|
|
71
162
|
*/
|
|
72
163
|
Key?: string;
|
|
73
164
|
}
|
|
74
|
-
export declare namespace S3InputFileLocation {
|
|
75
|
-
/**
|
|
76
|
-
* @internal
|
|
77
|
-
*/
|
|
78
|
-
const filterSensitiveLog: (obj: S3InputFileLocation) => any;
|
|
79
|
-
}
|
|
80
165
|
/**
|
|
81
166
|
* <p>Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.</p>
|
|
82
167
|
*/
|
|
@@ -90,12 +175,6 @@ export interface InputFileLocation {
|
|
|
90
175
|
*/
|
|
91
176
|
EfsFileLocation?: EfsFileLocation;
|
|
92
177
|
}
|
|
93
|
-
export declare namespace InputFileLocation {
|
|
94
|
-
/**
|
|
95
|
-
* @internal
|
|
96
|
-
*/
|
|
97
|
-
const filterSensitiveLog: (obj: InputFileLocation) => any;
|
|
98
|
-
}
|
|
99
178
|
export declare enum OverwriteExisting {
|
|
100
179
|
FALSE = "FALSE",
|
|
101
180
|
TRUE = "TRUE"
|
|
@@ -135,12 +214,6 @@ export interface CopyStepDetails {
|
|
|
135
214
|
*/
|
|
136
215
|
SourceFileLocation?: string;
|
|
137
216
|
}
|
|
138
|
-
export declare namespace CopyStepDetails {
|
|
139
|
-
/**
|
|
140
|
-
* @internal
|
|
141
|
-
*/
|
|
142
|
-
const filterSensitiveLog: (obj: CopyStepDetails) => any;
|
|
143
|
-
}
|
|
144
217
|
/**
|
|
145
218
|
* <p>Represents an object that contains entries and targets for
|
|
146
219
|
* <code>HomeDirectoryMappings</code>.</p>
|
|
@@ -159,12 +232,6 @@ export interface HomeDirectoryMapEntry {
|
|
|
159
232
|
*/
|
|
160
233
|
Target: string | undefined;
|
|
161
234
|
}
|
|
162
|
-
export declare namespace HomeDirectoryMapEntry {
|
|
163
|
-
/**
|
|
164
|
-
* @internal
|
|
165
|
-
*/
|
|
166
|
-
const filterSensitiveLog: (obj: HomeDirectoryMapEntry) => any;
|
|
167
|
-
}
|
|
168
235
|
export declare enum HomeDirectoryType {
|
|
169
236
|
LOGICAL = "LOGICAL",
|
|
170
237
|
PATH = "PATH"
|
|
@@ -190,12 +257,6 @@ export interface PosixProfile {
|
|
|
190
257
|
*/
|
|
191
258
|
SecondaryGids?: number[];
|
|
192
259
|
}
|
|
193
|
-
export declare namespace PosixProfile {
|
|
194
|
-
/**
|
|
195
|
-
* @internal
|
|
196
|
-
*/
|
|
197
|
-
const filterSensitiveLog: (obj: PosixProfile) => any;
|
|
198
|
-
}
|
|
199
260
|
export interface CreateAccessRequest {
|
|
200
261
|
/**
|
|
201
262
|
* <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
|
|
@@ -203,10 +264,10 @@ export interface CreateAccessRequest {
|
|
|
203
264
|
*/
|
|
204
265
|
HomeDirectory?: string;
|
|
205
266
|
/**
|
|
206
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log
|
|
207
|
-
* 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
|
|
208
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
209
|
-
* S3 or EFS paths visible to your users.</p>
|
|
267
|
+
* <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
|
|
268
|
+
* 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
|
|
269
|
+
* protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
270
|
+
* how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p>
|
|
210
271
|
*/
|
|
211
272
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
212
273
|
/**
|
|
@@ -214,9 +275,9 @@ export interface CreateAccessRequest {
|
|
|
214
275
|
* be visible to your user and how you want to make them visible. You must specify the
|
|
215
276
|
* <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
|
|
216
277
|
* is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
|
|
217
|
-
* only specify a target, it is displayed as is. You also must ensure that your
|
|
218
|
-
*
|
|
219
|
-
* can
|
|
278
|
+
* only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM)
|
|
279
|
+
* role provides access to paths in <code>Target</code>. This value
|
|
280
|
+
* can be set only when <code>HomeDirectoryType</code> is set to
|
|
220
281
|
* <i>LOGICAL</i>.</p>
|
|
221
282
|
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>
|
|
222
283
|
* <p>
|
|
@@ -233,18 +294,18 @@ export interface CreateAccessRequest {
|
|
|
233
294
|
*/
|
|
234
295
|
HomeDirectoryMappings?: HomeDirectoryMapEntry[];
|
|
235
296
|
/**
|
|
236
|
-
* <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
|
|
297
|
+
* <p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's
|
|
237
298
|
* access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
|
|
238
299
|
* <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
|
|
239
300
|
*
|
|
240
301
|
* <note>
|
|
241
|
-
* <p>This
|
|
242
|
-
* <p>For session policies,
|
|
302
|
+
* <p>This policy applies only when the domain of <code>ServerId</code> is Amazon S3. Amazon EFS does not use session policies.</p>
|
|
303
|
+
* <p>For session policies, Transfer Family stores the policy as a JSON blob, instead
|
|
243
304
|
* of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass
|
|
244
305
|
* it in the <code>Policy</code> argument.</p>
|
|
245
306
|
* <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html">Example
|
|
246
307
|
* session policy</a>.</p>
|
|
247
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>
|
|
308
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Security Token Service API
|
|
248
309
|
* Reference</i>.</p>
|
|
249
310
|
* </note>
|
|
250
311
|
*/
|
|
@@ -258,10 +319,10 @@ export interface CreateAccessRequest {
|
|
|
258
319
|
*/
|
|
259
320
|
PosixProfile?: PosixProfile;
|
|
260
321
|
/**
|
|
261
|
-
* <p>
|
|
262
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
263
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust
|
|
264
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
322
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
|
|
323
|
+
* bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
324
|
+
* when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
|
|
325
|
+
* relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
|
|
265
326
|
*/
|
|
266
327
|
Role: string | undefined;
|
|
267
328
|
/**
|
|
@@ -271,7 +332,7 @@ export interface CreateAccessRequest {
|
|
|
271
332
|
/**
|
|
272
333
|
* <p>A unique identifier that is required to identify specific groups within your directory.
|
|
273
334
|
* The users of the group that you associate have access to your Amazon S3 or Amazon EFS
|
|
274
|
-
* resources over the enabled protocols using
|
|
335
|
+
* resources over the enabled protocols using Transfer Family. If you know the group name,
|
|
275
336
|
* you can view the SID values by running the following command using Windows PowerShell.</p>
|
|
276
337
|
*
|
|
277
338
|
* <p>
|
|
@@ -280,17 +341,11 @@ export interface CreateAccessRequest {
|
|
|
280
341
|
*
|
|
281
342
|
* <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
|
|
282
343
|
*
|
|
283
|
-
* <p>The
|
|
344
|
+
* <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
|
|
284
345
|
* You can also include underscores or any of the following characters: =,.@:/-</p>
|
|
285
346
|
*/
|
|
286
347
|
ExternalId: string | undefined;
|
|
287
348
|
}
|
|
288
|
-
export declare namespace CreateAccessRequest {
|
|
289
|
-
/**
|
|
290
|
-
* @internal
|
|
291
|
-
*/
|
|
292
|
-
const filterSensitiveLog: (obj: CreateAccessRequest) => any;
|
|
293
|
-
}
|
|
294
349
|
export interface CreateAccessResponse {
|
|
295
350
|
/**
|
|
296
351
|
* <p>The ID of the server that the user is attached to.</p>
|
|
@@ -298,16 +353,10 @@ export interface CreateAccessResponse {
|
|
|
298
353
|
ServerId: string | undefined;
|
|
299
354
|
/**
|
|
300
355
|
* <p>The external ID of the group whose users have access to your Amazon S3 or Amazon EFS
|
|
301
|
-
* resources over the enabled protocols using
|
|
356
|
+
* resources over the enabled protocols using Transfer Family.</p>
|
|
302
357
|
*/
|
|
303
358
|
ExternalId: string | undefined;
|
|
304
359
|
}
|
|
305
|
-
export declare namespace CreateAccessResponse {
|
|
306
|
-
/**
|
|
307
|
-
* @internal
|
|
308
|
-
*/
|
|
309
|
-
const filterSensitiveLog: (obj: CreateAccessResponse) => any;
|
|
310
|
-
}
|
|
311
360
|
/**
|
|
312
361
|
* <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
|
|
313
362
|
*/
|
|
@@ -373,6 +422,142 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
373
422
|
*/
|
|
374
423
|
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
375
424
|
}
|
|
425
|
+
/**
|
|
426
|
+
* <p>Creates a key-value pair for a specific resource. Tags are metadata that you can use to
|
|
427
|
+
* search for and group a resource for various purposes. You can apply tags to servers, users,
|
|
428
|
+
* and roles. A tag key can take more than one value. For example, to group servers for
|
|
429
|
+
* accounting purposes, you might create a tag called <code>Group</code> and assign the values
|
|
430
|
+
* <code>Research</code> and <code>Accounting</code> to that group.</p>
|
|
431
|
+
*/
|
|
432
|
+
export interface Tag {
|
|
433
|
+
/**
|
|
434
|
+
* <p>The name assigned to the tag that you create.</p>
|
|
435
|
+
*/
|
|
436
|
+
Key: string | undefined;
|
|
437
|
+
/**
|
|
438
|
+
* <p>Contains one or more values that you assigned to the key name you create.</p>
|
|
439
|
+
*/
|
|
440
|
+
Value: string | undefined;
|
|
441
|
+
}
|
|
442
|
+
export interface CreateAgreementRequest {
|
|
443
|
+
/**
|
|
444
|
+
* <p>A name or short description to identify the agreement. </p>
|
|
445
|
+
*/
|
|
446
|
+
Description?: string;
|
|
447
|
+
/**
|
|
448
|
+
* <p>A system-assigned unique identifier for a server instance. This is the specific server
|
|
449
|
+
* that the agreement uses.</p>
|
|
450
|
+
*/
|
|
451
|
+
ServerId: string | undefined;
|
|
452
|
+
/**
|
|
453
|
+
* <p>A unique identifier for the AS2 local profile.</p>
|
|
454
|
+
*/
|
|
455
|
+
LocalProfileId: string | undefined;
|
|
456
|
+
/**
|
|
457
|
+
* <p>A unique identifier for the partner profile used in the agreement.</p>
|
|
458
|
+
*/
|
|
459
|
+
PartnerProfileId: string | undefined;
|
|
460
|
+
/**
|
|
461
|
+
* <p>The landing directory (folder) for files transferred by using the AS2 protocol.</p>
|
|
462
|
+
* <p>A <code>BaseDirectory</code> example is
|
|
463
|
+
* <code>/<i>DOC-EXAMPLE-BUCKET</i>/<i>home</i>/<i>mydirectory</i>
|
|
464
|
+
* </code>.</p>
|
|
465
|
+
*/
|
|
466
|
+
BaseDirectory: string | undefined;
|
|
467
|
+
/**
|
|
468
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the
|
|
469
|
+
* <code>HomeDirectory</code> of your users' Amazon S3 buckets.</p>
|
|
470
|
+
*/
|
|
471
|
+
AccessRole: string | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* <p>The status of the agreement. The agreement can be either <code>ACTIVE</code> or
|
|
474
|
+
* <code>INACTIVE</code>.</p>
|
|
475
|
+
*/
|
|
476
|
+
Status?: AgreementStatusType | string;
|
|
477
|
+
/**
|
|
478
|
+
* <p>Key-value pairs that can be used to group and search for agreements.</p>
|
|
479
|
+
*/
|
|
480
|
+
Tags?: Tag[];
|
|
481
|
+
}
|
|
482
|
+
export interface CreateAgreementResponse {
|
|
483
|
+
/**
|
|
484
|
+
* <p>The unique identifier for the agreement. Use this ID for deleting, or updating an
|
|
485
|
+
* agreement, as well as in any other API calls that require that you specify the agreement
|
|
486
|
+
* ID.</p>
|
|
487
|
+
*/
|
|
488
|
+
AgreementId: string | undefined;
|
|
489
|
+
}
|
|
490
|
+
export interface CreateConnectorRequest {
|
|
491
|
+
/**
|
|
492
|
+
* <p>The URL of the partner's AS2 endpoint.</p>
|
|
493
|
+
*/
|
|
494
|
+
Url: string | undefined;
|
|
495
|
+
/**
|
|
496
|
+
* <p>A structure that contains the parameters for a connector object.</p>
|
|
497
|
+
*/
|
|
498
|
+
As2Config: As2ConnectorConfig | undefined;
|
|
499
|
+
/**
|
|
500
|
+
* <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
|
|
501
|
+
* file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
|
|
502
|
+
* directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
|
|
503
|
+
* directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file,
|
|
504
|
+
* store the MDN when we receive them from the partner, and write a final JSON file containing
|
|
505
|
+
* relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read
|
|
506
|
+
* and write access to the parent directory of the file location used in the
|
|
507
|
+
* <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
|
|
508
|
+
* access to the parent directory of the files that you intend to send with
|
|
509
|
+
* <code>StartFileTransfer</code>.</p>
|
|
510
|
+
*/
|
|
511
|
+
AccessRole: string | undefined;
|
|
512
|
+
/**
|
|
513
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn
|
|
514
|
+
* on CloudWatch logging for Amazon S3 events. When set, you can view connector
|
|
515
|
+
* activity in your CloudWatch logs.</p>
|
|
516
|
+
*/
|
|
517
|
+
LoggingRole?: string;
|
|
518
|
+
/**
|
|
519
|
+
* <p>Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.</p>
|
|
520
|
+
*/
|
|
521
|
+
Tags?: Tag[];
|
|
522
|
+
}
|
|
523
|
+
export interface CreateConnectorResponse {
|
|
524
|
+
/**
|
|
525
|
+
* <p>The unique identifier for the connector, returned after the API call succeeds.</p>
|
|
526
|
+
*/
|
|
527
|
+
ConnectorId: string | undefined;
|
|
528
|
+
}
|
|
529
|
+
export declare enum ProfileType {
|
|
530
|
+
LOCAL = "LOCAL",
|
|
531
|
+
PARTNER = "PARTNER"
|
|
532
|
+
}
|
|
533
|
+
export interface CreateProfileRequest {
|
|
534
|
+
/**
|
|
535
|
+
* <p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the defined in
|
|
536
|
+
* the <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages
|
|
537
|
+
* sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the
|
|
538
|
+
* AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.</p>
|
|
539
|
+
*/
|
|
540
|
+
As2Id: string | undefined;
|
|
541
|
+
/**
|
|
542
|
+
* <p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles.
|
|
543
|
+
* If not supplied in the request, the command lists all types of profiles.</p>
|
|
544
|
+
*/
|
|
545
|
+
ProfileType: ProfileType | string | undefined;
|
|
546
|
+
/**
|
|
547
|
+
* <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
|
|
548
|
+
*/
|
|
549
|
+
CertificateIds?: string[];
|
|
550
|
+
/**
|
|
551
|
+
* <p>Key-value pairs that can be used to group and search for AS2 profiles.</p>
|
|
552
|
+
*/
|
|
553
|
+
Tags?: Tag[];
|
|
554
|
+
}
|
|
555
|
+
export interface CreateProfileResponse {
|
|
556
|
+
/**
|
|
557
|
+
* <p>The unique identifier for the AS2 profile, returned after the API call succeeds.</p>
|
|
558
|
+
*/
|
|
559
|
+
ProfileId: string | undefined;
|
|
560
|
+
}
|
|
376
561
|
export declare enum Domain {
|
|
377
562
|
EFS = "EFS",
|
|
378
563
|
S3 = "S3"
|
|
@@ -453,12 +638,6 @@ export interface EndpointDetails {
|
|
|
453
638
|
*/
|
|
454
639
|
SecurityGroupIds?: string[];
|
|
455
640
|
}
|
|
456
|
-
export declare namespace EndpointDetails {
|
|
457
|
-
/**
|
|
458
|
-
* @internal
|
|
459
|
-
*/
|
|
460
|
-
const filterSensitiveLog: (obj: EndpointDetails) => any;
|
|
461
|
-
}
|
|
462
641
|
export declare enum EndpointType {
|
|
463
642
|
PUBLIC = "PUBLIC",
|
|
464
643
|
VPC = "VPC",
|
|
@@ -480,7 +659,7 @@ export interface IdentityProviderDetails {
|
|
|
480
659
|
*/
|
|
481
660
|
InvocationRole?: string;
|
|
482
661
|
/**
|
|
483
|
-
* <p>The identifier of the
|
|
662
|
+
* <p>The identifier of the Directory Service directory that you want to stop sharing.</p>
|
|
484
663
|
*/
|
|
485
664
|
DirectoryId?: string;
|
|
486
665
|
/**
|
|
@@ -488,12 +667,6 @@ export interface IdentityProviderDetails {
|
|
|
488
667
|
*/
|
|
489
668
|
Function?: string;
|
|
490
669
|
}
|
|
491
|
-
export declare namespace IdentityProviderDetails {
|
|
492
|
-
/**
|
|
493
|
-
* @internal
|
|
494
|
-
*/
|
|
495
|
-
const filterSensitiveLog: (obj: IdentityProviderDetails) => any;
|
|
496
|
-
}
|
|
497
670
|
export declare enum IdentityProviderType {
|
|
498
671
|
API_GATEWAY = "API_GATEWAY",
|
|
499
672
|
AWS_DIRECTORY_SERVICE = "AWS_DIRECTORY_SERVICE",
|
|
@@ -579,43 +752,19 @@ export interface ProtocolDetails {
|
|
|
579
752
|
* </note>
|
|
580
753
|
*/
|
|
581
754
|
SetStatOption?: SetStatOption | string;
|
|
582
|
-
}
|
|
583
|
-
export declare namespace ProtocolDetails {
|
|
584
755
|
/**
|
|
585
|
-
*
|
|
756
|
+
* <p>Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p>
|
|
586
757
|
*/
|
|
587
|
-
|
|
758
|
+
As2Transports?: (As2Transport | string)[];
|
|
588
759
|
}
|
|
589
760
|
export declare enum Protocol {
|
|
761
|
+
AS2 = "AS2",
|
|
590
762
|
FTP = "FTP",
|
|
591
763
|
FTPS = "FTPS",
|
|
592
764
|
SFTP = "SFTP"
|
|
593
765
|
}
|
|
594
766
|
/**
|
|
595
|
-
* <p>
|
|
596
|
-
* search for and group a resource for various purposes. You can apply tags to servers, users,
|
|
597
|
-
* and roles. A tag key can take more than one value. For example, to group servers for
|
|
598
|
-
* accounting purposes, you might create a tag called <code>Group</code> and assign the values
|
|
599
|
-
* <code>Research</code> and <code>Accounting</code> to that group.</p>
|
|
600
|
-
*/
|
|
601
|
-
export interface Tag {
|
|
602
|
-
/**
|
|
603
|
-
* <p>The name assigned to the tag that you create.</p>
|
|
604
|
-
*/
|
|
605
|
-
Key: string | undefined;
|
|
606
|
-
/**
|
|
607
|
-
* <p>Contains one or more values that you assigned to the key name you create.</p>
|
|
608
|
-
*/
|
|
609
|
-
Value: string | undefined;
|
|
610
|
-
}
|
|
611
|
-
export declare namespace Tag {
|
|
612
|
-
/**
|
|
613
|
-
* @internal
|
|
614
|
-
*/
|
|
615
|
-
const filterSensitiveLog: (obj: Tag) => any;
|
|
616
|
-
}
|
|
617
|
-
/**
|
|
618
|
-
* <p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>
|
|
767
|
+
* <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
|
|
619
768
|
*/
|
|
620
769
|
export interface WorkflowDetail {
|
|
621
770
|
/**
|
|
@@ -628,12 +777,6 @@ export interface WorkflowDetail {
|
|
|
628
777
|
*/
|
|
629
778
|
ExecutionRole: string | undefined;
|
|
630
779
|
}
|
|
631
|
-
export declare namespace WorkflowDetail {
|
|
632
|
-
/**
|
|
633
|
-
* @internal
|
|
634
|
-
*/
|
|
635
|
-
const filterSensitiveLog: (obj: WorkflowDetail) => any;
|
|
636
|
-
}
|
|
637
780
|
/**
|
|
638
781
|
* <p>Container for the <code>WorkflowDetail</code> data type.
|
|
639
782
|
* It is used by actions that trigger a workflow to begin execution.</p>
|
|
@@ -648,25 +791,19 @@ export interface WorkflowDetails {
|
|
|
648
791
|
*/
|
|
649
792
|
OnUpload: WorkflowDetail[] | undefined;
|
|
650
793
|
}
|
|
651
|
-
export declare namespace WorkflowDetails {
|
|
652
|
-
/**
|
|
653
|
-
* @internal
|
|
654
|
-
*/
|
|
655
|
-
const filterSensitiveLog: (obj: WorkflowDetails) => any;
|
|
656
|
-
}
|
|
657
794
|
export interface CreateServerRequest {
|
|
658
795
|
/**
|
|
659
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
796
|
+
* <p>The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required
|
|
660
797
|
* when <code>Protocols</code> is set to <code>FTPS</code>.</p>
|
|
661
798
|
*
|
|
662
799
|
* <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>
|
|
663
|
-
* in the <i>
|
|
800
|
+
* in the <i>Certificate Manager User Guide</i>.</p>
|
|
664
801
|
*
|
|
665
802
|
* <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>
|
|
666
|
-
* in the <i>
|
|
803
|
+
* in the <i>Certificate Manager User Guide</i>.</p>
|
|
667
804
|
*
|
|
668
805
|
* <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
|
|
669
|
-
* private certificate</a> in the <i>
|
|
806
|
+
* private certificate</a> in the <i>Certificate Manager User
|
|
670
807
|
* Guide</i>.</p>
|
|
671
808
|
*
|
|
672
809
|
* <p>Certificates with the following cryptographic algorithms and key sizes are
|
|
@@ -708,8 +845,8 @@ export interface CreateServerRequest {
|
|
|
708
845
|
Domain?: Domain | string;
|
|
709
846
|
/**
|
|
710
847
|
* <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
|
711
|
-
* When you host your endpoint within your VPC, you can make
|
|
712
|
-
* within your VPC, or you can attach Elastic IP addresses and make
|
|
848
|
+
* When you host your endpoint within your VPC, you can make your endpoint accessible only to resources
|
|
849
|
+
* within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over
|
|
713
850
|
* the internet. Your VPC's default security groups are automatically assigned to your
|
|
714
851
|
* endpoint.</p>
|
|
715
852
|
*/
|
|
@@ -742,7 +879,7 @@ export interface CreateServerRequest {
|
|
|
742
879
|
* <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
|
|
743
880
|
* <p>
|
|
744
881
|
* <code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
|
|
745
|
-
* <p>Use a minimum value of 2048 for the <code>-b</code> option
|
|
882
|
+
* <p>Use a minimum value of 2048 for the <code>-b</code> option. You can create a stronger key by using 3072 or 4096.</p>
|
|
746
883
|
*
|
|
747
884
|
* <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
|
|
748
885
|
* <p>
|
|
@@ -763,8 +900,7 @@ export interface CreateServerRequest {
|
|
|
763
900
|
*
|
|
764
901
|
*
|
|
765
902
|
*
|
|
766
|
-
* <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>
|
|
767
|
-
* Family User Guide</i>.</p>
|
|
903
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change the host key for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>
|
|
768
904
|
*/
|
|
769
905
|
HostKey?: string;
|
|
770
906
|
/**
|
|
@@ -776,36 +912,38 @@ export interface CreateServerRequest {
|
|
|
776
912
|
*/
|
|
777
913
|
IdentityProviderDetails?: IdentityProviderDetails;
|
|
778
914
|
/**
|
|
779
|
-
* <p>
|
|
915
|
+
* <p>The mode of authentication for a server. The default value is
|
|
780
916
|
* <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
|
|
781
|
-
* the
|
|
917
|
+
* the Transfer Family service.</p>
|
|
782
918
|
* <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to
|
|
783
|
-
* Active Directory groups in
|
|
784
|
-
* on-premises environment or in Amazon Web Services using AD
|
|
785
|
-
* provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
919
|
+
* Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your
|
|
920
|
+
* on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to
|
|
921
|
+
* provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
786
922
|
* <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The
|
|
787
|
-
* <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call
|
|
788
|
-
* for authentication using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
789
|
-
* <p>Use the <code>AWS_LAMBDA</code> value to directly use
|
|
790
|
-
* you must specify the ARN for the
|
|
923
|
+
* <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call
|
|
924
|
+
* for authentication by using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
925
|
+
* <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider.
|
|
926
|
+
* If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter
|
|
927
|
+
* or the <code>IdentityProviderDetails</code> data type.</p>
|
|
791
928
|
*/
|
|
792
929
|
IdentityProviderType?: IdentityProviderType | string;
|
|
793
930
|
/**
|
|
794
|
-
* <p>
|
|
795
|
-
* on Amazon CloudWatch logging for Amazon S3 or Amazon
|
|
931
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
|
|
932
|
+
* on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
|
|
796
933
|
* your CloudWatch logs.</p>
|
|
797
934
|
*/
|
|
798
935
|
LoggingRole?: string;
|
|
799
936
|
/**
|
|
800
|
-
* <p>
|
|
937
|
+
* <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p>
|
|
801
938
|
* <note>
|
|
802
939
|
* <p>The SFTP protocol does not support post-authentication display banners.</p>
|
|
803
940
|
* </note>
|
|
804
941
|
*/
|
|
805
942
|
PostAuthenticationLoginBanner?: string;
|
|
806
943
|
/**
|
|
807
|
-
* <p>
|
|
808
|
-
* For example, the following banner displays details about using the system
|
|
944
|
+
* <p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.
|
|
945
|
+
* For example, the following banner displays details about using the system:</p>
|
|
946
|
+
*
|
|
809
947
|
* <p>
|
|
810
948
|
* <code>This system is for the use of authorized users only. Individuals using this computer system without authority,
|
|
811
949
|
* or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by
|
|
@@ -832,23 +970,38 @@ export interface CreateServerRequest {
|
|
|
832
970
|
* <p>
|
|
833
971
|
* <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p>
|
|
834
972
|
* </li>
|
|
973
|
+
* <li>
|
|
974
|
+
* <p>
|
|
975
|
+
* <code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p>
|
|
976
|
+
* </li>
|
|
835
977
|
* </ul>
|
|
836
978
|
*
|
|
837
979
|
* <note>
|
|
838
|
-
* <
|
|
839
|
-
*
|
|
840
|
-
*
|
|
841
|
-
*
|
|
842
|
-
*
|
|
843
|
-
*
|
|
844
|
-
*
|
|
845
|
-
*
|
|
846
|
-
* <
|
|
980
|
+
* <ul>
|
|
981
|
+
* <li>
|
|
982
|
+
* <p>If you select <code>FTPS</code>, you must choose a certificate stored in Certificate Manager (ACM)
|
|
983
|
+
* which is used to identify your server when clients connect to it over
|
|
984
|
+
* FTPS.</p>
|
|
985
|
+
* </li>
|
|
986
|
+
* <li>
|
|
987
|
+
* <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the
|
|
988
|
+
* <code>EndpointType</code> must be <code>VPC</code> and the
|
|
989
|
+
* <code>IdentityProviderType</code> must be <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>.</p>
|
|
990
|
+
* </li>
|
|
991
|
+
* <li>
|
|
992
|
+
* <p>If <code>Protocol</code> includes <code>FTP</code>, then
|
|
847
993
|
* <code>AddressAllocationIds</code> cannot be associated.</p>
|
|
848
|
-
*
|
|
849
|
-
*
|
|
850
|
-
*
|
|
851
|
-
*
|
|
994
|
+
* </li>
|
|
995
|
+
* <li>
|
|
996
|
+
* <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code>
|
|
997
|
+
* can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to
|
|
998
|
+
* <code>SERVICE_MANAGED</code>.</p>
|
|
999
|
+
* </li>
|
|
1000
|
+
* <li>
|
|
1001
|
+
* <p>If <code>Protocol</code> includes <code>AS2</code>, then the
|
|
1002
|
+
* <code>EndpointType</code> must be <code>VPC</code>, and domain must be Amazon S3.</p>
|
|
1003
|
+
* </li>
|
|
1004
|
+
* </ul>
|
|
852
1005
|
* </note>
|
|
853
1006
|
*/
|
|
854
1007
|
Protocols?: (Protocol | string)[];
|
|
@@ -857,19 +1010,25 @@ export interface CreateServerRequest {
|
|
|
857
1010
|
* <ul>
|
|
858
1011
|
* <li>
|
|
859
1012
|
* <p>
|
|
860
|
-
*
|
|
1013
|
+
* To indicate passive mode (for FTP and FTPS protocols), use the <code>PassiveIp</code> parameter.
|
|
861
1014
|
* Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
|
|
862
1015
|
* </p>
|
|
863
1016
|
* </li>
|
|
864
1017
|
* <li>
|
|
865
|
-
* <p>
|
|
866
|
-
*
|
|
867
|
-
*
|
|
868
|
-
*
|
|
1018
|
+
* <p>To ignore the error that is generated when the client attempts to use the <code>SETSTAT</code> command on a file that you are
|
|
1019
|
+
* uploading to an Amazon S3 bucket, use the <code>SetStatOption</code> parameter. To have the Transfer Family server ignore the
|
|
1020
|
+
* <code>SETSTAT</code> command and upload files without needing to make any changes to your SFTP client, set the value to
|
|
1021
|
+
* <code>ENABLE_NO_OP</code>. If you set the <code>SetStatOption</code> parameter to <code>ENABLE_NO_OP</code>, Transfer Family
|
|
1022
|
+
* generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a <code>SETSTAT</code>
|
|
1023
|
+
* call.</p>
|
|
1024
|
+
* </li>
|
|
1025
|
+
* <li>
|
|
1026
|
+
* <p>To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the
|
|
1027
|
+
* <code>TlsSessionResumptionMode</code> parameter.</p>
|
|
869
1028
|
* </li>
|
|
870
1029
|
* <li>
|
|
871
|
-
* <p>
|
|
872
|
-
*
|
|
1030
|
+
* <p>
|
|
1031
|
+
* <code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p>
|
|
873
1032
|
* </li>
|
|
874
1033
|
* </ul>
|
|
875
1034
|
*/
|
|
@@ -883,28 +1042,16 @@ export interface CreateServerRequest {
|
|
|
883
1042
|
*/
|
|
884
1043
|
Tags?: Tag[];
|
|
885
1044
|
/**
|
|
886
|
-
* <p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>
|
|
1045
|
+
* <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
|
|
887
1046
|
*/
|
|
888
1047
|
WorkflowDetails?: WorkflowDetails;
|
|
889
1048
|
}
|
|
890
|
-
export declare namespace CreateServerRequest {
|
|
891
|
-
/**
|
|
892
|
-
* @internal
|
|
893
|
-
*/
|
|
894
|
-
const filterSensitiveLog: (obj: CreateServerRequest) => any;
|
|
895
|
-
}
|
|
896
1049
|
export interface CreateServerResponse {
|
|
897
1050
|
/**
|
|
898
1051
|
* <p>The service-assigned ID of the server that is created.</p>
|
|
899
1052
|
*/
|
|
900
1053
|
ServerId: string | undefined;
|
|
901
1054
|
}
|
|
902
|
-
export declare namespace CreateServerResponse {
|
|
903
|
-
/**
|
|
904
|
-
* @internal
|
|
905
|
-
*/
|
|
906
|
-
const filterSensitiveLog: (obj: CreateServerResponse) => any;
|
|
907
|
-
}
|
|
908
1055
|
/**
|
|
909
1056
|
* <p>The request was denied due to request throttling.</p>
|
|
910
1057
|
*/
|
|
@@ -924,10 +1071,10 @@ export interface CreateUserRequest {
|
|
|
924
1071
|
*/
|
|
925
1072
|
HomeDirectory?: string;
|
|
926
1073
|
/**
|
|
927
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log
|
|
928
|
-
* 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
|
|
929
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
930
|
-
* S3 or EFS paths visible to your users.</p>
|
|
1074
|
+
* <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
|
|
1075
|
+
* 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
|
|
1076
|
+
* protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
1077
|
+
* how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p>
|
|
931
1078
|
*/
|
|
932
1079
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
933
1080
|
/**
|
|
@@ -935,9 +1082,9 @@ export interface CreateUserRequest {
|
|
|
935
1082
|
* be visible to your user and how you want to make them visible. You must specify the
|
|
936
1083
|
* <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
|
|
937
1084
|
* is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
|
|
938
|
-
* only specify a target, it is displayed as is. You also must ensure that your
|
|
939
|
-
*
|
|
940
|
-
* can
|
|
1085
|
+
* only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM)
|
|
1086
|
+
* role provides access to paths in <code>Target</code>. This value
|
|
1087
|
+
* can be set only when <code>HomeDirectoryType</code> is set to
|
|
941
1088
|
* <i>LOGICAL</i>.</p>
|
|
942
1089
|
*
|
|
943
1090
|
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>
|
|
@@ -958,13 +1105,13 @@ export interface CreateUserRequest {
|
|
|
958
1105
|
*/
|
|
959
1106
|
HomeDirectoryMappings?: HomeDirectoryMapEntry[];
|
|
960
1107
|
/**
|
|
961
|
-
* <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
|
|
1108
|
+
* <p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's
|
|
962
1109
|
* access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
|
|
963
1110
|
* <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
|
|
964
1111
|
*
|
|
965
1112
|
* <note>
|
|
966
|
-
* <p>This
|
|
967
|
-
* <p>For session policies,
|
|
1113
|
+
* <p>This policy applies only when the domain of <code>ServerId</code> is Amazon S3. Amazon EFS does not use session policies.</p>
|
|
1114
|
+
* <p>For session policies, Transfer Family stores the policy as a JSON blob, instead
|
|
968
1115
|
* of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass
|
|
969
1116
|
* it in the <code>Policy</code> argument.</p>
|
|
970
1117
|
*
|
|
@@ -989,10 +1136,10 @@ export interface CreateUserRequest {
|
|
|
989
1136
|
*/
|
|
990
1137
|
PosixProfile?: PosixProfile;
|
|
991
1138
|
/**
|
|
992
|
-
* <p>
|
|
993
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
994
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust
|
|
995
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
1139
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
|
|
1140
|
+
* bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
1141
|
+
* when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
|
|
1142
|
+
* relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
|
|
996
1143
|
*/
|
|
997
1144
|
Role: string | undefined;
|
|
998
1145
|
/**
|
|
@@ -1019,12 +1166,6 @@ export interface CreateUserRequest {
|
|
|
1019
1166
|
*/
|
|
1020
1167
|
UserName: string | undefined;
|
|
1021
1168
|
}
|
|
1022
|
-
export declare namespace CreateUserRequest {
|
|
1023
|
-
/**
|
|
1024
|
-
* @internal
|
|
1025
|
-
*/
|
|
1026
|
-
const filterSensitiveLog: (obj: CreateUserRequest) => any;
|
|
1027
|
-
}
|
|
1028
1169
|
export interface CreateUserResponse {
|
|
1029
1170
|
/**
|
|
1030
1171
|
* <p>The ID of the server that the user is attached to.</p>
|
|
@@ -1035,12 +1176,6 @@ export interface CreateUserResponse {
|
|
|
1035
1176
|
*/
|
|
1036
1177
|
UserName: string | undefined;
|
|
1037
1178
|
}
|
|
1038
|
-
export declare namespace CreateUserResponse {
|
|
1039
|
-
/**
|
|
1040
|
-
* @internal
|
|
1041
|
-
*/
|
|
1042
|
-
const filterSensitiveLog: (obj: CreateUserResponse) => any;
|
|
1043
|
-
}
|
|
1044
1179
|
/**
|
|
1045
1180
|
* <p>Each step type has its own <code>StepDetails</code> structure.</p>
|
|
1046
1181
|
*/
|
|
@@ -1073,12 +1208,6 @@ export interface CustomStepDetails {
|
|
|
1073
1208
|
*/
|
|
1074
1209
|
SourceFileLocation?: string;
|
|
1075
1210
|
}
|
|
1076
|
-
export declare namespace CustomStepDetails {
|
|
1077
|
-
/**
|
|
1078
|
-
* @internal
|
|
1079
|
-
*/
|
|
1080
|
-
const filterSensitiveLog: (obj: CustomStepDetails) => any;
|
|
1081
|
-
}
|
|
1082
1211
|
/**
|
|
1083
1212
|
* <p>The name of the step, used to identify the delete step.</p>
|
|
1084
1213
|
*/
|
|
@@ -1103,12 +1232,6 @@ export interface DeleteStepDetails {
|
|
|
1103
1232
|
*/
|
|
1104
1233
|
SourceFileLocation?: string;
|
|
1105
1234
|
}
|
|
1106
|
-
export declare namespace DeleteStepDetails {
|
|
1107
|
-
/**
|
|
1108
|
-
* @internal
|
|
1109
|
-
*/
|
|
1110
|
-
const filterSensitiveLog: (obj: DeleteStepDetails) => any;
|
|
1111
|
-
}
|
|
1112
1235
|
/**
|
|
1113
1236
|
* <p>Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.</p>
|
|
1114
1237
|
*/
|
|
@@ -1122,12 +1245,6 @@ export interface S3Tag {
|
|
|
1122
1245
|
*/
|
|
1123
1246
|
Value: string | undefined;
|
|
1124
1247
|
}
|
|
1125
|
-
export declare namespace S3Tag {
|
|
1126
|
-
/**
|
|
1127
|
-
* @internal
|
|
1128
|
-
*/
|
|
1129
|
-
const filterSensitiveLog: (obj: S3Tag) => any;
|
|
1130
|
-
}
|
|
1131
1248
|
/**
|
|
1132
1249
|
* <p>Each step type has its own <code>StepDetails</code> structure.</p>
|
|
1133
1250
|
* <p>The key/value pairs used to tag a file during the execution of a workflow step.</p>
|
|
@@ -1157,12 +1274,6 @@ export interface TagStepDetails {
|
|
|
1157
1274
|
*/
|
|
1158
1275
|
SourceFileLocation?: string;
|
|
1159
1276
|
}
|
|
1160
|
-
export declare namespace TagStepDetails {
|
|
1161
|
-
/**
|
|
1162
|
-
* @internal
|
|
1163
|
-
*/
|
|
1164
|
-
const filterSensitiveLog: (obj: TagStepDetails) => any;
|
|
1165
|
-
}
|
|
1166
1277
|
export declare enum WorkflowStepType {
|
|
1167
1278
|
COPY = "COPY",
|
|
1168
1279
|
CUSTOM = "CUSTOM",
|
|
@@ -1180,19 +1291,19 @@ export interface WorkflowStep {
|
|
|
1180
1291
|
* <ul>
|
|
1181
1292
|
* <li>
|
|
1182
1293
|
* <p>
|
|
1183
|
-
* <i>COPY</i>:
|
|
1294
|
+
* <i>COPY</i>: Copy the file to another location.</p>
|
|
1184
1295
|
* </li>
|
|
1185
1296
|
* <li>
|
|
1186
1297
|
* <p>
|
|
1187
|
-
* <i>CUSTOM</i>: custom step with
|
|
1298
|
+
* <i>CUSTOM</i>: Perform a custom step with an Lambda function target.</p>
|
|
1188
1299
|
* </li>
|
|
1189
1300
|
* <li>
|
|
1190
1301
|
* <p>
|
|
1191
|
-
* <i>DELETE</i>:
|
|
1302
|
+
* <i>DELETE</i>: Delete the file.</p>
|
|
1192
1303
|
* </li>
|
|
1193
1304
|
* <li>
|
|
1194
1305
|
* <p>
|
|
1195
|
-
* <i>TAG</i>:
|
|
1306
|
+
* <i>TAG</i>: Add a tag to the file.</p>
|
|
1196
1307
|
* </li>
|
|
1197
1308
|
* </ul>
|
|
1198
1309
|
*/
|
|
@@ -1233,12 +1344,6 @@ export interface WorkflowStep {
|
|
|
1233
1344
|
*/
|
|
1234
1345
|
TagStepDetails?: TagStepDetails;
|
|
1235
1346
|
}
|
|
1236
|
-
export declare namespace WorkflowStep {
|
|
1237
|
-
/**
|
|
1238
|
-
* @internal
|
|
1239
|
-
*/
|
|
1240
|
-
const filterSensitiveLog: (obj: WorkflowStep) => any;
|
|
1241
|
-
}
|
|
1242
1347
|
export interface CreateWorkflowRequest {
|
|
1243
1348
|
/**
|
|
1244
1349
|
* <p>A textual description for the workflow.</p>
|
|
@@ -1252,19 +1357,19 @@ export interface CreateWorkflowRequest {
|
|
|
1252
1357
|
* <ul>
|
|
1253
1358
|
* <li>
|
|
1254
1359
|
* <p>
|
|
1255
|
-
* <i>COPY</i>:
|
|
1360
|
+
* <i>COPY</i>: Copy the file to another location.</p>
|
|
1256
1361
|
* </li>
|
|
1257
1362
|
* <li>
|
|
1258
1363
|
* <p>
|
|
1259
|
-
* <i>CUSTOM</i>: custom step with
|
|
1364
|
+
* <i>CUSTOM</i>: Perform a custom step with an Lambda function target.</p>
|
|
1260
1365
|
* </li>
|
|
1261
1366
|
* <li>
|
|
1262
1367
|
* <p>
|
|
1263
|
-
* <i>DELETE</i>:
|
|
1368
|
+
* <i>DELETE</i>: Delete the file.</p>
|
|
1264
1369
|
* </li>
|
|
1265
1370
|
* <li>
|
|
1266
1371
|
* <p>
|
|
1267
|
-
* <i>TAG</i>:
|
|
1372
|
+
* <i>TAG</i>: Add a tag to the file.</p>
|
|
1268
1373
|
* </li>
|
|
1269
1374
|
* </ul>
|
|
1270
1375
|
* <note>
|
|
@@ -1272,9 +1377,8 @@ export interface CreateWorkflowRequest {
|
|
|
1272
1377
|
* Currently, copying and tagging are supported only on S3.
|
|
1273
1378
|
* </p>
|
|
1274
1379
|
* </note>
|
|
1275
|
-
* <p>
|
|
1276
|
-
*
|
|
1277
|
-
* </p>
|
|
1380
|
+
* <p> For file location, you specify either the S3 bucket and key, or the EFS file system ID
|
|
1381
|
+
* and path. </p>
|
|
1278
1382
|
*/
|
|
1279
1383
|
Steps: WorkflowStep[] | undefined;
|
|
1280
1384
|
/**
|
|
@@ -1292,24 +1396,12 @@ export interface CreateWorkflowRequest {
|
|
|
1292
1396
|
*/
|
|
1293
1397
|
Tags?: Tag[];
|
|
1294
1398
|
}
|
|
1295
|
-
export declare namespace CreateWorkflowRequest {
|
|
1296
|
-
/**
|
|
1297
|
-
* @internal
|
|
1298
|
-
*/
|
|
1299
|
-
const filterSensitiveLog: (obj: CreateWorkflowRequest) => any;
|
|
1300
|
-
}
|
|
1301
1399
|
export interface CreateWorkflowResponse {
|
|
1302
1400
|
/**
|
|
1303
1401
|
* <p>A unique identifier for the workflow.</p>
|
|
1304
1402
|
*/
|
|
1305
1403
|
WorkflowId: string | undefined;
|
|
1306
1404
|
}
|
|
1307
|
-
export declare namespace CreateWorkflowResponse {
|
|
1308
|
-
/**
|
|
1309
|
-
* @internal
|
|
1310
|
-
*/
|
|
1311
|
-
const filterSensitiveLog: (obj: CreateWorkflowResponse) => any;
|
|
1312
|
-
}
|
|
1313
1405
|
export declare enum CustomStepStatus {
|
|
1314
1406
|
FAILURE = "FAILURE",
|
|
1315
1407
|
SUCCESS = "SUCCESS"
|
|
@@ -1322,7 +1414,7 @@ export interface DeleteAccessRequest {
|
|
|
1322
1414
|
/**
|
|
1323
1415
|
* <p>A unique identifier that is required to identify specific groups within your directory.
|
|
1324
1416
|
* The users of the group that you associate have access to your Amazon S3 or Amazon EFS
|
|
1325
|
-
* resources over the enabled protocols using
|
|
1417
|
+
* resources over the enabled protocols using Transfer Family. If you know the group name,
|
|
1326
1418
|
* you can view the SID values by running the following command using Windows PowerShell.</p>
|
|
1327
1419
|
*
|
|
1328
1420
|
* <p>
|
|
@@ -1331,49 +1423,59 @@ export interface DeleteAccessRequest {
|
|
|
1331
1423
|
*
|
|
1332
1424
|
* <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
|
|
1333
1425
|
*
|
|
1334
|
-
* <p>The
|
|
1426
|
+
* <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
|
|
1335
1427
|
* You can also include underscores or any of the following characters: =,.@:/-</p>
|
|
1336
1428
|
*/
|
|
1337
1429
|
ExternalId: string | undefined;
|
|
1338
1430
|
}
|
|
1339
|
-
export
|
|
1431
|
+
export interface DeleteAgreementRequest {
|
|
1340
1432
|
/**
|
|
1341
|
-
*
|
|
1433
|
+
* <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
|
|
1342
1434
|
*/
|
|
1343
|
-
|
|
1344
|
-
}
|
|
1345
|
-
export interface DeleteServerRequest {
|
|
1435
|
+
AgreementId: string | undefined;
|
|
1346
1436
|
/**
|
|
1347
|
-
* <p>
|
|
1437
|
+
* <p>The server ID associated with the agreement that you are deleting.</p>
|
|
1348
1438
|
*/
|
|
1349
1439
|
ServerId: string | undefined;
|
|
1350
1440
|
}
|
|
1351
|
-
export
|
|
1441
|
+
export interface DeleteCertificateRequest {
|
|
1352
1442
|
/**
|
|
1353
|
-
*
|
|
1443
|
+
* <p>The ID of the certificate object that you are deleting.</p>
|
|
1354
1444
|
*/
|
|
1355
|
-
|
|
1445
|
+
CertificateId: string | undefined;
|
|
1356
1446
|
}
|
|
1357
|
-
export interface
|
|
1447
|
+
export interface DeleteConnectorRequest {
|
|
1358
1448
|
/**
|
|
1359
|
-
* <p>
|
|
1360
|
-
* that has the user assigned to it.</p>
|
|
1449
|
+
* <p>The unique identifier for the connector.</p>
|
|
1361
1450
|
*/
|
|
1362
|
-
|
|
1451
|
+
ConnectorId: string | undefined;
|
|
1452
|
+
}
|
|
1453
|
+
export interface DeleteProfileRequest {
|
|
1363
1454
|
/**
|
|
1364
|
-
* <p>
|
|
1455
|
+
* <p>The ID of the profile that you are deleting.</p>
|
|
1365
1456
|
*/
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1457
|
+
ProfileId: string | undefined;
|
|
1458
|
+
}
|
|
1459
|
+
export interface DeleteServerRequest {
|
|
1460
|
+
/**
|
|
1461
|
+
* <p>A unique system-assigned identifier for a server instance.</p>
|
|
1369
1462
|
*/
|
|
1370
|
-
|
|
1463
|
+
ServerId: string | undefined;
|
|
1371
1464
|
}
|
|
1372
|
-
export
|
|
1465
|
+
export interface DeleteSshPublicKeyRequest {
|
|
1373
1466
|
/**
|
|
1374
|
-
*
|
|
1467
|
+
* <p>A system-assigned unique identifier for a file transfer protocol-enabled server instance
|
|
1468
|
+
* that has the user assigned to it.</p>
|
|
1469
|
+
*/
|
|
1470
|
+
ServerId: string | undefined;
|
|
1471
|
+
/**
|
|
1472
|
+
* <p>A unique identifier used to reference your user's specific SSH key.</p>
|
|
1473
|
+
*/
|
|
1474
|
+
SshPublicKeyId: string | undefined;
|
|
1475
|
+
/**
|
|
1476
|
+
* <p>A unique string that identifies a user whose public key is being deleted.</p>
|
|
1375
1477
|
*/
|
|
1376
|
-
|
|
1478
|
+
UserName: string | undefined;
|
|
1377
1479
|
}
|
|
1378
1480
|
export interface DeleteUserRequest {
|
|
1379
1481
|
/**
|
|
@@ -1386,24 +1488,12 @@ export interface DeleteUserRequest {
|
|
|
1386
1488
|
*/
|
|
1387
1489
|
UserName: string | undefined;
|
|
1388
1490
|
}
|
|
1389
|
-
export declare namespace DeleteUserRequest {
|
|
1390
|
-
/**
|
|
1391
|
-
* @internal
|
|
1392
|
-
*/
|
|
1393
|
-
const filterSensitiveLog: (obj: DeleteUserRequest) => any;
|
|
1394
|
-
}
|
|
1395
1491
|
export interface DeleteWorkflowRequest {
|
|
1396
1492
|
/**
|
|
1397
1493
|
* <p>A unique identifier for the workflow.</p>
|
|
1398
1494
|
*/
|
|
1399
1495
|
WorkflowId: string | undefined;
|
|
1400
1496
|
}
|
|
1401
|
-
export declare namespace DeleteWorkflowRequest {
|
|
1402
|
-
/**
|
|
1403
|
-
* @internal
|
|
1404
|
-
*/
|
|
1405
|
-
const filterSensitiveLog: (obj: DeleteWorkflowRequest) => any;
|
|
1406
|
-
}
|
|
1407
1497
|
export interface DescribeAccessRequest {
|
|
1408
1498
|
/**
|
|
1409
1499
|
* <p>A system-assigned unique identifier for a server that has this access assigned.</p>
|
|
@@ -1412,7 +1502,7 @@ export interface DescribeAccessRequest {
|
|
|
1412
1502
|
/**
|
|
1413
1503
|
* <p>A unique identifier that is required to identify specific groups within your directory.
|
|
1414
1504
|
* The users of the group that you associate have access to your Amazon S3 or Amazon EFS
|
|
1415
|
-
* resources over the enabled protocols using
|
|
1505
|
+
* resources over the enabled protocols using Transfer Family. If you know the group name,
|
|
1416
1506
|
* you can view the SID values by running the following command using Windows PowerShell.</p>
|
|
1417
1507
|
*
|
|
1418
1508
|
* <p>
|
|
@@ -1421,17 +1511,11 @@ export interface DescribeAccessRequest {
|
|
|
1421
1511
|
*
|
|
1422
1512
|
* <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
|
|
1423
1513
|
*
|
|
1424
|
-
* <p>The
|
|
1514
|
+
* <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
|
|
1425
1515
|
* You can also include underscores or any of the following characters: =,.@:/-</p>
|
|
1426
1516
|
*/
|
|
1427
1517
|
ExternalId: string | undefined;
|
|
1428
1518
|
}
|
|
1429
|
-
export declare namespace DescribeAccessRequest {
|
|
1430
|
-
/**
|
|
1431
|
-
* @internal
|
|
1432
|
-
*/
|
|
1433
|
-
const filterSensitiveLog: (obj: DescribeAccessRequest) => any;
|
|
1434
|
-
}
|
|
1435
1519
|
/**
|
|
1436
1520
|
* <p>Describes the properties of the access that was specified.</p>
|
|
1437
1521
|
*/
|
|
@@ -1446,9 +1530,9 @@ export interface DescribedAccess {
|
|
|
1446
1530
|
* be visible to your user and how you want to make them visible. You must specify the
|
|
1447
1531
|
* <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
|
|
1448
1532
|
* is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
|
|
1449
|
-
* only specify a target, it is displayed as is. You also must ensure that your
|
|
1450
|
-
*
|
|
1451
|
-
* can
|
|
1533
|
+
* only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM)
|
|
1534
|
+
* role provides access to paths in <code>Target</code>. This value
|
|
1535
|
+
* can be set only when <code>HomeDirectoryType</code> is set to
|
|
1452
1536
|
* <i>LOGICAL</i>.</p>
|
|
1453
1537
|
*
|
|
1454
1538
|
* <p>In most cases, you can use this value instead of the session policy to lock down the
|
|
@@ -1458,14 +1542,14 @@ export interface DescribedAccess {
|
|
|
1458
1542
|
*/
|
|
1459
1543
|
HomeDirectoryMappings?: HomeDirectoryMapEntry[];
|
|
1460
1544
|
/**
|
|
1461
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log
|
|
1462
|
-
* 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
|
|
1463
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
1464
|
-
* S3 or EFS paths visible to your users.</p>
|
|
1545
|
+
* <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
|
|
1546
|
+
* 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
|
|
1547
|
+
* protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
1548
|
+
* how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p>
|
|
1465
1549
|
*/
|
|
1466
1550
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
1467
1551
|
/**
|
|
1468
|
-
* <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
|
|
1552
|
+
* <p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's
|
|
1469
1553
|
* access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
|
|
1470
1554
|
* <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
|
|
1471
1555
|
*/
|
|
@@ -1479,16 +1563,16 @@ export interface DescribedAccess {
|
|
|
1479
1563
|
*/
|
|
1480
1564
|
PosixProfile?: PosixProfile;
|
|
1481
1565
|
/**
|
|
1482
|
-
* <p>
|
|
1483
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
1484
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust
|
|
1485
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
1566
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
|
|
1567
|
+
* bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
1568
|
+
* when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
|
|
1569
|
+
* relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
|
|
1486
1570
|
*/
|
|
1487
1571
|
Role?: string;
|
|
1488
1572
|
/**
|
|
1489
1573
|
* <p>A unique identifier that is required to identify specific groups within your directory.
|
|
1490
1574
|
* The users of the group that you associate have access to your Amazon S3 or Amazon EFS
|
|
1491
|
-
* resources over the enabled protocols using
|
|
1575
|
+
* resources over the enabled protocols using Transfer Family. If you know the group name,
|
|
1492
1576
|
* you can view the SID values by running the following command using Windows PowerShell.</p>
|
|
1493
1577
|
*
|
|
1494
1578
|
* <p>
|
|
@@ -1497,17 +1581,11 @@ export interface DescribedAccess {
|
|
|
1497
1581
|
*
|
|
1498
1582
|
* <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
|
|
1499
1583
|
*
|
|
1500
|
-
* <p>The
|
|
1584
|
+
* <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
|
|
1501
1585
|
* You can also include underscores or any of the following characters: =,.@:/-</p>
|
|
1502
1586
|
*/
|
|
1503
1587
|
ExternalId?: string;
|
|
1504
1588
|
}
|
|
1505
|
-
export declare namespace DescribedAccess {
|
|
1506
|
-
/**
|
|
1507
|
-
* @internal
|
|
1508
|
-
*/
|
|
1509
|
-
const filterSensitiveLog: (obj: DescribedAccess) => any;
|
|
1510
|
-
}
|
|
1511
1589
|
export interface DescribeAccessResponse {
|
|
1512
1590
|
/**
|
|
1513
1591
|
* <p>A system-assigned unique identifier for a server that has this access assigned.</p>
|
|
@@ -1518,14 +1596,207 @@ export interface DescribeAccessResponse {
|
|
|
1518
1596
|
*/
|
|
1519
1597
|
Access: DescribedAccess | undefined;
|
|
1520
1598
|
}
|
|
1521
|
-
export
|
|
1599
|
+
export interface DescribeAgreementRequest {
|
|
1522
1600
|
/**
|
|
1523
|
-
*
|
|
1601
|
+
* <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
|
|
1602
|
+
*/
|
|
1603
|
+
AgreementId: string | undefined;
|
|
1604
|
+
/**
|
|
1605
|
+
* <p>The server ID that's associated with the agreement.</p>
|
|
1606
|
+
*/
|
|
1607
|
+
ServerId: string | undefined;
|
|
1608
|
+
}
|
|
1609
|
+
/**
|
|
1610
|
+
* <p>Describes the properties of an agreement.</p>
|
|
1611
|
+
*/
|
|
1612
|
+
export interface DescribedAgreement {
|
|
1613
|
+
/**
|
|
1614
|
+
* <p>The unique Amazon Resource Name (ARN) for the agreement.</p>
|
|
1615
|
+
*/
|
|
1616
|
+
Arn: string | undefined;
|
|
1617
|
+
/**
|
|
1618
|
+
* <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
|
|
1619
|
+
*/
|
|
1620
|
+
AgreementId?: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* <p>The name or short description that's used to identify the agreement.</p>
|
|
1623
|
+
*/
|
|
1624
|
+
Description?: string;
|
|
1625
|
+
/**
|
|
1626
|
+
* <p>The current status of the agreement, either <code>ACTIVE</code> or
|
|
1627
|
+
* <code>INACTIVE</code>.</p>
|
|
1628
|
+
*/
|
|
1629
|
+
Status?: AgreementStatusType | string;
|
|
1630
|
+
/**
|
|
1631
|
+
* <p>A system-assigned unique identifier for a server instance. This identifier indicates the
|
|
1632
|
+
* specific server that the agreement uses.</p>
|
|
1633
|
+
*/
|
|
1634
|
+
ServerId?: string;
|
|
1635
|
+
/**
|
|
1636
|
+
* <p>A unique identifier for the AS2 process.</p>
|
|
1637
|
+
*/
|
|
1638
|
+
LocalProfileId?: string;
|
|
1639
|
+
/**
|
|
1640
|
+
* <p>A unique identifier for the partner in the agreement.</p>
|
|
1641
|
+
*/
|
|
1642
|
+
PartnerProfileId?: string;
|
|
1643
|
+
/**
|
|
1644
|
+
* <p>The landing directory (folder) for files that are transferred by using the AS2
|
|
1645
|
+
* protocol.</p>
|
|
1646
|
+
*/
|
|
1647
|
+
BaseDirectory?: string;
|
|
1648
|
+
/**
|
|
1649
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the
|
|
1650
|
+
* <code>HomeDirectory</code> of your users' Amazon S3 buckets.</p>
|
|
1651
|
+
*/
|
|
1652
|
+
AccessRole?: string;
|
|
1653
|
+
/**
|
|
1654
|
+
* <p>Key-value pairs that can be used to group and search for agreements.</p>
|
|
1655
|
+
*/
|
|
1656
|
+
Tags?: Tag[];
|
|
1657
|
+
}
|
|
1658
|
+
export interface DescribeAgreementResponse {
|
|
1659
|
+
/**
|
|
1660
|
+
* <p>The details for the specified agreement, returned as a <code>DescribedAgreement</code>
|
|
1661
|
+
* object.</p>
|
|
1662
|
+
*/
|
|
1663
|
+
Agreement: DescribedAgreement | undefined;
|
|
1664
|
+
}
|
|
1665
|
+
export interface DescribeCertificateRequest {
|
|
1666
|
+
/**
|
|
1667
|
+
* <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
|
|
1668
|
+
*/
|
|
1669
|
+
CertificateId: string | undefined;
|
|
1670
|
+
}
|
|
1671
|
+
/**
|
|
1672
|
+
* <p>Describes the properties of a certificate.</p>
|
|
1673
|
+
*/
|
|
1674
|
+
export interface DescribedCertificate {
|
|
1675
|
+
/**
|
|
1676
|
+
* <p>The unique Amazon Resource Name (ARN) for the certificate.</p>
|
|
1677
|
+
*/
|
|
1678
|
+
Arn: string | undefined;
|
|
1679
|
+
/**
|
|
1680
|
+
* <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
|
|
1681
|
+
*/
|
|
1682
|
+
CertificateId?: string;
|
|
1683
|
+
/**
|
|
1684
|
+
* <p>Specifies whether this certificate is used for signing or encryption.</p>
|
|
1685
|
+
*/
|
|
1686
|
+
Usage?: CertificateUsageType | string;
|
|
1687
|
+
/**
|
|
1688
|
+
* <p>The certificate can be either <code>ACTIVE</code>, <code>PENDING_ROTATION</code>, or
|
|
1689
|
+
* <code>INACTIVE</code>. <code>PENDING_ROTATION</code> means that this certificate will
|
|
1690
|
+
* replace the current certificate when it expires.</p>
|
|
1691
|
+
*/
|
|
1692
|
+
Status?: CertificateStatusType | string;
|
|
1693
|
+
/**
|
|
1694
|
+
* <p>The file name for the certificate.</p>
|
|
1695
|
+
*/
|
|
1696
|
+
Certificate?: string;
|
|
1697
|
+
/**
|
|
1698
|
+
* <p>The list of certificates that make up the chain for the certificate.</p>
|
|
1699
|
+
*/
|
|
1700
|
+
CertificateChain?: string;
|
|
1701
|
+
/**
|
|
1702
|
+
* <p>An optional date that specifies when the certificate becomes active.</p>
|
|
1703
|
+
*/
|
|
1704
|
+
ActiveDate?: Date;
|
|
1705
|
+
/**
|
|
1706
|
+
* <p>An optional date that specifies when the certificate becomes inactive.</p>
|
|
1707
|
+
*/
|
|
1708
|
+
InactiveDate?: Date;
|
|
1709
|
+
/**
|
|
1710
|
+
* <p>The serial number for the certificate.</p>
|
|
1711
|
+
*/
|
|
1712
|
+
Serial?: string;
|
|
1713
|
+
/**
|
|
1714
|
+
* <p>The earliest date that the certificate is valid.</p>
|
|
1715
|
+
*/
|
|
1716
|
+
NotBeforeDate?: Date;
|
|
1717
|
+
/**
|
|
1718
|
+
* <p>The final date that the certificate is
|
|
1719
|
+
* valid.</p>
|
|
1720
|
+
*/
|
|
1721
|
+
NotAfterDate?: Date;
|
|
1722
|
+
/**
|
|
1723
|
+
* <p>If a private key has been specified for the certificate, its type is <code>CERTIFICATE_WITH_PRIVATE_KEY</code>. If there is no private key, the type is <code>CERTIFICATE</code>.</p>
|
|
1724
|
+
*/
|
|
1725
|
+
Type?: CertificateType | string;
|
|
1726
|
+
/**
|
|
1727
|
+
* <p>The name or description that's used to identity the certificate. </p>
|
|
1728
|
+
*/
|
|
1729
|
+
Description?: string;
|
|
1730
|
+
/**
|
|
1731
|
+
* <p>Key-value pairs that can be used to group and search for certificates.</p>
|
|
1732
|
+
*/
|
|
1733
|
+
Tags?: Tag[];
|
|
1734
|
+
}
|
|
1735
|
+
export interface DescribeCertificateResponse {
|
|
1736
|
+
/**
|
|
1737
|
+
* <p>The details for the specified certificate, returned as an object.</p>
|
|
1738
|
+
*/
|
|
1739
|
+
Certificate: DescribedCertificate | undefined;
|
|
1740
|
+
}
|
|
1741
|
+
export interface DescribeConnectorRequest {
|
|
1742
|
+
/**
|
|
1743
|
+
* <p>The unique identifier for the connector.</p>
|
|
1744
|
+
*/
|
|
1745
|
+
ConnectorId: string | undefined;
|
|
1746
|
+
}
|
|
1747
|
+
/**
|
|
1748
|
+
* <p>Describes the parameters for the connector, as identified by the
|
|
1749
|
+
* <code>ConnectorId</code>.</p>
|
|
1750
|
+
*/
|
|
1751
|
+
export interface DescribedConnector {
|
|
1752
|
+
/**
|
|
1753
|
+
* <p>The unique Amazon Resource Name (ARN) for the connector.</p>
|
|
1754
|
+
*/
|
|
1755
|
+
Arn: string | undefined;
|
|
1756
|
+
/**
|
|
1757
|
+
* <p>The unique identifier for the connector.</p>
|
|
1758
|
+
*/
|
|
1759
|
+
ConnectorId?: string;
|
|
1760
|
+
/**
|
|
1761
|
+
* <p>The URL of the partner's AS2 endpoint.</p>
|
|
1762
|
+
*/
|
|
1763
|
+
Url?: string;
|
|
1764
|
+
/**
|
|
1765
|
+
* <p>A structure that contains the parameters for a connector object.</p>
|
|
1766
|
+
*/
|
|
1767
|
+
As2Config?: As2ConnectorConfig;
|
|
1768
|
+
/**
|
|
1769
|
+
* <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
|
|
1770
|
+
* file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
|
|
1771
|
+
* directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
|
|
1772
|
+
* directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file,
|
|
1773
|
+
* store the MDN when we receive them from the partner, and write a final JSON file containing
|
|
1774
|
+
* relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read
|
|
1775
|
+
* and write access to the parent directory of the file location used in the
|
|
1776
|
+
* <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
|
|
1777
|
+
* access to the parent directory of the files that you intend to send with
|
|
1778
|
+
* <code>StartFileTransfer</code>.</p>
|
|
1779
|
+
*/
|
|
1780
|
+
AccessRole?: string;
|
|
1781
|
+
/**
|
|
1782
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn
|
|
1783
|
+
* on CloudWatch logging for Amazon S3 events. When set, you can view connector
|
|
1784
|
+
* activity in your CloudWatch logs.</p>
|
|
1785
|
+
*/
|
|
1786
|
+
LoggingRole?: string;
|
|
1787
|
+
/**
|
|
1788
|
+
* <p>Key-value pairs that can be used to group and search for connectors.</p>
|
|
1789
|
+
*/
|
|
1790
|
+
Tags?: Tag[];
|
|
1791
|
+
}
|
|
1792
|
+
export interface DescribeConnectorResponse {
|
|
1793
|
+
/**
|
|
1794
|
+
* <p>The structure that contains the details of the connector.</p>
|
|
1524
1795
|
*/
|
|
1525
|
-
|
|
1796
|
+
Connector: DescribedConnector | undefined;
|
|
1526
1797
|
}
|
|
1527
1798
|
/**
|
|
1528
|
-
* <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>
|
|
1799
|
+
* <p>Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using S3 storage.</p>
|
|
1529
1800
|
*/
|
|
1530
1801
|
export interface S3FileLocation {
|
|
1531
1802
|
/**
|
|
@@ -1533,7 +1804,7 @@ export interface S3FileLocation {
|
|
|
1533
1804
|
*/
|
|
1534
1805
|
Bucket?: string;
|
|
1535
1806
|
/**
|
|
1536
|
-
* <p>The name assigned to the file when it was created in S3. You use the object key to retrieve the object.</p>
|
|
1807
|
+
* <p>The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.</p>
|
|
1537
1808
|
*/
|
|
1538
1809
|
Key?: string;
|
|
1539
1810
|
/**
|
|
@@ -1545,18 +1816,13 @@ export interface S3FileLocation {
|
|
|
1545
1816
|
*/
|
|
1546
1817
|
Etag?: string;
|
|
1547
1818
|
}
|
|
1548
|
-
export declare namespace S3FileLocation {
|
|
1549
|
-
/**
|
|
1550
|
-
* @internal
|
|
1551
|
-
*/
|
|
1552
|
-
const filterSensitiveLog: (obj: S3FileLocation) => any;
|
|
1553
|
-
}
|
|
1554
1819
|
/**
|
|
1555
1820
|
* <p>Specifies the Amazon S3 or EFS file details to be used in the step.</p>
|
|
1556
1821
|
*/
|
|
1557
1822
|
export interface FileLocation {
|
|
1558
1823
|
/**
|
|
1559
|
-
* <p>Specifies the S3 details for the file being used, such as bucket,
|
|
1824
|
+
* <p>Specifies the S3 details for the file being used, such as bucket, ETag, and so
|
|
1825
|
+
* forth.</p>
|
|
1560
1826
|
*/
|
|
1561
1827
|
S3FileLocation?: S3FileLocation;
|
|
1562
1828
|
/**
|
|
@@ -1564,33 +1830,21 @@ export interface FileLocation {
|
|
|
1564
1830
|
*/
|
|
1565
1831
|
EfsFileLocation?: EfsFileLocation;
|
|
1566
1832
|
}
|
|
1567
|
-
export declare namespace FileLocation {
|
|
1568
|
-
/**
|
|
1569
|
-
* @internal
|
|
1570
|
-
*/
|
|
1571
|
-
const filterSensitiveLog: (obj: FileLocation) => any;
|
|
1572
|
-
}
|
|
1573
1833
|
/**
|
|
1574
1834
|
* <p>Consists of the logging role and the log group name.</p>
|
|
1575
1835
|
*/
|
|
1576
1836
|
export interface LoggingConfiguration {
|
|
1577
1837
|
/**
|
|
1578
|
-
* <p>
|
|
1579
|
-
* on Amazon CloudWatch logging for Amazon S3 or Amazon
|
|
1838
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
|
|
1839
|
+
* on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
|
|
1580
1840
|
* your CloudWatch logs.</p>
|
|
1581
1841
|
*/
|
|
1582
1842
|
LoggingRole?: string;
|
|
1583
1843
|
/**
|
|
1584
|
-
* <p>The name of the CloudWatch logging group for the
|
|
1844
|
+
* <p>The name of the CloudWatch logging group for the Transfer Family server to which this workflow belongs.</p>
|
|
1585
1845
|
*/
|
|
1586
1846
|
LogGroupName?: string;
|
|
1587
1847
|
}
|
|
1588
|
-
export declare namespace LoggingConfiguration {
|
|
1589
|
-
/**
|
|
1590
|
-
* @internal
|
|
1591
|
-
*/
|
|
1592
|
-
const filterSensitiveLog: (obj: LoggingConfiguration) => any;
|
|
1593
|
-
}
|
|
1594
1848
|
export declare enum ExecutionErrorType {
|
|
1595
1849
|
ALREADY_EXISTS = "ALREADY_EXISTS",
|
|
1596
1850
|
BAD_REQUEST = "BAD_REQUEST",
|
|
@@ -1656,12 +1910,6 @@ export interface ExecutionError {
|
|
|
1656
1910
|
*/
|
|
1657
1911
|
Message: string | undefined;
|
|
1658
1912
|
}
|
|
1659
|
-
export declare namespace ExecutionError {
|
|
1660
|
-
/**
|
|
1661
|
-
* @internal
|
|
1662
|
-
*/
|
|
1663
|
-
const filterSensitiveLog: (obj: ExecutionError) => any;
|
|
1664
|
-
}
|
|
1665
1913
|
/**
|
|
1666
1914
|
* <p>Specifies the following details for the step: error (if any), outputs (if any), and the step type.</p>
|
|
1667
1915
|
*/
|
|
@@ -1671,19 +1919,19 @@ export interface ExecutionStepResult {
|
|
|
1671
1919
|
* <ul>
|
|
1672
1920
|
* <li>
|
|
1673
1921
|
* <p>
|
|
1674
|
-
* <i>COPY</i>:
|
|
1922
|
+
* <i>COPY</i>: Copy the file to another location.</p>
|
|
1675
1923
|
* </li>
|
|
1676
1924
|
* <li>
|
|
1677
1925
|
* <p>
|
|
1678
|
-
* <i>CUSTOM</i>: custom step with
|
|
1926
|
+
* <i>CUSTOM</i>: Perform a custom step with an Lambda function target.</p>
|
|
1679
1927
|
* </li>
|
|
1680
1928
|
* <li>
|
|
1681
1929
|
* <p>
|
|
1682
|
-
* <i>DELETE</i>:
|
|
1930
|
+
* <i>DELETE</i>: Delete the file.</p>
|
|
1683
1931
|
* </li>
|
|
1684
1932
|
* <li>
|
|
1685
1933
|
* <p>
|
|
1686
|
-
* <i>TAG</i>:
|
|
1934
|
+
* <i>TAG</i>: Add a tag to the file.</p>
|
|
1687
1935
|
* </li>
|
|
1688
1936
|
* </ul>
|
|
1689
1937
|
*/
|
|
@@ -1693,16 +1941,11 @@ export interface ExecutionStepResult {
|
|
|
1693
1941
|
*/
|
|
1694
1942
|
Outputs?: string;
|
|
1695
1943
|
/**
|
|
1696
|
-
* <p>Specifies the details for an error, if it occurred during execution of the specified
|
|
1944
|
+
* <p>Specifies the details for an error, if it occurred during execution of the specified
|
|
1945
|
+
* workflow step.</p>
|
|
1697
1946
|
*/
|
|
1698
1947
|
Error?: ExecutionError;
|
|
1699
1948
|
}
|
|
1700
|
-
export declare namespace ExecutionStepResult {
|
|
1701
|
-
/**
|
|
1702
|
-
* @internal
|
|
1703
|
-
*/
|
|
1704
|
-
const filterSensitiveLog: (obj: ExecutionStepResult) => any;
|
|
1705
|
-
}
|
|
1706
1949
|
/**
|
|
1707
1950
|
* <p>Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.</p>
|
|
1708
1951
|
*/
|
|
@@ -1716,12 +1959,6 @@ export interface ExecutionResults {
|
|
|
1716
1959
|
*/
|
|
1717
1960
|
OnExceptionSteps?: ExecutionStepResult[];
|
|
1718
1961
|
}
|
|
1719
|
-
export declare namespace ExecutionResults {
|
|
1720
|
-
/**
|
|
1721
|
-
* @internal
|
|
1722
|
-
*/
|
|
1723
|
-
const filterSensitiveLog: (obj: ExecutionResults) => any;
|
|
1724
|
-
}
|
|
1725
1962
|
/**
|
|
1726
1963
|
* <p>Specifies the user name, server ID, and session ID for a workflow.</p>
|
|
1727
1964
|
*/
|
|
@@ -1739,14 +1976,8 @@ export interface UserDetails {
|
|
|
1739
1976
|
*/
|
|
1740
1977
|
SessionId?: string;
|
|
1741
1978
|
}
|
|
1742
|
-
export declare namespace UserDetails {
|
|
1743
|
-
/**
|
|
1744
|
-
* @internal
|
|
1745
|
-
*/
|
|
1746
|
-
const filterSensitiveLog: (obj: UserDetails) => any;
|
|
1747
|
-
}
|
|
1748
1979
|
/**
|
|
1749
|
-
* <p>A container object for the session details associated with a workflow.</p>
|
|
1980
|
+
* <p>A container object for the session details that are associated with a workflow.</p>
|
|
1750
1981
|
*/
|
|
1751
1982
|
export interface ServiceMetadata {
|
|
1752
1983
|
/**
|
|
@@ -1754,12 +1985,6 @@ export interface ServiceMetadata {
|
|
|
1754
1985
|
*/
|
|
1755
1986
|
UserDetails: UserDetails | undefined;
|
|
1756
1987
|
}
|
|
1757
|
-
export declare namespace ServiceMetadata {
|
|
1758
|
-
/**
|
|
1759
|
-
* @internal
|
|
1760
|
-
*/
|
|
1761
|
-
const filterSensitiveLog: (obj: ServiceMetadata) => any;
|
|
1762
|
-
}
|
|
1763
1988
|
export declare enum ExecutionStatus {
|
|
1764
1989
|
COMPLETED = "COMPLETED",
|
|
1765
1990
|
EXCEPTION = "EXCEPTION",
|
|
@@ -1781,7 +2006,7 @@ export interface DescribedExecution {
|
|
|
1781
2006
|
*/
|
|
1782
2007
|
InitialFileLocation?: FileLocation;
|
|
1783
2008
|
/**
|
|
1784
|
-
* <p>A container object for the session details associated with a workflow.</p>
|
|
2009
|
+
* <p>A container object for the session details that are associated with a workflow.</p>
|
|
1785
2010
|
*/
|
|
1786
2011
|
ServiceMetadata?: ServiceMetadata;
|
|
1787
2012
|
/**
|
|
@@ -1811,11 +2036,36 @@ export interface DescribedExecution {
|
|
|
1811
2036
|
*/
|
|
1812
2037
|
Results?: ExecutionResults;
|
|
1813
2038
|
}
|
|
1814
|
-
|
|
2039
|
+
/**
|
|
2040
|
+
* <p>The details for a local or partner AS2 profile.
|
|
2041
|
+
* profile.</p>
|
|
2042
|
+
*/
|
|
2043
|
+
export interface DescribedProfile {
|
|
1815
2044
|
/**
|
|
1816
|
-
*
|
|
2045
|
+
* <p>The unique Amazon Resource Name (ARN) for the profile.</p>
|
|
2046
|
+
*/
|
|
2047
|
+
Arn: string | undefined;
|
|
2048
|
+
/**
|
|
2049
|
+
* <p>A unique identifier for the local or partner AS2 profile.</p>
|
|
1817
2050
|
*/
|
|
1818
|
-
|
|
2051
|
+
ProfileId?: string;
|
|
2052
|
+
/**
|
|
2053
|
+
* <p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles.
|
|
2054
|
+
* If not supplied in the request, the command lists all types of profiles.</p>
|
|
2055
|
+
*/
|
|
2056
|
+
ProfileType?: ProfileType | string;
|
|
2057
|
+
/**
|
|
2058
|
+
* <p>The unique identifier for the AS2 process.</p>
|
|
2059
|
+
*/
|
|
2060
|
+
As2Id?: string;
|
|
2061
|
+
/**
|
|
2062
|
+
* <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
|
|
2063
|
+
*/
|
|
2064
|
+
CertificateIds?: string[];
|
|
2065
|
+
/**
|
|
2066
|
+
* <p>Key-value pairs that can be used to group and search for profiles.</p>
|
|
2067
|
+
*/
|
|
2068
|
+
Tags?: Tag[];
|
|
1819
2069
|
}
|
|
1820
2070
|
/**
|
|
1821
2071
|
* <p>Describes the properties of a security policy that was specified. For more information
|
|
@@ -1853,12 +2103,6 @@ export interface DescribedSecurityPolicy {
|
|
|
1853
2103
|
*/
|
|
1854
2104
|
TlsCiphers?: string[];
|
|
1855
2105
|
}
|
|
1856
|
-
export declare namespace DescribedSecurityPolicy {
|
|
1857
|
-
/**
|
|
1858
|
-
* @internal
|
|
1859
|
-
*/
|
|
1860
|
-
const filterSensitiveLog: (obj: DescribedSecurityPolicy) => any;
|
|
1861
|
-
}
|
|
1862
2106
|
export declare enum State {
|
|
1863
2107
|
OFFLINE = "OFFLINE",
|
|
1864
2108
|
ONLINE = "ONLINE",
|
|
@@ -1897,8 +2141,8 @@ export interface DescribedServer {
|
|
|
1897
2141
|
Domain?: Domain | string;
|
|
1898
2142
|
/**
|
|
1899
2143
|
* <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
|
1900
|
-
* When you host your endpoint within your VPC, you can make
|
|
1901
|
-
* within your VPC, or you can attach Elastic IP addresses and make
|
|
2144
|
+
* When you host your endpoint within your VPC, you can make your endpoint accessible only to resources
|
|
2145
|
+
* within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over
|
|
1902
2146
|
* the internet. Your VPC's default security groups are automatically assigned to your
|
|
1903
2147
|
* endpoint.</p>
|
|
1904
2148
|
*/
|
|
@@ -1921,36 +2165,38 @@ export interface DescribedServer {
|
|
|
1921
2165
|
*/
|
|
1922
2166
|
IdentityProviderDetails?: IdentityProviderDetails;
|
|
1923
2167
|
/**
|
|
1924
|
-
* <p>
|
|
2168
|
+
* <p>The mode of authentication for a server. The default value is
|
|
1925
2169
|
* <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
|
|
1926
|
-
* the
|
|
2170
|
+
* the Transfer Family service.</p>
|
|
1927
2171
|
* <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to
|
|
1928
|
-
* Active Directory groups in
|
|
1929
|
-
* on-premises environment or in Amazon Web Services using AD
|
|
1930
|
-
* provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
2172
|
+
* Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your
|
|
2173
|
+
* on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to
|
|
2174
|
+
* provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
1931
2175
|
* <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The
|
|
1932
|
-
* <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call
|
|
1933
|
-
* for authentication using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
1934
|
-
* <p>Use the <code>AWS_LAMBDA</code> value to directly use
|
|
1935
|
-
* you must specify the ARN for the
|
|
2176
|
+
* <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call
|
|
2177
|
+
* for authentication by using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
2178
|
+
* <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider.
|
|
2179
|
+
* If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter
|
|
2180
|
+
* or the <code>IdentityProviderDetails</code> data type.</p>
|
|
1936
2181
|
*/
|
|
1937
2182
|
IdentityProviderType?: IdentityProviderType | string;
|
|
1938
2183
|
/**
|
|
1939
|
-
* <p>
|
|
1940
|
-
* on Amazon CloudWatch logging for Amazon S3 or Amazon
|
|
2184
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
|
|
2185
|
+
* on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
|
|
1941
2186
|
* your CloudWatch logs.</p>
|
|
1942
2187
|
*/
|
|
1943
2188
|
LoggingRole?: string;
|
|
1944
2189
|
/**
|
|
1945
|
-
* <p>
|
|
2190
|
+
* <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p>
|
|
1946
2191
|
* <note>
|
|
1947
2192
|
* <p>The SFTP protocol does not support post-authentication display banners.</p>
|
|
1948
2193
|
* </note>
|
|
1949
2194
|
*/
|
|
1950
2195
|
PostAuthenticationLoginBanner?: string;
|
|
1951
2196
|
/**
|
|
1952
|
-
* <p>
|
|
1953
|
-
* For example, the following banner displays details about using the system
|
|
2197
|
+
* <p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.
|
|
2198
|
+
* For example, the following banner displays details about using the system:</p>
|
|
2199
|
+
*
|
|
1954
2200
|
* <p>
|
|
1955
2201
|
* <code>This system is for the use of authorized users only. Individuals using this computer system without authority,
|
|
1956
2202
|
* or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by
|
|
@@ -1989,7 +2235,7 @@ export interface DescribedServer {
|
|
|
1989
2235
|
*/
|
|
1990
2236
|
ServerId?: string;
|
|
1991
2237
|
/**
|
|
1992
|
-
* <p>
|
|
2238
|
+
* <p>The condition of the server that was described. A value of
|
|
1993
2239
|
* <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A
|
|
1994
2240
|
* <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file
|
|
1995
2241
|
* transfer operations.</p>
|
|
@@ -2011,16 +2257,10 @@ export interface DescribedServer {
|
|
|
2011
2257
|
*/
|
|
2012
2258
|
UserCount?: number;
|
|
2013
2259
|
/**
|
|
2014
|
-
* <p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>
|
|
2260
|
+
* <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
|
|
2015
2261
|
*/
|
|
2016
2262
|
WorkflowDetails?: WorkflowDetails;
|
|
2017
2263
|
}
|
|
2018
|
-
export declare namespace DescribedServer {
|
|
2019
|
-
/**
|
|
2020
|
-
* @internal
|
|
2021
|
-
*/
|
|
2022
|
-
const filterSensitiveLog: (obj: DescribedServer) => any;
|
|
2023
|
-
}
|
|
2024
2264
|
/**
|
|
2025
2265
|
* <p>Provides information about the public Secure Shell (SSH) key that is associated with a
|
|
2026
2266
|
* user account for the specific file transfer protocol-enabled server (as identified by
|
|
@@ -2045,12 +2285,6 @@ export interface SshPublicKey {
|
|
|
2045
2285
|
*/
|
|
2046
2286
|
SshPublicKeyId: string | undefined;
|
|
2047
2287
|
}
|
|
2048
|
-
export declare namespace SshPublicKey {
|
|
2049
|
-
/**
|
|
2050
|
-
* @internal
|
|
2051
|
-
*/
|
|
2052
|
-
const filterSensitiveLog: (obj: SshPublicKey) => any;
|
|
2053
|
-
}
|
|
2054
2288
|
/**
|
|
2055
2289
|
* <p>Describes the properties of a user that was specified.</p>
|
|
2056
2290
|
*/
|
|
@@ -2070,9 +2304,9 @@ export interface DescribedUser {
|
|
|
2070
2304
|
* be visible to your user and how you want to make them visible. You must specify the
|
|
2071
2305
|
* <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
|
|
2072
2306
|
* is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
|
|
2073
|
-
* only specify a target, it is displayed as is. You also must ensure that your
|
|
2074
|
-
*
|
|
2075
|
-
* can
|
|
2307
|
+
* only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM)
|
|
2308
|
+
* role provides access to paths in <code>Target</code>. This value
|
|
2309
|
+
* can be set only when <code>HomeDirectoryType</code> is set to
|
|
2076
2310
|
* <i>LOGICAL</i>.</p>
|
|
2077
2311
|
*
|
|
2078
2312
|
* <p>In most cases, you can use this value instead of the session policy to lock your user
|
|
@@ -2082,14 +2316,14 @@ export interface DescribedUser {
|
|
|
2082
2316
|
*/
|
|
2083
2317
|
HomeDirectoryMappings?: HomeDirectoryMapEntry[];
|
|
2084
2318
|
/**
|
|
2085
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log
|
|
2086
|
-
* 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
|
|
2087
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
2088
|
-
* S3 or EFS paths visible to your users.</p>
|
|
2319
|
+
* <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
|
|
2320
|
+
* 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
|
|
2321
|
+
* protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
2322
|
+
* how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p>
|
|
2089
2323
|
*/
|
|
2090
2324
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
2091
2325
|
/**
|
|
2092
|
-
* <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
|
|
2326
|
+
* <p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's
|
|
2093
2327
|
* access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
|
|
2094
2328
|
* <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
|
|
2095
2329
|
*/
|
|
@@ -2104,10 +2338,10 @@ export interface DescribedUser {
|
|
|
2104
2338
|
*/
|
|
2105
2339
|
PosixProfile?: PosixProfile;
|
|
2106
2340
|
/**
|
|
2107
|
-
* <p>
|
|
2108
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
2109
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust
|
|
2110
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
2341
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
|
|
2342
|
+
* bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
2343
|
+
* when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
|
|
2344
|
+
* relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
|
|
2111
2345
|
*/
|
|
2112
2346
|
Role?: string;
|
|
2113
2347
|
/**
|
|
@@ -2127,12 +2361,6 @@ export interface DescribedUser {
|
|
|
2127
2361
|
*/
|
|
2128
2362
|
UserName?: string;
|
|
2129
2363
|
}
|
|
2130
|
-
export declare namespace DescribedUser {
|
|
2131
|
-
/**
|
|
2132
|
-
* @internal
|
|
2133
|
-
*/
|
|
2134
|
-
const filterSensitiveLog: (obj: DescribedUser) => any;
|
|
2135
|
-
}
|
|
2136
2364
|
/**
|
|
2137
2365
|
* <p>Describes the properties of the specified workflow</p>
|
|
2138
2366
|
*/
|
|
@@ -2162,12 +2390,6 @@ export interface DescribedWorkflow {
|
|
|
2162
2390
|
*/
|
|
2163
2391
|
Tags?: Tag[];
|
|
2164
2392
|
}
|
|
2165
|
-
export declare namespace DescribedWorkflow {
|
|
2166
|
-
/**
|
|
2167
|
-
* @internal
|
|
2168
|
-
*/
|
|
2169
|
-
const filterSensitiveLog: (obj: DescribedWorkflow) => any;
|
|
2170
|
-
}
|
|
2171
2393
|
export interface DescribeExecutionRequest {
|
|
2172
2394
|
/**
|
|
2173
2395
|
* <p>A unique identifier for the execution of a workflow.</p>
|
|
@@ -2178,12 +2400,6 @@ export interface DescribeExecutionRequest {
|
|
|
2178
2400
|
*/
|
|
2179
2401
|
WorkflowId: string | undefined;
|
|
2180
2402
|
}
|
|
2181
|
-
export declare namespace DescribeExecutionRequest {
|
|
2182
|
-
/**
|
|
2183
|
-
* @internal
|
|
2184
|
-
*/
|
|
2185
|
-
const filterSensitiveLog: (obj: DescribeExecutionRequest) => any;
|
|
2186
|
-
}
|
|
2187
2403
|
export interface DescribeExecutionResponse {
|
|
2188
2404
|
/**
|
|
2189
2405
|
* <p>A unique identifier for the workflow.</p>
|
|
@@ -2194,23 +2410,23 @@ export interface DescribeExecutionResponse {
|
|
|
2194
2410
|
*/
|
|
2195
2411
|
Execution: DescribedExecution | undefined;
|
|
2196
2412
|
}
|
|
2197
|
-
export
|
|
2413
|
+
export interface DescribeProfileRequest {
|
|
2198
2414
|
/**
|
|
2199
|
-
*
|
|
2415
|
+
* <p>The identifier of the profile that you want described.</p>
|
|
2200
2416
|
*/
|
|
2201
|
-
|
|
2417
|
+
ProfileId: string | undefined;
|
|
2202
2418
|
}
|
|
2203
|
-
export interface
|
|
2419
|
+
export interface DescribeProfileResponse {
|
|
2204
2420
|
/**
|
|
2205
|
-
* <p>
|
|
2421
|
+
* <p>The details of the specified profile, returned as an object.</p>
|
|
2206
2422
|
*/
|
|
2207
|
-
|
|
2423
|
+
Profile: DescribedProfile | undefined;
|
|
2208
2424
|
}
|
|
2209
|
-
export
|
|
2425
|
+
export interface DescribeSecurityPolicyRequest {
|
|
2210
2426
|
/**
|
|
2211
|
-
*
|
|
2427
|
+
* <p>Specifies the name of the security policy that is attached to the server.</p>
|
|
2212
2428
|
*/
|
|
2213
|
-
|
|
2429
|
+
SecurityPolicyName: string | undefined;
|
|
2214
2430
|
}
|
|
2215
2431
|
export interface DescribeSecurityPolicyResponse {
|
|
2216
2432
|
/**
|
|
@@ -2218,24 +2434,12 @@ export interface DescribeSecurityPolicyResponse {
|
|
|
2218
2434
|
*/
|
|
2219
2435
|
SecurityPolicy: DescribedSecurityPolicy | undefined;
|
|
2220
2436
|
}
|
|
2221
|
-
export declare namespace DescribeSecurityPolicyResponse {
|
|
2222
|
-
/**
|
|
2223
|
-
* @internal
|
|
2224
|
-
*/
|
|
2225
|
-
const filterSensitiveLog: (obj: DescribeSecurityPolicyResponse) => any;
|
|
2226
|
-
}
|
|
2227
2437
|
export interface DescribeServerRequest {
|
|
2228
2438
|
/**
|
|
2229
2439
|
* <p>A system-assigned unique identifier for a server.</p>
|
|
2230
2440
|
*/
|
|
2231
2441
|
ServerId: string | undefined;
|
|
2232
2442
|
}
|
|
2233
|
-
export declare namespace DescribeServerRequest {
|
|
2234
|
-
/**
|
|
2235
|
-
* @internal
|
|
2236
|
-
*/
|
|
2237
|
-
const filterSensitiveLog: (obj: DescribeServerRequest) => any;
|
|
2238
|
-
}
|
|
2239
2443
|
export interface DescribeServerResponse {
|
|
2240
2444
|
/**
|
|
2241
2445
|
* <p>An array containing the properties of a server with the <code>ServerID</code> you
|
|
@@ -2243,12 +2447,6 @@ export interface DescribeServerResponse {
|
|
|
2243
2447
|
*/
|
|
2244
2448
|
Server: DescribedServer | undefined;
|
|
2245
2449
|
}
|
|
2246
|
-
export declare namespace DescribeServerResponse {
|
|
2247
|
-
/**
|
|
2248
|
-
* @internal
|
|
2249
|
-
*/
|
|
2250
|
-
const filterSensitiveLog: (obj: DescribeServerResponse) => any;
|
|
2251
|
-
}
|
|
2252
2450
|
export interface DescribeUserRequest {
|
|
2253
2451
|
/**
|
|
2254
2452
|
* <p>A system-assigned unique identifier for a server that has this user assigned.</p>
|
|
@@ -2256,16 +2454,10 @@ export interface DescribeUserRequest {
|
|
|
2256
2454
|
ServerId: string | undefined;
|
|
2257
2455
|
/**
|
|
2258
2456
|
* <p>The name of the user assigned to one or more servers. User names are part of the sign-in
|
|
2259
|
-
* credentials to use the
|
|
2457
|
+
* credentials to use the Transfer Family service and perform file transfer tasks.</p>
|
|
2260
2458
|
*/
|
|
2261
2459
|
UserName: string | undefined;
|
|
2262
2460
|
}
|
|
2263
|
-
export declare namespace DescribeUserRequest {
|
|
2264
|
-
/**
|
|
2265
|
-
* @internal
|
|
2266
|
-
*/
|
|
2267
|
-
const filterSensitiveLog: (obj: DescribeUserRequest) => any;
|
|
2268
|
-
}
|
|
2269
2461
|
export interface DescribeUserResponse {
|
|
2270
2462
|
/**
|
|
2271
2463
|
* <p>A system-assigned unique identifier for a server that has this user assigned.</p>
|
|
@@ -2277,58 +2469,75 @@ export interface DescribeUserResponse {
|
|
|
2277
2469
|
*/
|
|
2278
2470
|
User: DescribedUser | undefined;
|
|
2279
2471
|
}
|
|
2280
|
-
export declare namespace DescribeUserResponse {
|
|
2281
|
-
/**
|
|
2282
|
-
* @internal
|
|
2283
|
-
*/
|
|
2284
|
-
const filterSensitiveLog: (obj: DescribeUserResponse) => any;
|
|
2285
|
-
}
|
|
2286
2472
|
export interface DescribeWorkflowRequest {
|
|
2287
2473
|
/**
|
|
2288
2474
|
* <p>A unique identifier for the workflow.</p>
|
|
2289
2475
|
*/
|
|
2290
2476
|
WorkflowId: string | undefined;
|
|
2291
2477
|
}
|
|
2292
|
-
export declare namespace DescribeWorkflowRequest {
|
|
2293
|
-
/**
|
|
2294
|
-
* @internal
|
|
2295
|
-
*/
|
|
2296
|
-
const filterSensitiveLog: (obj: DescribeWorkflowRequest) => any;
|
|
2297
|
-
}
|
|
2298
2478
|
export interface DescribeWorkflowResponse {
|
|
2299
2479
|
/**
|
|
2300
2480
|
* <p>The structure that contains the details of the workflow.</p>
|
|
2301
2481
|
*/
|
|
2302
2482
|
Workflow: DescribedWorkflow | undefined;
|
|
2303
2483
|
}
|
|
2304
|
-
export
|
|
2484
|
+
export interface ImportCertificateRequest {
|
|
2305
2485
|
/**
|
|
2306
|
-
*
|
|
2486
|
+
* <p>Specifies whether this certificate is used for signing or encryption.</p>
|
|
2307
2487
|
*/
|
|
2308
|
-
|
|
2309
|
-
}
|
|
2310
|
-
export interface ImportSshPublicKeyRequest {
|
|
2488
|
+
Usage: CertificateUsageType | string | undefined;
|
|
2311
2489
|
/**
|
|
2312
|
-
* <p>
|
|
2490
|
+
* <p>The file that contains the certificate to import.</p>
|
|
2313
2491
|
*/
|
|
2314
|
-
|
|
2492
|
+
Certificate: string | undefined;
|
|
2315
2493
|
/**
|
|
2316
|
-
* <p>
|
|
2317
|
-
*
|
|
2494
|
+
* <p>An optional list of certificates that make up the chain for the certificate that's being
|
|
2495
|
+
* imported.</p>
|
|
2318
2496
|
*/
|
|
2319
|
-
|
|
2497
|
+
CertificateChain?: string;
|
|
2320
2498
|
/**
|
|
2321
|
-
* <p>The
|
|
2499
|
+
* <p>The file that contains the private key for the certificate that's being imported.</p>
|
|
2322
2500
|
*/
|
|
2323
|
-
|
|
2324
|
-
}
|
|
2325
|
-
export declare namespace ImportSshPublicKeyRequest {
|
|
2501
|
+
PrivateKey?: string;
|
|
2326
2502
|
/**
|
|
2327
|
-
*
|
|
2503
|
+
* <p>An optional date that specifies when the certificate becomes active.</p>
|
|
2328
2504
|
*/
|
|
2329
|
-
|
|
2330
|
-
|
|
2331
|
-
|
|
2505
|
+
ActiveDate?: Date;
|
|
2506
|
+
/**
|
|
2507
|
+
* <p>An optional date that specifies when the certificate becomes inactive.</p>
|
|
2508
|
+
*/
|
|
2509
|
+
InactiveDate?: Date;
|
|
2510
|
+
/**
|
|
2511
|
+
* <p>A short description that helps identify the certificate. </p>
|
|
2512
|
+
*/
|
|
2513
|
+
Description?: string;
|
|
2514
|
+
/**
|
|
2515
|
+
* <p>Key-value pairs that can be used to group and search for certificates.</p>
|
|
2516
|
+
*/
|
|
2517
|
+
Tags?: Tag[];
|
|
2518
|
+
}
|
|
2519
|
+
export interface ImportCertificateResponse {
|
|
2520
|
+
/**
|
|
2521
|
+
* <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
|
|
2522
|
+
*/
|
|
2523
|
+
CertificateId: string | undefined;
|
|
2524
|
+
}
|
|
2525
|
+
export interface ImportSshPublicKeyRequest {
|
|
2526
|
+
/**
|
|
2527
|
+
* <p>A system-assigned unique identifier for a server.</p>
|
|
2528
|
+
*/
|
|
2529
|
+
ServerId: string | undefined;
|
|
2530
|
+
/**
|
|
2531
|
+
* <p>The public key portion of an SSH key pair.</p>
|
|
2532
|
+
* <p>Transfer Family accepts RSA, ECDSA, and ED25519 keys.</p>
|
|
2533
|
+
*/
|
|
2534
|
+
SshPublicKeyBody: string | undefined;
|
|
2535
|
+
/**
|
|
2536
|
+
* <p>The name of the user account that is assigned to one or more servers.</p>
|
|
2537
|
+
*/
|
|
2538
|
+
UserName: string | undefined;
|
|
2539
|
+
}
|
|
2540
|
+
/**
|
|
2332
2541
|
* <p>Identifies the user, the server they belong to, and the identifier of the SSH public key
|
|
2333
2542
|
* associated with that user. A user can have more than one key on each server that they are
|
|
2334
2543
|
* associated with.</p>
|
|
@@ -2347,12 +2556,6 @@ export interface ImportSshPublicKeyResponse {
|
|
|
2347
2556
|
*/
|
|
2348
2557
|
UserName: string | undefined;
|
|
2349
2558
|
}
|
|
2350
|
-
export declare namespace ImportSshPublicKeyResponse {
|
|
2351
|
-
/**
|
|
2352
|
-
* @internal
|
|
2353
|
-
*/
|
|
2354
|
-
const filterSensitiveLog: (obj: ImportSshPublicKeyResponse) => any;
|
|
2355
|
-
}
|
|
2356
2559
|
/**
|
|
2357
2560
|
* <p>The <code>NextToken</code> parameter that was passed is invalid.</p>
|
|
2358
2561
|
*/
|
|
@@ -2382,12 +2585,6 @@ export interface ListAccessesRequest {
|
|
|
2382
2585
|
*/
|
|
2383
2586
|
ServerId: string | undefined;
|
|
2384
2587
|
}
|
|
2385
|
-
export declare namespace ListAccessesRequest {
|
|
2386
|
-
/**
|
|
2387
|
-
* @internal
|
|
2388
|
-
*/
|
|
2389
|
-
const filterSensitiveLog: (obj: ListAccessesRequest) => any;
|
|
2390
|
-
}
|
|
2391
2588
|
/**
|
|
2392
2589
|
* <p>Lists the properties for one or more specified associated accesses.</p>
|
|
2393
2590
|
*/
|
|
@@ -2398,23 +2595,23 @@ export interface ListedAccess {
|
|
|
2398
2595
|
*/
|
|
2399
2596
|
HomeDirectory?: string;
|
|
2400
2597
|
/**
|
|
2401
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log
|
|
2402
|
-
* 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
|
|
2403
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
2404
|
-
* S3 or EFS paths visible to your users.</p>
|
|
2598
|
+
* <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
|
|
2599
|
+
* 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
|
|
2600
|
+
* protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
2601
|
+
* how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p>
|
|
2405
2602
|
*/
|
|
2406
2603
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
2407
2604
|
/**
|
|
2408
|
-
* <p>
|
|
2409
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
2410
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust
|
|
2411
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
2605
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
|
|
2606
|
+
* bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
2607
|
+
* when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
|
|
2608
|
+
* relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
|
|
2412
2609
|
*/
|
|
2413
2610
|
Role?: string;
|
|
2414
2611
|
/**
|
|
2415
2612
|
* <p>A unique identifier that is required to identify specific groups within your directory.
|
|
2416
2613
|
* The users of the group that you associate have access to your Amazon S3 or Amazon EFS
|
|
2417
|
-
* resources over the enabled protocols using
|
|
2614
|
+
* resources over the enabled protocols using Transfer Family. If you know the group name,
|
|
2418
2615
|
* you can view the SID values by running the following command using Windows PowerShell.</p>
|
|
2419
2616
|
*
|
|
2420
2617
|
* <p>
|
|
@@ -2423,17 +2620,11 @@ export interface ListedAccess {
|
|
|
2423
2620
|
*
|
|
2424
2621
|
* <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
|
|
2425
2622
|
*
|
|
2426
|
-
* <p>The
|
|
2623
|
+
* <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
|
|
2427
2624
|
* You can also include underscores or any of the following characters: =,.@:/-</p>
|
|
2428
2625
|
*/
|
|
2429
2626
|
ExternalId?: string;
|
|
2430
2627
|
}
|
|
2431
|
-
export declare namespace ListedAccess {
|
|
2432
|
-
/**
|
|
2433
|
-
* @internal
|
|
2434
|
-
*/
|
|
2435
|
-
const filterSensitiveLog: (obj: ListedAccess) => any;
|
|
2436
|
-
}
|
|
2437
2628
|
export interface ListAccessesResponse {
|
|
2438
2629
|
/**
|
|
2439
2630
|
* <p>When you can get additional results from the <code>ListAccesses</code> call, a
|
|
@@ -2452,11 +2643,173 @@ export interface ListAccessesResponse {
|
|
|
2452
2643
|
*/
|
|
2453
2644
|
Accesses: ListedAccess[] | undefined;
|
|
2454
2645
|
}
|
|
2455
|
-
export
|
|
2646
|
+
export interface ListAgreementsRequest {
|
|
2456
2647
|
/**
|
|
2457
|
-
*
|
|
2648
|
+
* <p>The maximum number of agreements to return.</p>
|
|
2649
|
+
*/
|
|
2650
|
+
MaxResults?: number;
|
|
2651
|
+
/**
|
|
2652
|
+
* <p>When you can get additional results from the <code>ListAgreements</code> call, a
|
|
2653
|
+
* <code>NextToken</code> parameter is returned in the output. You can then pass in a
|
|
2654
|
+
* subsequent command to the <code>NextToken</code> parameter to continue listing additional
|
|
2655
|
+
* agreements.</p>
|
|
2656
|
+
*/
|
|
2657
|
+
NextToken?: string;
|
|
2658
|
+
/**
|
|
2659
|
+
* <p>The identifier of the server for which you want a list of agreements.</p>
|
|
2660
|
+
*/
|
|
2661
|
+
ServerId: string | undefined;
|
|
2662
|
+
}
|
|
2663
|
+
/**
|
|
2664
|
+
* <p>Describes the properties of an agreement.</p>
|
|
2665
|
+
*/
|
|
2666
|
+
export interface ListedAgreement {
|
|
2667
|
+
/**
|
|
2668
|
+
* <p>The Amazon Resource Name (ARN) of the specified agreement.</p>
|
|
2669
|
+
*/
|
|
2670
|
+
Arn?: string;
|
|
2671
|
+
/**
|
|
2672
|
+
* <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
|
|
2673
|
+
*/
|
|
2674
|
+
AgreementId?: string;
|
|
2675
|
+
/**
|
|
2676
|
+
* <p>The current description for the agreement. You can change it by calling the
|
|
2677
|
+
* <code>UpdateAgreement</code> operation and providing a new description. </p>
|
|
2678
|
+
*/
|
|
2679
|
+
Description?: string;
|
|
2680
|
+
/**
|
|
2681
|
+
* <p>The agreement can be either <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
|
|
2682
|
+
*/
|
|
2683
|
+
Status?: AgreementStatusType | string;
|
|
2684
|
+
/**
|
|
2685
|
+
* <p>The unique identifier for the agreement.</p>
|
|
2686
|
+
*/
|
|
2687
|
+
ServerId?: string;
|
|
2688
|
+
/**
|
|
2689
|
+
* <p>A unique identifier for the AS2 process.</p>
|
|
2690
|
+
*/
|
|
2691
|
+
LocalProfileId?: string;
|
|
2692
|
+
/**
|
|
2693
|
+
* <p>A unique identifier for the partner process.</p>
|
|
2694
|
+
*/
|
|
2695
|
+
PartnerProfileId?: string;
|
|
2696
|
+
}
|
|
2697
|
+
export interface ListAgreementsResponse {
|
|
2698
|
+
/**
|
|
2699
|
+
* <p>Returns a token that you can use to call <code>ListAgreements</code> again and receive
|
|
2700
|
+
* additional results, if there are any.</p>
|
|
2701
|
+
*/
|
|
2702
|
+
NextToken?: string;
|
|
2703
|
+
/**
|
|
2704
|
+
* <p>Returns an array, where each item contains the details of an agreement.</p>
|
|
2705
|
+
*/
|
|
2706
|
+
Agreements: ListedAgreement[] | undefined;
|
|
2707
|
+
}
|
|
2708
|
+
export interface ListCertificatesRequest {
|
|
2709
|
+
/**
|
|
2710
|
+
* <p>The maximum number of certificates to return.</p>
|
|
2711
|
+
*/
|
|
2712
|
+
MaxResults?: number;
|
|
2713
|
+
/**
|
|
2714
|
+
* <p>When you can get additional results from the <code>ListCertificates</code> call, a
|
|
2715
|
+
* <code>NextToken</code> parameter is returned in the output. You can then pass in a
|
|
2716
|
+
* subsequent command to the <code>NextToken</code> parameter to continue listing additional
|
|
2717
|
+
* certificates.</p>
|
|
2718
|
+
*/
|
|
2719
|
+
NextToken?: string;
|
|
2720
|
+
}
|
|
2721
|
+
/**
|
|
2722
|
+
* <p>Describes the properties of a certificate.</p>
|
|
2723
|
+
*/
|
|
2724
|
+
export interface ListedCertificate {
|
|
2725
|
+
/**
|
|
2726
|
+
* <p>The Amazon Resource Name (ARN) of the specified certificate.</p>
|
|
2727
|
+
*/
|
|
2728
|
+
Arn?: string;
|
|
2729
|
+
/**
|
|
2730
|
+
* <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
|
|
2731
|
+
*/
|
|
2732
|
+
CertificateId?: string;
|
|
2733
|
+
/**
|
|
2734
|
+
* <p>Specifies whether this certificate is used for signing or encryption.</p>
|
|
2735
|
+
*/
|
|
2736
|
+
Usage?: CertificateUsageType | string;
|
|
2737
|
+
/**
|
|
2738
|
+
* <p>The certificate can be either <code>ACTIVE</code>, <code>PENDING_ROTATION</code>, or
|
|
2739
|
+
* <code>INACTIVE</code>. <code>PENDING_ROTATION</code> means that this certificate will
|
|
2740
|
+
* replace the current certificate when it expires.</p>
|
|
2741
|
+
*/
|
|
2742
|
+
Status?: CertificateStatusType | string;
|
|
2743
|
+
/**
|
|
2744
|
+
* <p>An optional date that specifies when the certificate becomes active.</p>
|
|
2745
|
+
*/
|
|
2746
|
+
ActiveDate?: Date;
|
|
2747
|
+
/**
|
|
2748
|
+
* <p>An optional date that specifies when the certificate becomes inactive.</p>
|
|
2749
|
+
*/
|
|
2750
|
+
InactiveDate?: Date;
|
|
2751
|
+
/**
|
|
2752
|
+
* <p>The type for the certificate. If a private key has been specified for the certificate, its
|
|
2753
|
+
* type is <code>CERTIFICATE_WITH_PRIVATE_KEY</code>. If there is no private key, the type is
|
|
2754
|
+
* <code>CERTIFICATE</code>.</p>
|
|
2755
|
+
*/
|
|
2756
|
+
Type?: CertificateType | string;
|
|
2757
|
+
/**
|
|
2758
|
+
* <p>The name or short description that's used to identify the certificate.</p>
|
|
2759
|
+
*/
|
|
2760
|
+
Description?: string;
|
|
2761
|
+
}
|
|
2762
|
+
export interface ListCertificatesResponse {
|
|
2763
|
+
/**
|
|
2764
|
+
* <p>Returns the next token, which you can use to list the next certificate.</p>
|
|
2765
|
+
*/
|
|
2766
|
+
NextToken?: string;
|
|
2767
|
+
/**
|
|
2768
|
+
* <p>Returns an array of the certificates that are specified in the
|
|
2769
|
+
* <code>ListCertificates</code> call.</p>
|
|
2770
|
+
*/
|
|
2771
|
+
Certificates: ListedCertificate[] | undefined;
|
|
2772
|
+
}
|
|
2773
|
+
export interface ListConnectorsRequest {
|
|
2774
|
+
/**
|
|
2775
|
+
* <p>The maximum number of connectors to return.</p>
|
|
2776
|
+
*/
|
|
2777
|
+
MaxResults?: number;
|
|
2778
|
+
/**
|
|
2779
|
+
* <p>When you can get additional results from the <code>ListConnectors</code> call, a
|
|
2780
|
+
* <code>NextToken</code> parameter is returned in the output. You can then pass in a
|
|
2781
|
+
* subsequent command to the <code>NextToken</code> parameter to continue listing additional
|
|
2782
|
+
* connectors.</p>
|
|
2783
|
+
*/
|
|
2784
|
+
NextToken?: string;
|
|
2785
|
+
}
|
|
2786
|
+
/**
|
|
2787
|
+
* <p>Returns details of the connector that is specified.</p>
|
|
2788
|
+
*/
|
|
2789
|
+
export interface ListedConnector {
|
|
2790
|
+
/**
|
|
2791
|
+
* <p>The Amazon Resource Name (ARN) of the specified connector.</p>
|
|
2792
|
+
*/
|
|
2793
|
+
Arn?: string;
|
|
2794
|
+
/**
|
|
2795
|
+
* <p>The unique identifier for the connector.</p>
|
|
2458
2796
|
*/
|
|
2459
|
-
|
|
2797
|
+
ConnectorId?: string;
|
|
2798
|
+
/**
|
|
2799
|
+
* <p>The URL of the partner's AS2 endpoint.</p>
|
|
2800
|
+
*/
|
|
2801
|
+
Url?: string;
|
|
2802
|
+
}
|
|
2803
|
+
export interface ListConnectorsResponse {
|
|
2804
|
+
/**
|
|
2805
|
+
* <p>Returns a token that you can use to call <code>ListConnectors</code> again and receive
|
|
2806
|
+
* additional results, if there are any.</p>
|
|
2807
|
+
*/
|
|
2808
|
+
NextToken?: string;
|
|
2809
|
+
/**
|
|
2810
|
+
* <p>Returns an array, where each item contains the details of a connector.</p>
|
|
2811
|
+
*/
|
|
2812
|
+
Connectors: ListedConnector[] | undefined;
|
|
2460
2813
|
}
|
|
2461
2814
|
/**
|
|
2462
2815
|
* <p>Returns properties of the execution that is specified.</p>
|
|
@@ -2473,7 +2826,7 @@ export interface ListedExecution {
|
|
|
2473
2826
|
*/
|
|
2474
2827
|
InitialFileLocation?: FileLocation;
|
|
2475
2828
|
/**
|
|
2476
|
-
* <p>A container object for the session details associated with a workflow.</p>
|
|
2829
|
+
* <p>A container object for the session details that are associated with a workflow.</p>
|
|
2477
2830
|
*/
|
|
2478
2831
|
ServiceMetadata?: ServiceMetadata;
|
|
2479
2832
|
/**
|
|
@@ -2481,11 +2834,27 @@ export interface ListedExecution {
|
|
|
2481
2834
|
*/
|
|
2482
2835
|
Status?: ExecutionStatus | string;
|
|
2483
2836
|
}
|
|
2484
|
-
|
|
2837
|
+
/**
|
|
2838
|
+
* <p>Returns the properties of the profile that was specified.</p>
|
|
2839
|
+
*/
|
|
2840
|
+
export interface ListedProfile {
|
|
2485
2841
|
/**
|
|
2486
|
-
*
|
|
2842
|
+
* <p>The Amazon Resource Name (ARN) of the specified profile.</p>
|
|
2843
|
+
*/
|
|
2844
|
+
Arn?: string;
|
|
2845
|
+
/**
|
|
2846
|
+
* <p>A unique identifier for the local or partner AS2 profile.</p>
|
|
2847
|
+
*/
|
|
2848
|
+
ProfileId?: string;
|
|
2849
|
+
/**
|
|
2850
|
+
* <p>The unique identifier for the AS2 process.</p>
|
|
2851
|
+
*/
|
|
2852
|
+
As2Id?: string;
|
|
2853
|
+
/**
|
|
2854
|
+
* <p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles.
|
|
2855
|
+
* If not supplied in the request, the command lists all types of profiles.</p>
|
|
2487
2856
|
*/
|
|
2488
|
-
|
|
2857
|
+
ProfileType?: ProfileType | string;
|
|
2489
2858
|
}
|
|
2490
2859
|
/**
|
|
2491
2860
|
* <p>Returns properties of a file transfer protocol-enabled server that was specified.</p>
|
|
@@ -2500,18 +2869,19 @@ export interface ListedServer {
|
|
|
2500
2869
|
*/
|
|
2501
2870
|
Domain?: Domain | string;
|
|
2502
2871
|
/**
|
|
2503
|
-
* <p>
|
|
2872
|
+
* <p>The mode of authentication for a server. The default value is
|
|
2504
2873
|
* <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
|
|
2505
|
-
* the
|
|
2874
|
+
* the Transfer Family service.</p>
|
|
2506
2875
|
* <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to
|
|
2507
|
-
* Active Directory groups in
|
|
2508
|
-
* on-premises environment or in Amazon Web Services using AD
|
|
2509
|
-
* provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
2876
|
+
* Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your
|
|
2877
|
+
* on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to
|
|
2878
|
+
* provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
2510
2879
|
* <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The
|
|
2511
|
-
* <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call
|
|
2512
|
-
* for authentication using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
2513
|
-
* <p>Use the <code>AWS_LAMBDA</code> value to directly use
|
|
2514
|
-
* you must specify the ARN for the
|
|
2880
|
+
* <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call
|
|
2881
|
+
* for authentication by using the <code>IdentityProviderDetails</code> parameter.</p>
|
|
2882
|
+
* <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider.
|
|
2883
|
+
* If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter
|
|
2884
|
+
* or the <code>IdentityProviderDetails</code> data type.</p>
|
|
2515
2885
|
*/
|
|
2516
2886
|
IdentityProviderType?: IdentityProviderType | string;
|
|
2517
2887
|
/**
|
|
@@ -2520,8 +2890,8 @@ export interface ListedServer {
|
|
|
2520
2890
|
*/
|
|
2521
2891
|
EndpointType?: EndpointType | string;
|
|
2522
2892
|
/**
|
|
2523
|
-
* <p>
|
|
2524
|
-
* on Amazon CloudWatch logging for Amazon S3 or Amazon
|
|
2893
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
|
|
2894
|
+
* on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
|
|
2525
2895
|
* your CloudWatch logs.</p>
|
|
2526
2896
|
*/
|
|
2527
2897
|
LoggingRole?: string;
|
|
@@ -2530,7 +2900,7 @@ export interface ListedServer {
|
|
|
2530
2900
|
*/
|
|
2531
2901
|
ServerId?: string;
|
|
2532
2902
|
/**
|
|
2533
|
-
* <p>
|
|
2903
|
+
* <p>The condition of the server that was described. A value of
|
|
2534
2904
|
* <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A
|
|
2535
2905
|
* <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file
|
|
2536
2906
|
* transfer operations.</p>
|
|
@@ -2547,12 +2917,6 @@ export interface ListedServer {
|
|
|
2547
2917
|
*/
|
|
2548
2918
|
UserCount?: number;
|
|
2549
2919
|
}
|
|
2550
|
-
export declare namespace ListedServer {
|
|
2551
|
-
/**
|
|
2552
|
-
* @internal
|
|
2553
|
-
*/
|
|
2554
|
-
const filterSensitiveLog: (obj: ListedServer) => any;
|
|
2555
|
-
}
|
|
2556
2920
|
/**
|
|
2557
2921
|
* <p>Returns properties of the user that you specify.</p>
|
|
2558
2922
|
*/
|
|
@@ -2568,17 +2932,17 @@ export interface ListedUser {
|
|
|
2568
2932
|
*/
|
|
2569
2933
|
HomeDirectory?: string;
|
|
2570
2934
|
/**
|
|
2571
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log
|
|
2572
|
-
* 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
|
|
2573
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
2574
|
-
* S3 or EFS paths visible to your users.</p>
|
|
2935
|
+
* <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
|
|
2936
|
+
* 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
|
|
2937
|
+
* protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
2938
|
+
* how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p>
|
|
2575
2939
|
*/
|
|
2576
2940
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
2577
2941
|
/**
|
|
2578
|
-
* <p>
|
|
2579
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
2580
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust
|
|
2581
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
2942
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
|
|
2943
|
+
* bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
2944
|
+
* when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
|
|
2945
|
+
* relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
|
|
2582
2946
|
* <note>
|
|
2583
2947
|
*
|
|
2584
2948
|
* <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>.
|
|
@@ -2599,12 +2963,6 @@ export interface ListedUser {
|
|
|
2599
2963
|
*/
|
|
2600
2964
|
UserName?: string;
|
|
2601
2965
|
}
|
|
2602
|
-
export declare namespace ListedUser {
|
|
2603
|
-
/**
|
|
2604
|
-
* @internal
|
|
2605
|
-
*/
|
|
2606
|
-
const filterSensitiveLog: (obj: ListedUser) => any;
|
|
2607
|
-
}
|
|
2608
2966
|
/**
|
|
2609
2967
|
* <p>Contains the ID, text description, and Amazon Resource Name (ARN) for the workflow.</p>
|
|
2610
2968
|
*/
|
|
@@ -2622,15 +2980,9 @@ export interface ListedWorkflow {
|
|
|
2622
2980
|
*/
|
|
2623
2981
|
Arn?: string;
|
|
2624
2982
|
}
|
|
2625
|
-
export declare namespace ListedWorkflow {
|
|
2626
|
-
/**
|
|
2627
|
-
* @internal
|
|
2628
|
-
*/
|
|
2629
|
-
const filterSensitiveLog: (obj: ListedWorkflow) => any;
|
|
2630
|
-
}
|
|
2631
2983
|
export interface ListExecutionsRequest {
|
|
2632
2984
|
/**
|
|
2633
|
-
* <p>Specifies the
|
|
2985
|
+
* <p>Specifies the maximum number of executions to return.</p>
|
|
2634
2986
|
*/
|
|
2635
2987
|
MaxResults?: number;
|
|
2636
2988
|
/**
|
|
@@ -2640,14 +2992,14 @@ export interface ListExecutionsRequest {
|
|
|
2640
2992
|
* continue listing additional executions.</p>
|
|
2641
2993
|
* <p>
|
|
2642
2994
|
* This is useful for pagination, for instance.
|
|
2643
|
-
* If you have 100 executions for a workflow, you might only want to list first 10. If so,
|
|
2995
|
+
* If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the <code>max-results</code>:
|
|
2644
2996
|
* </p>
|
|
2645
2997
|
* <p>
|
|
2646
2998
|
* <code>aws transfer list-executions --max-results 10</code>
|
|
2647
2999
|
* </p>
|
|
2648
3000
|
* <p>
|
|
2649
3001
|
* This returns details for the first 10 executions, as well as the pointer (<code>NextToken</code>) to the eleventh execution.
|
|
2650
|
-
* You can now call the API again,
|
|
3002
|
+
* You can now call the API again, supplying the <code>NextToken</code> value you received:
|
|
2651
3003
|
* </p>
|
|
2652
3004
|
* <p>
|
|
2653
3005
|
* <code>aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult</code>
|
|
@@ -2663,12 +3015,6 @@ export interface ListExecutionsRequest {
|
|
|
2663
3015
|
*/
|
|
2664
3016
|
WorkflowId: string | undefined;
|
|
2665
3017
|
}
|
|
2666
|
-
export declare namespace ListExecutionsRequest {
|
|
2667
|
-
/**
|
|
2668
|
-
* @internal
|
|
2669
|
-
*/
|
|
2670
|
-
const filterSensitiveLog: (obj: ListExecutionsRequest) => any;
|
|
2671
|
-
}
|
|
2672
3018
|
export interface ListExecutionsResponse {
|
|
2673
3019
|
/**
|
|
2674
3020
|
* <p>
|
|
@@ -2708,11 +3054,33 @@ export interface ListExecutionsResponse {
|
|
|
2708
3054
|
*/
|
|
2709
3055
|
Executions: ListedExecution[] | undefined;
|
|
2710
3056
|
}
|
|
2711
|
-
export
|
|
3057
|
+
export interface ListProfilesRequest {
|
|
2712
3058
|
/**
|
|
2713
|
-
*
|
|
3059
|
+
* <p>The maximum number of profiles to return.</p>
|
|
3060
|
+
*/
|
|
3061
|
+
MaxResults?: number;
|
|
3062
|
+
/**
|
|
3063
|
+
* <p>When there are additional results that were not returned, a <code>NextToken</code>
|
|
3064
|
+
* parameter is returned. You can use that value for a subsequent call to
|
|
3065
|
+
* <code>ListProfiles</code> to continue listing results.</p>
|
|
3066
|
+
*/
|
|
3067
|
+
NextToken?: string;
|
|
3068
|
+
/**
|
|
3069
|
+
* <p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles.
|
|
3070
|
+
* If not supplied in the request, the command lists all types of profiles.</p>
|
|
3071
|
+
*/
|
|
3072
|
+
ProfileType?: ProfileType | string;
|
|
3073
|
+
}
|
|
3074
|
+
export interface ListProfilesResponse {
|
|
3075
|
+
/**
|
|
3076
|
+
* <p>Returns a token that you can use to call <code>ListProfiles</code> again and receive
|
|
3077
|
+
* additional results, if there are any.</p>
|
|
3078
|
+
*/
|
|
3079
|
+
NextToken?: string;
|
|
3080
|
+
/**
|
|
3081
|
+
* <p>Returns an array, where each item contains the details of a profile.</p>
|
|
2714
3082
|
*/
|
|
2715
|
-
|
|
3083
|
+
Profiles: ListedProfile[] | undefined;
|
|
2716
3084
|
}
|
|
2717
3085
|
export interface ListSecurityPoliciesRequest {
|
|
2718
3086
|
/**
|
|
@@ -2728,12 +3096,6 @@ export interface ListSecurityPoliciesRequest {
|
|
|
2728
3096
|
*/
|
|
2729
3097
|
NextToken?: string;
|
|
2730
3098
|
}
|
|
2731
|
-
export declare namespace ListSecurityPoliciesRequest {
|
|
2732
|
-
/**
|
|
2733
|
-
* @internal
|
|
2734
|
-
*/
|
|
2735
|
-
const filterSensitiveLog: (obj: ListSecurityPoliciesRequest) => any;
|
|
2736
|
-
}
|
|
2737
3099
|
export interface ListSecurityPoliciesResponse {
|
|
2738
3100
|
/**
|
|
2739
3101
|
* <p>When you can get additional results from the <code>ListSecurityPolicies</code> operation,
|
|
@@ -2746,12 +3108,6 @@ export interface ListSecurityPoliciesResponse {
|
|
|
2746
3108
|
*/
|
|
2747
3109
|
SecurityPolicyNames: string[] | undefined;
|
|
2748
3110
|
}
|
|
2749
|
-
export declare namespace ListSecurityPoliciesResponse {
|
|
2750
|
-
/**
|
|
2751
|
-
* @internal
|
|
2752
|
-
*/
|
|
2753
|
-
const filterSensitiveLog: (obj: ListSecurityPoliciesResponse) => any;
|
|
2754
|
-
}
|
|
2755
3111
|
export interface ListServersRequest {
|
|
2756
3112
|
/**
|
|
2757
3113
|
* <p>Specifies the number of servers to return as a response to the <code>ListServers</code>
|
|
@@ -2766,12 +3122,6 @@ export interface ListServersRequest {
|
|
|
2766
3122
|
*/
|
|
2767
3123
|
NextToken?: string;
|
|
2768
3124
|
}
|
|
2769
|
-
export declare namespace ListServersRequest {
|
|
2770
|
-
/**
|
|
2771
|
-
* @internal
|
|
2772
|
-
*/
|
|
2773
|
-
const filterSensitiveLog: (obj: ListServersRequest) => any;
|
|
2774
|
-
}
|
|
2775
3125
|
export interface ListServersResponse {
|
|
2776
3126
|
/**
|
|
2777
3127
|
* <p>When you can get additional results from the <code>ListServers</code> operation, a
|
|
@@ -2784,12 +3134,6 @@ export interface ListServersResponse {
|
|
|
2784
3134
|
*/
|
|
2785
3135
|
Servers: ListedServer[] | undefined;
|
|
2786
3136
|
}
|
|
2787
|
-
export declare namespace ListServersResponse {
|
|
2788
|
-
/**
|
|
2789
|
-
* @internal
|
|
2790
|
-
*/
|
|
2791
|
-
const filterSensitiveLog: (obj: ListServersResponse) => any;
|
|
2792
|
-
}
|
|
2793
3137
|
export interface ListTagsForResourceRequest {
|
|
2794
3138
|
/**
|
|
2795
3139
|
* <p>Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an
|
|
@@ -2808,12 +3152,6 @@ export interface ListTagsForResourceRequest {
|
|
|
2808
3152
|
*/
|
|
2809
3153
|
NextToken?: string;
|
|
2810
3154
|
}
|
|
2811
|
-
export declare namespace ListTagsForResourceRequest {
|
|
2812
|
-
/**
|
|
2813
|
-
* @internal
|
|
2814
|
-
*/
|
|
2815
|
-
const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
|
|
2816
|
-
}
|
|
2817
3155
|
export interface ListTagsForResourceResponse {
|
|
2818
3156
|
/**
|
|
2819
3157
|
* <p>The ARN you specified to list the tags of.</p>
|
|
@@ -2832,12 +3170,6 @@ export interface ListTagsForResourceResponse {
|
|
|
2832
3170
|
*/
|
|
2833
3171
|
Tags?: Tag[];
|
|
2834
3172
|
}
|
|
2835
|
-
export declare namespace ListTagsForResourceResponse {
|
|
2836
|
-
/**
|
|
2837
|
-
* @internal
|
|
2838
|
-
*/
|
|
2839
|
-
const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
|
|
2840
|
-
}
|
|
2841
3173
|
export interface ListUsersRequest {
|
|
2842
3174
|
/**
|
|
2843
3175
|
* <p>Specifies the number of users to return as a response to the <code>ListUsers</code>
|
|
@@ -2856,12 +3188,6 @@ export interface ListUsersRequest {
|
|
|
2856
3188
|
*/
|
|
2857
3189
|
ServerId: string | undefined;
|
|
2858
3190
|
}
|
|
2859
|
-
export declare namespace ListUsersRequest {
|
|
2860
|
-
/**
|
|
2861
|
-
* @internal
|
|
2862
|
-
*/
|
|
2863
|
-
const filterSensitiveLog: (obj: ListUsersRequest) => any;
|
|
2864
|
-
}
|
|
2865
3191
|
export interface ListUsersResponse {
|
|
2866
3192
|
/**
|
|
2867
3193
|
* <p>When you can get additional results from the <code>ListUsers</code> call, a
|
|
@@ -2880,12 +3206,6 @@ export interface ListUsersResponse {
|
|
|
2880
3206
|
*/
|
|
2881
3207
|
Users: ListedUser[] | undefined;
|
|
2882
3208
|
}
|
|
2883
|
-
export declare namespace ListUsersResponse {
|
|
2884
|
-
/**
|
|
2885
|
-
* @internal
|
|
2886
|
-
*/
|
|
2887
|
-
const filterSensitiveLog: (obj: ListUsersResponse) => any;
|
|
2888
|
-
}
|
|
2889
3209
|
export interface ListWorkflowsRequest {
|
|
2890
3210
|
/**
|
|
2891
3211
|
* <p>Specifies the maximum number of workflows to return.</p>
|
|
@@ -2899,12 +3219,6 @@ export interface ListWorkflowsRequest {
|
|
|
2899
3219
|
*/
|
|
2900
3220
|
NextToken?: string;
|
|
2901
3221
|
}
|
|
2902
|
-
export declare namespace ListWorkflowsRequest {
|
|
2903
|
-
/**
|
|
2904
|
-
* @internal
|
|
2905
|
-
*/
|
|
2906
|
-
const filterSensitiveLog: (obj: ListWorkflowsRequest) => any;
|
|
2907
|
-
}
|
|
2908
3222
|
export interface ListWorkflowsResponse {
|
|
2909
3223
|
/**
|
|
2910
3224
|
* <p>
|
|
@@ -2918,12 +3232,6 @@ export interface ListWorkflowsResponse {
|
|
|
2918
3232
|
*/
|
|
2919
3233
|
Workflows: ListedWorkflow[] | undefined;
|
|
2920
3234
|
}
|
|
2921
|
-
export declare namespace ListWorkflowsResponse {
|
|
2922
|
-
/**
|
|
2923
|
-
* @internal
|
|
2924
|
-
*/
|
|
2925
|
-
const filterSensitiveLog: (obj: ListWorkflowsResponse) => any;
|
|
2926
|
-
}
|
|
2927
3235
|
export interface SendWorkflowStepStateRequest {
|
|
2928
3236
|
/**
|
|
2929
3237
|
* <p>A unique identifier for the workflow.</p>
|
|
@@ -2942,19 +3250,26 @@ export interface SendWorkflowStepStateRequest {
|
|
|
2942
3250
|
*/
|
|
2943
3251
|
Status: CustomStepStatus | string | undefined;
|
|
2944
3252
|
}
|
|
2945
|
-
export
|
|
3253
|
+
export interface SendWorkflowStepStateResponse {
|
|
3254
|
+
}
|
|
3255
|
+
export interface StartFileTransferRequest {
|
|
2946
3256
|
/**
|
|
2947
|
-
*
|
|
3257
|
+
* <p>The unique identifier for the connector. </p>
|
|
2948
3258
|
*/
|
|
2949
|
-
|
|
2950
|
-
|
|
2951
|
-
|
|
3259
|
+
ConnectorId: string | undefined;
|
|
3260
|
+
/**
|
|
3261
|
+
* <p>An array of strings. Each string represents the absolute path for one outbound file transfer. For example,
|
|
3262
|
+
* <code>
|
|
3263
|
+
* <i>DOC-EXAMPLE-BUCKET</i>/<i>myfile.txt</i>
|
|
3264
|
+
* </code>. </p>
|
|
3265
|
+
*/
|
|
3266
|
+
SendFilePaths: string[] | undefined;
|
|
2952
3267
|
}
|
|
2953
|
-
export
|
|
3268
|
+
export interface StartFileTransferResponse {
|
|
2954
3269
|
/**
|
|
2955
|
-
*
|
|
3270
|
+
* <p>Returns the unique identifier for this file transfer. </p>
|
|
2956
3271
|
*/
|
|
2957
|
-
|
|
3272
|
+
TransferId: string | undefined;
|
|
2958
3273
|
}
|
|
2959
3274
|
export interface StartServerRequest {
|
|
2960
3275
|
/**
|
|
@@ -2962,24 +3277,12 @@ export interface StartServerRequest {
|
|
|
2962
3277
|
*/
|
|
2963
3278
|
ServerId: string | undefined;
|
|
2964
3279
|
}
|
|
2965
|
-
export declare namespace StartServerRequest {
|
|
2966
|
-
/**
|
|
2967
|
-
* @internal
|
|
2968
|
-
*/
|
|
2969
|
-
const filterSensitiveLog: (obj: StartServerRequest) => any;
|
|
2970
|
-
}
|
|
2971
3280
|
export interface StopServerRequest {
|
|
2972
3281
|
/**
|
|
2973
3282
|
* <p>A system-assigned unique identifier for a server that you stopped.</p>
|
|
2974
3283
|
*/
|
|
2975
3284
|
ServerId: string | undefined;
|
|
2976
3285
|
}
|
|
2977
|
-
export declare namespace StopServerRequest {
|
|
2978
|
-
/**
|
|
2979
|
-
* @internal
|
|
2980
|
-
*/
|
|
2981
|
-
const filterSensitiveLog: (obj: StopServerRequest) => any;
|
|
2982
|
-
}
|
|
2983
3286
|
export interface TagResourceRequest {
|
|
2984
3287
|
/**
|
|
2985
3288
|
* <p>An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or
|
|
@@ -2992,12 +3295,6 @@ export interface TagResourceRequest {
|
|
|
2992
3295
|
*/
|
|
2993
3296
|
Tags: Tag[] | undefined;
|
|
2994
3297
|
}
|
|
2995
|
-
export declare namespace TagResourceRequest {
|
|
2996
|
-
/**
|
|
2997
|
-
* @internal
|
|
2998
|
-
*/
|
|
2999
|
-
const filterSensitiveLog: (obj: TagResourceRequest) => any;
|
|
3000
|
-
}
|
|
3001
3298
|
export interface TestIdentityProviderRequest {
|
|
3002
3299
|
/**
|
|
3003
3300
|
* <p>A system-assigned identifier for a specific server. That server's user authentication
|
|
@@ -3035,12 +3332,6 @@ export interface TestIdentityProviderRequest {
|
|
|
3035
3332
|
*/
|
|
3036
3333
|
UserPassword?: string;
|
|
3037
3334
|
}
|
|
3038
|
-
export declare namespace TestIdentityProviderRequest {
|
|
3039
|
-
/**
|
|
3040
|
-
* @internal
|
|
3041
|
-
*/
|
|
3042
|
-
const filterSensitiveLog: (obj: TestIdentityProviderRequest) => any;
|
|
3043
|
-
}
|
|
3044
3335
|
export interface TestIdentityProviderResponse {
|
|
3045
3336
|
/**
|
|
3046
3337
|
* <p>The response that is returned from your API Gateway.</p>
|
|
@@ -3062,12 +3353,6 @@ export interface TestIdentityProviderResponse {
|
|
|
3062
3353
|
*/
|
|
3063
3354
|
Url: string | undefined;
|
|
3064
3355
|
}
|
|
3065
|
-
export declare namespace TestIdentityProviderResponse {
|
|
3066
|
-
/**
|
|
3067
|
-
* @internal
|
|
3068
|
-
*/
|
|
3069
|
-
const filterSensitiveLog: (obj: TestIdentityProviderResponse) => any;
|
|
3070
|
-
}
|
|
3071
3356
|
export interface UntagResourceRequest {
|
|
3072
3357
|
/**
|
|
3073
3358
|
* <p>The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is
|
|
@@ -3080,12 +3365,6 @@ export interface UntagResourceRequest {
|
|
|
3080
3365
|
*/
|
|
3081
3366
|
TagKeys: string[] | undefined;
|
|
3082
3367
|
}
|
|
3083
|
-
export declare namespace UntagResourceRequest {
|
|
3084
|
-
/**
|
|
3085
|
-
* @internal
|
|
3086
|
-
*/
|
|
3087
|
-
const filterSensitiveLog: (obj: UntagResourceRequest) => any;
|
|
3088
|
-
}
|
|
3089
3368
|
export interface UpdateAccessRequest {
|
|
3090
3369
|
/**
|
|
3091
3370
|
* <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
|
|
@@ -3093,10 +3372,10 @@ export interface UpdateAccessRequest {
|
|
|
3093
3372
|
*/
|
|
3094
3373
|
HomeDirectory?: string;
|
|
3095
3374
|
/**
|
|
3096
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log
|
|
3097
|
-
* 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
|
|
3098
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
3099
|
-
* S3 or EFS paths visible to your users.</p>
|
|
3375
|
+
* <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
|
|
3376
|
+
* 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
|
|
3377
|
+
* protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
3378
|
+
* how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p>
|
|
3100
3379
|
*/
|
|
3101
3380
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
3102
3381
|
/**
|
|
@@ -3104,9 +3383,9 @@ export interface UpdateAccessRequest {
|
|
|
3104
3383
|
* be visible to your user and how you want to make them visible. You must specify the
|
|
3105
3384
|
* <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
|
|
3106
3385
|
* is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
|
|
3107
|
-
* only specify a target, it is displayed as is. You also must ensure that your
|
|
3108
|
-
*
|
|
3109
|
-
* can
|
|
3386
|
+
* only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM)
|
|
3387
|
+
* role provides access to paths in <code>Target</code>. This value
|
|
3388
|
+
* can be set only when <code>HomeDirectoryType</code> is set to
|
|
3110
3389
|
* <i>LOGICAL</i>.</p>
|
|
3111
3390
|
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>
|
|
3112
3391
|
* <p>
|
|
@@ -3123,14 +3402,13 @@ export interface UpdateAccessRequest {
|
|
|
3123
3402
|
*/
|
|
3124
3403
|
HomeDirectoryMappings?: HomeDirectoryMapEntry[];
|
|
3125
3404
|
/**
|
|
3126
|
-
* <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
|
|
3405
|
+
* <p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's
|
|
3127
3406
|
* access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
|
|
3128
3407
|
* <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
|
|
3129
3408
|
*
|
|
3130
|
-
*
|
|
3131
3409
|
* <note>
|
|
3132
|
-
* <p>This
|
|
3133
|
-
* <p>For session policies,
|
|
3410
|
+
* <p>This policy applies only when the domain of <code>ServerId</code> is Amazon S3. Amazon EFS does not use session policies.</p>
|
|
3411
|
+
* <p>For session policies, Transfer Family stores the policy as a JSON blob, instead
|
|
3134
3412
|
* of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass
|
|
3135
3413
|
* it in the <code>Policy</code> argument.</p>
|
|
3136
3414
|
* <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html">Example
|
|
@@ -3149,10 +3427,10 @@ export interface UpdateAccessRequest {
|
|
|
3149
3427
|
*/
|
|
3150
3428
|
PosixProfile?: PosixProfile;
|
|
3151
3429
|
/**
|
|
3152
|
-
* <p>
|
|
3153
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
3154
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust
|
|
3155
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
3430
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
|
|
3431
|
+
* bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
3432
|
+
* when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
|
|
3433
|
+
* relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
|
|
3156
3434
|
*/
|
|
3157
3435
|
Role?: string;
|
|
3158
3436
|
/**
|
|
@@ -3162,7 +3440,7 @@ export interface UpdateAccessRequest {
|
|
|
3162
3440
|
/**
|
|
3163
3441
|
* <p>A unique identifier that is required to identify specific groups within your directory.
|
|
3164
3442
|
* The users of the group that you associate have access to your Amazon S3 or Amazon EFS
|
|
3165
|
-
* resources over the enabled protocols using
|
|
3443
|
+
* resources over the enabled protocols using Transfer Family. If you know the group name,
|
|
3166
3444
|
* you can view the SID values by running the following command using Windows PowerShell.</p>
|
|
3167
3445
|
*
|
|
3168
3446
|
* <p>
|
|
@@ -3171,17 +3449,11 @@ export interface UpdateAccessRequest {
|
|
|
3171
3449
|
*
|
|
3172
3450
|
* <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
|
|
3173
3451
|
*
|
|
3174
|
-
* <p>The
|
|
3452
|
+
* <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
|
|
3175
3453
|
* You can also include underscores or any of the following characters: =,.@:/-</p>
|
|
3176
3454
|
*/
|
|
3177
3455
|
ExternalId: string | undefined;
|
|
3178
3456
|
}
|
|
3179
|
-
export declare namespace UpdateAccessRequest {
|
|
3180
|
-
/**
|
|
3181
|
-
* @internal
|
|
3182
|
-
*/
|
|
3183
|
-
const filterSensitiveLog: (obj: UpdateAccessRequest) => any;
|
|
3184
|
-
}
|
|
3185
3457
|
export interface UpdateAccessResponse {
|
|
3186
3458
|
/**
|
|
3187
3459
|
* <p>The ID of the server that the user is attached to.</p>
|
|
@@ -3193,13 +3465,132 @@ export interface UpdateAccessResponse {
|
|
|
3193
3465
|
*/
|
|
3194
3466
|
ExternalId: string | undefined;
|
|
3195
3467
|
}
|
|
3196
|
-
export
|
|
3468
|
+
export interface UpdateAgreementRequest {
|
|
3197
3469
|
/**
|
|
3198
|
-
*
|
|
3470
|
+
* <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
|
|
3199
3471
|
*/
|
|
3200
|
-
|
|
3201
|
-
|
|
3202
|
-
|
|
3472
|
+
AgreementId: string | undefined;
|
|
3473
|
+
/**
|
|
3474
|
+
* <p>A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.</p>
|
|
3475
|
+
*/
|
|
3476
|
+
ServerId: string | undefined;
|
|
3477
|
+
/**
|
|
3478
|
+
* <p>To replace the existing description, provide a short description for the agreement. </p>
|
|
3479
|
+
*/
|
|
3480
|
+
Description?: string;
|
|
3481
|
+
/**
|
|
3482
|
+
* <p>You can update the status for the agreement, either activating an inactive agreement or
|
|
3483
|
+
* the reverse.</p>
|
|
3484
|
+
*/
|
|
3485
|
+
Status?: AgreementStatusType | string;
|
|
3486
|
+
/**
|
|
3487
|
+
* <p>To change the local profile identifier, provide a new value
|
|
3488
|
+
* here.</p>
|
|
3489
|
+
*/
|
|
3490
|
+
LocalProfileId?: string;
|
|
3491
|
+
/**
|
|
3492
|
+
* <p>To change the partner profile identifier, provide a new value here.</p>
|
|
3493
|
+
*/
|
|
3494
|
+
PartnerProfileId?: string;
|
|
3495
|
+
/**
|
|
3496
|
+
* <p>To change the landing directory (folder) for files that are transferred, provide the
|
|
3497
|
+
* bucket folder that you want to use; for example,
|
|
3498
|
+
* <code>/<i>DOC-EXAMPLE-BUCKET</i>/<i>home</i>/<i>mydirectory</i>
|
|
3499
|
+
* </code>.</p>
|
|
3500
|
+
*/
|
|
3501
|
+
BaseDirectory?: string;
|
|
3502
|
+
/**
|
|
3503
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the
|
|
3504
|
+
* <code>HomeDirectory</code> of your users' Amazon S3 buckets.</p>
|
|
3505
|
+
*/
|
|
3506
|
+
AccessRole?: string;
|
|
3507
|
+
}
|
|
3508
|
+
export interface UpdateAgreementResponse {
|
|
3509
|
+
/**
|
|
3510
|
+
* <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
|
|
3511
|
+
*/
|
|
3512
|
+
AgreementId: string | undefined;
|
|
3513
|
+
}
|
|
3514
|
+
export interface UpdateCertificateRequest {
|
|
3515
|
+
/**
|
|
3516
|
+
* <p>The identifier of the certificate object that you are updating.</p>
|
|
3517
|
+
*/
|
|
3518
|
+
CertificateId: string | undefined;
|
|
3519
|
+
/**
|
|
3520
|
+
* <p>An optional date that specifies when the certificate becomes active.</p>
|
|
3521
|
+
*/
|
|
3522
|
+
ActiveDate?: Date;
|
|
3523
|
+
/**
|
|
3524
|
+
* <p>An optional date that specifies when the certificate becomes inactive.</p>
|
|
3525
|
+
*/
|
|
3526
|
+
InactiveDate?: Date;
|
|
3527
|
+
/**
|
|
3528
|
+
* <p>A short description to help identify the certificate.</p>
|
|
3529
|
+
*/
|
|
3530
|
+
Description?: string;
|
|
3531
|
+
}
|
|
3532
|
+
export interface UpdateCertificateResponse {
|
|
3533
|
+
/**
|
|
3534
|
+
* <p>Returns the identifier of the certificate object that you are updating.</p>
|
|
3535
|
+
*/
|
|
3536
|
+
CertificateId: string | undefined;
|
|
3537
|
+
}
|
|
3538
|
+
export interface UpdateConnectorRequest {
|
|
3539
|
+
/**
|
|
3540
|
+
* <p>The unique identifier for the connector.</p>
|
|
3541
|
+
*/
|
|
3542
|
+
ConnectorId: string | undefined;
|
|
3543
|
+
/**
|
|
3544
|
+
* <p>The URL of the partner's AS2 endpoint.</p>
|
|
3545
|
+
*/
|
|
3546
|
+
Url?: string;
|
|
3547
|
+
/**
|
|
3548
|
+
* <p>A structure that contains the parameters for a connector object.</p>
|
|
3549
|
+
*/
|
|
3550
|
+
As2Config?: As2ConnectorConfig;
|
|
3551
|
+
/**
|
|
3552
|
+
* <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
|
|
3553
|
+
* file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
|
|
3554
|
+
* directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
|
|
3555
|
+
* directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file,
|
|
3556
|
+
* store the MDN when we receive them from the partner, and write a final JSON file containing
|
|
3557
|
+
* relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read
|
|
3558
|
+
* and write access to the parent directory of the file location used in the
|
|
3559
|
+
* <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
|
|
3560
|
+
* access to the parent directory of the files that you intend to send with
|
|
3561
|
+
* <code>StartFileTransfer</code>.</p>
|
|
3562
|
+
*/
|
|
3563
|
+
AccessRole?: string;
|
|
3564
|
+
/**
|
|
3565
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn
|
|
3566
|
+
* on CloudWatch logging for Amazon S3 events. When set, you can view connector
|
|
3567
|
+
* activity in your CloudWatch logs.</p>
|
|
3568
|
+
*/
|
|
3569
|
+
LoggingRole?: string;
|
|
3570
|
+
}
|
|
3571
|
+
export interface UpdateConnectorResponse {
|
|
3572
|
+
/**
|
|
3573
|
+
* <p>Returns the identifier of the connector object that you are updating.</p>
|
|
3574
|
+
*/
|
|
3575
|
+
ConnectorId: string | undefined;
|
|
3576
|
+
}
|
|
3577
|
+
export interface UpdateProfileRequest {
|
|
3578
|
+
/**
|
|
3579
|
+
* <p>The identifier of the profile object that you are updating.</p>
|
|
3580
|
+
*/
|
|
3581
|
+
ProfileId: string | undefined;
|
|
3582
|
+
/**
|
|
3583
|
+
* <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
|
|
3584
|
+
*/
|
|
3585
|
+
CertificateIds?: string[];
|
|
3586
|
+
}
|
|
3587
|
+
export interface UpdateProfileResponse {
|
|
3588
|
+
/**
|
|
3589
|
+
* <p>Returns the identifier for the profile that's being updated.</p>
|
|
3590
|
+
*/
|
|
3591
|
+
ProfileId: string | undefined;
|
|
3592
|
+
}
|
|
3593
|
+
export interface UpdateServerRequest {
|
|
3203
3594
|
/**
|
|
3204
3595
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required
|
|
3205
3596
|
* when <code>Protocols</code> is set to <code>FTPS</code>.</p>
|
|
@@ -3246,27 +3637,33 @@ export interface UpdateServerRequest {
|
|
|
3246
3637
|
* <ul>
|
|
3247
3638
|
* <li>
|
|
3248
3639
|
* <p>
|
|
3249
|
-
*
|
|
3640
|
+
* To indicate passive mode (for FTP and FTPS protocols), use the <code>PassiveIp</code> parameter.
|
|
3250
3641
|
* Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
|
|
3251
3642
|
* </p>
|
|
3252
3643
|
* </li>
|
|
3253
3644
|
* <li>
|
|
3254
|
-
* <p>
|
|
3255
|
-
*
|
|
3256
|
-
*
|
|
3257
|
-
*
|
|
3645
|
+
* <p>To ignore the error that is generated when the client attempts to use the <code>SETSTAT</code> command on a file that you are
|
|
3646
|
+
* uploading to an Amazon S3 bucket, use the <code>SetStatOption</code> parameter. To have the Transfer Family server ignore the
|
|
3647
|
+
* <code>SETSTAT</code> command and upload files without needing to make any changes to your SFTP client, set the value to
|
|
3648
|
+
* <code>ENABLE_NO_OP</code>. If you set the <code>SetStatOption</code> parameter to <code>ENABLE_NO_OP</code>, Transfer Family
|
|
3649
|
+
* generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a <code>SETSTAT</code>
|
|
3650
|
+
* call.</p>
|
|
3651
|
+
* </li>
|
|
3652
|
+
* <li>
|
|
3653
|
+
* <p>To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the
|
|
3654
|
+
* <code>TlsSessionResumptionMode</code> parameter.</p>
|
|
3258
3655
|
* </li>
|
|
3259
3656
|
* <li>
|
|
3260
|
-
* <p>
|
|
3261
|
-
*
|
|
3657
|
+
* <p>
|
|
3658
|
+
* <code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p>
|
|
3262
3659
|
* </li>
|
|
3263
3660
|
* </ul>
|
|
3264
3661
|
*/
|
|
3265
3662
|
ProtocolDetails?: ProtocolDetails;
|
|
3266
3663
|
/**
|
|
3267
3664
|
* <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
|
3268
|
-
* When you host your endpoint within your VPC, you can make
|
|
3269
|
-
* within your VPC, or you can attach Elastic IP addresses and make
|
|
3665
|
+
* When you host your endpoint within your VPC, you can make your endpoint accessible only to resources
|
|
3666
|
+
* within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over
|
|
3270
3667
|
* the internet. Your VPC's default security groups are automatically assigned to your
|
|
3271
3668
|
* endpoint.</p>
|
|
3272
3669
|
*/
|
|
@@ -3299,7 +3696,7 @@ export interface UpdateServerRequest {
|
|
|
3299
3696
|
* <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
|
|
3300
3697
|
* <p>
|
|
3301
3698
|
* <code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
|
|
3302
|
-
* <p>Use a minimum value of 2048 for the <code>-b</code> option
|
|
3699
|
+
* <p>Use a minimum value of 2048 for the <code>-b</code> option. You can create a stronger key by using 3072 or 4096.</p>
|
|
3303
3700
|
*
|
|
3304
3701
|
* <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
|
|
3305
3702
|
* <p>
|
|
@@ -3320,8 +3717,7 @@ export interface UpdateServerRequest {
|
|
|
3320
3717
|
*
|
|
3321
3718
|
*
|
|
3322
3719
|
*
|
|
3323
|
-
* <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>
|
|
3324
|
-
* Family User Guide</i>.</p>
|
|
3720
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change the host key for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>
|
|
3325
3721
|
*/
|
|
3326
3722
|
HostKey?: string;
|
|
3327
3723
|
/**
|
|
@@ -3330,21 +3726,22 @@ export interface UpdateServerRequest {
|
|
|
3330
3726
|
*/
|
|
3331
3727
|
IdentityProviderDetails?: IdentityProviderDetails;
|
|
3332
3728
|
/**
|
|
3333
|
-
* <p>
|
|
3334
|
-
* on Amazon CloudWatch logging for Amazon S3 or Amazon
|
|
3729
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
|
|
3730
|
+
* on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
|
|
3335
3731
|
* your CloudWatch logs.</p>
|
|
3336
3732
|
*/
|
|
3337
3733
|
LoggingRole?: string;
|
|
3338
3734
|
/**
|
|
3339
|
-
* <p>
|
|
3735
|
+
* <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p>
|
|
3340
3736
|
* <note>
|
|
3341
3737
|
* <p>The SFTP protocol does not support post-authentication display banners.</p>
|
|
3342
3738
|
* </note>
|
|
3343
3739
|
*/
|
|
3344
3740
|
PostAuthenticationLoginBanner?: string;
|
|
3345
3741
|
/**
|
|
3346
|
-
* <p>
|
|
3347
|
-
* For example, the following banner displays details about using the system
|
|
3742
|
+
* <p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.
|
|
3743
|
+
* For example, the following banner displays details about using the system:</p>
|
|
3744
|
+
*
|
|
3348
3745
|
* <p>
|
|
3349
3746
|
* <code>This system is for the use of authorized users only. Individuals using this computer system without authority,
|
|
3350
3747
|
* or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by
|
|
@@ -3397,7 +3794,7 @@ export interface UpdateServerRequest {
|
|
|
3397
3794
|
*/
|
|
3398
3795
|
ServerId: string | undefined;
|
|
3399
3796
|
/**
|
|
3400
|
-
* <p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>
|
|
3797
|
+
* <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
|
|
3401
3798
|
* <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p>
|
|
3402
3799
|
* <p>
|
|
3403
3800
|
* <code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'</code>
|
|
@@ -3405,12 +3802,6 @@ export interface UpdateServerRequest {
|
|
|
3405
3802
|
*/
|
|
3406
3803
|
WorkflowDetails?: WorkflowDetails;
|
|
3407
3804
|
}
|
|
3408
|
-
export declare namespace UpdateServerRequest {
|
|
3409
|
-
/**
|
|
3410
|
-
* @internal
|
|
3411
|
-
*/
|
|
3412
|
-
const filterSensitiveLog: (obj: UpdateServerRequest) => any;
|
|
3413
|
-
}
|
|
3414
3805
|
export interface UpdateServerResponse {
|
|
3415
3806
|
/**
|
|
3416
3807
|
* <p>A system-assigned unique identifier for a server that the user account is assigned
|
|
@@ -3418,12 +3809,6 @@ export interface UpdateServerResponse {
|
|
|
3418
3809
|
*/
|
|
3419
3810
|
ServerId: string | undefined;
|
|
3420
3811
|
}
|
|
3421
|
-
export declare namespace UpdateServerResponse {
|
|
3422
|
-
/**
|
|
3423
|
-
* @internal
|
|
3424
|
-
*/
|
|
3425
|
-
const filterSensitiveLog: (obj: UpdateServerResponse) => any;
|
|
3426
|
-
}
|
|
3427
3812
|
export interface UpdateUserRequest {
|
|
3428
3813
|
/**
|
|
3429
3814
|
* <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
|
|
@@ -3431,10 +3816,10 @@ export interface UpdateUserRequest {
|
|
|
3431
3816
|
*/
|
|
3432
3817
|
HomeDirectory?: string;
|
|
3433
3818
|
/**
|
|
3434
|
-
* <p>The type of landing directory (folder) you want your users' home directory to be when they log
|
|
3435
|
-
* 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
|
|
3436
|
-
* If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
3437
|
-
* S3 or EFS paths visible to your users.</p>
|
|
3819
|
+
* <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
|
|
3820
|
+
* 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
|
|
3821
|
+
* protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
|
|
3822
|
+
* how you want to make Amazon S3 or Amazon EFS paths visible to your users.</p>
|
|
3438
3823
|
*/
|
|
3439
3824
|
HomeDirectoryType?: HomeDirectoryType | string;
|
|
3440
3825
|
/**
|
|
@@ -3442,9 +3827,9 @@ export interface UpdateUserRequest {
|
|
|
3442
3827
|
* be visible to your user and how you want to make them visible. You must specify the
|
|
3443
3828
|
* <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
|
|
3444
3829
|
* is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
|
|
3445
|
-
* only specify a target, it is displayed as is. You also must ensure that your
|
|
3446
|
-
*
|
|
3447
|
-
* can
|
|
3830
|
+
* only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM)
|
|
3831
|
+
* role provides access to paths in <code>Target</code>. This value
|
|
3832
|
+
* can be set only when <code>HomeDirectoryType</code> is set to
|
|
3448
3833
|
* <i>LOGICAL</i>.</p>
|
|
3449
3834
|
*
|
|
3450
3835
|
* <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>
|
|
@@ -3464,13 +3849,13 @@ export interface UpdateUserRequest {
|
|
|
3464
3849
|
*/
|
|
3465
3850
|
HomeDirectoryMappings?: HomeDirectoryMapEntry[];
|
|
3466
3851
|
/**
|
|
3467
|
-
* <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
|
|
3852
|
+
* <p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's
|
|
3468
3853
|
* access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
|
|
3469
3854
|
* <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
|
|
3470
3855
|
*
|
|
3471
3856
|
* <note>
|
|
3472
|
-
* <p>This
|
|
3473
|
-
* <p>For session policies,
|
|
3857
|
+
* <p>This policy applies only when the domain of <code>ServerId</code> is Amazon S3. Amazon EFS does not use session policies.</p>
|
|
3858
|
+
* <p>For session policies, Transfer Family stores the policy as a JSON blob, instead
|
|
3474
3859
|
* of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass
|
|
3475
3860
|
* it in the <code>Policy</code> argument.</p>
|
|
3476
3861
|
*
|
|
@@ -3495,10 +3880,10 @@ export interface UpdateUserRequest {
|
|
|
3495
3880
|
*/
|
|
3496
3881
|
PosixProfile?: PosixProfile;
|
|
3497
3882
|
/**
|
|
3498
|
-
* <p>
|
|
3499
|
-
* file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
3500
|
-
* files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust
|
|
3501
|
-
* server to access your resources when servicing your users' transfer requests.</p>
|
|
3883
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
|
|
3884
|
+
* bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
|
|
3885
|
+
* when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
|
|
3886
|
+
* relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
|
|
3502
3887
|
*/
|
|
3503
3888
|
Role?: string;
|
|
3504
3889
|
/**
|
|
@@ -3515,12 +3900,6 @@ export interface UpdateUserRequest {
|
|
|
3515
3900
|
*/
|
|
3516
3901
|
UserName: string | undefined;
|
|
3517
3902
|
}
|
|
3518
|
-
export declare namespace UpdateUserRequest {
|
|
3519
|
-
/**
|
|
3520
|
-
* @internal
|
|
3521
|
-
*/
|
|
3522
|
-
const filterSensitiveLog: (obj: UpdateUserRequest) => any;
|
|
3523
|
-
}
|
|
3524
3903
|
/**
|
|
3525
3904
|
* <p>
|
|
3526
3905
|
* <code>UpdateUserResponse</code> returns the user name and identifier for the request to
|
|
@@ -3538,9 +3917,559 @@ export interface UpdateUserResponse {
|
|
|
3538
3917
|
*/
|
|
3539
3918
|
UserName: string | undefined;
|
|
3540
3919
|
}
|
|
3541
|
-
|
|
3542
|
-
|
|
3543
|
-
|
|
3544
|
-
|
|
3545
|
-
|
|
3546
|
-
|
|
3920
|
+
/**
|
|
3921
|
+
* @internal
|
|
3922
|
+
*/
|
|
3923
|
+
export declare const As2ConnectorConfigFilterSensitiveLog: (obj: As2ConnectorConfig) => any;
|
|
3924
|
+
/**
|
|
3925
|
+
* @internal
|
|
3926
|
+
*/
|
|
3927
|
+
export declare const EfsFileLocationFilterSensitiveLog: (obj: EfsFileLocation) => any;
|
|
3928
|
+
/**
|
|
3929
|
+
* @internal
|
|
3930
|
+
*/
|
|
3931
|
+
export declare const S3InputFileLocationFilterSensitiveLog: (obj: S3InputFileLocation) => any;
|
|
3932
|
+
/**
|
|
3933
|
+
* @internal
|
|
3934
|
+
*/
|
|
3935
|
+
export declare const InputFileLocationFilterSensitiveLog: (obj: InputFileLocation) => any;
|
|
3936
|
+
/**
|
|
3937
|
+
* @internal
|
|
3938
|
+
*/
|
|
3939
|
+
export declare const CopyStepDetailsFilterSensitiveLog: (obj: CopyStepDetails) => any;
|
|
3940
|
+
/**
|
|
3941
|
+
* @internal
|
|
3942
|
+
*/
|
|
3943
|
+
export declare const HomeDirectoryMapEntryFilterSensitiveLog: (obj: HomeDirectoryMapEntry) => any;
|
|
3944
|
+
/**
|
|
3945
|
+
* @internal
|
|
3946
|
+
*/
|
|
3947
|
+
export declare const PosixProfileFilterSensitiveLog: (obj: PosixProfile) => any;
|
|
3948
|
+
/**
|
|
3949
|
+
* @internal
|
|
3950
|
+
*/
|
|
3951
|
+
export declare const CreateAccessRequestFilterSensitiveLog: (obj: CreateAccessRequest) => any;
|
|
3952
|
+
/**
|
|
3953
|
+
* @internal
|
|
3954
|
+
*/
|
|
3955
|
+
export declare const CreateAccessResponseFilterSensitiveLog: (obj: CreateAccessResponse) => any;
|
|
3956
|
+
/**
|
|
3957
|
+
* @internal
|
|
3958
|
+
*/
|
|
3959
|
+
export declare const TagFilterSensitiveLog: (obj: Tag) => any;
|
|
3960
|
+
/**
|
|
3961
|
+
* @internal
|
|
3962
|
+
*/
|
|
3963
|
+
export declare const CreateAgreementRequestFilterSensitiveLog: (obj: CreateAgreementRequest) => any;
|
|
3964
|
+
/**
|
|
3965
|
+
* @internal
|
|
3966
|
+
*/
|
|
3967
|
+
export declare const CreateAgreementResponseFilterSensitiveLog: (obj: CreateAgreementResponse) => any;
|
|
3968
|
+
/**
|
|
3969
|
+
* @internal
|
|
3970
|
+
*/
|
|
3971
|
+
export declare const CreateConnectorRequestFilterSensitiveLog: (obj: CreateConnectorRequest) => any;
|
|
3972
|
+
/**
|
|
3973
|
+
* @internal
|
|
3974
|
+
*/
|
|
3975
|
+
export declare const CreateConnectorResponseFilterSensitiveLog: (obj: CreateConnectorResponse) => any;
|
|
3976
|
+
/**
|
|
3977
|
+
* @internal
|
|
3978
|
+
*/
|
|
3979
|
+
export declare const CreateProfileRequestFilterSensitiveLog: (obj: CreateProfileRequest) => any;
|
|
3980
|
+
/**
|
|
3981
|
+
* @internal
|
|
3982
|
+
*/
|
|
3983
|
+
export declare const CreateProfileResponseFilterSensitiveLog: (obj: CreateProfileResponse) => any;
|
|
3984
|
+
/**
|
|
3985
|
+
* @internal
|
|
3986
|
+
*/
|
|
3987
|
+
export declare const EndpointDetailsFilterSensitiveLog: (obj: EndpointDetails) => any;
|
|
3988
|
+
/**
|
|
3989
|
+
* @internal
|
|
3990
|
+
*/
|
|
3991
|
+
export declare const IdentityProviderDetailsFilterSensitiveLog: (obj: IdentityProviderDetails) => any;
|
|
3992
|
+
/**
|
|
3993
|
+
* @internal
|
|
3994
|
+
*/
|
|
3995
|
+
export declare const ProtocolDetailsFilterSensitiveLog: (obj: ProtocolDetails) => any;
|
|
3996
|
+
/**
|
|
3997
|
+
* @internal
|
|
3998
|
+
*/
|
|
3999
|
+
export declare const WorkflowDetailFilterSensitiveLog: (obj: WorkflowDetail) => any;
|
|
4000
|
+
/**
|
|
4001
|
+
* @internal
|
|
4002
|
+
*/
|
|
4003
|
+
export declare const WorkflowDetailsFilterSensitiveLog: (obj: WorkflowDetails) => any;
|
|
4004
|
+
/**
|
|
4005
|
+
* @internal
|
|
4006
|
+
*/
|
|
4007
|
+
export declare const CreateServerRequestFilterSensitiveLog: (obj: CreateServerRequest) => any;
|
|
4008
|
+
/**
|
|
4009
|
+
* @internal
|
|
4010
|
+
*/
|
|
4011
|
+
export declare const CreateServerResponseFilterSensitiveLog: (obj: CreateServerResponse) => any;
|
|
4012
|
+
/**
|
|
4013
|
+
* @internal
|
|
4014
|
+
*/
|
|
4015
|
+
export declare const CreateUserRequestFilterSensitiveLog: (obj: CreateUserRequest) => any;
|
|
4016
|
+
/**
|
|
4017
|
+
* @internal
|
|
4018
|
+
*/
|
|
4019
|
+
export declare const CreateUserResponseFilterSensitiveLog: (obj: CreateUserResponse) => any;
|
|
4020
|
+
/**
|
|
4021
|
+
* @internal
|
|
4022
|
+
*/
|
|
4023
|
+
export declare const CustomStepDetailsFilterSensitiveLog: (obj: CustomStepDetails) => any;
|
|
4024
|
+
/**
|
|
4025
|
+
* @internal
|
|
4026
|
+
*/
|
|
4027
|
+
export declare const DeleteStepDetailsFilterSensitiveLog: (obj: DeleteStepDetails) => any;
|
|
4028
|
+
/**
|
|
4029
|
+
* @internal
|
|
4030
|
+
*/
|
|
4031
|
+
export declare const S3TagFilterSensitiveLog: (obj: S3Tag) => any;
|
|
4032
|
+
/**
|
|
4033
|
+
* @internal
|
|
4034
|
+
*/
|
|
4035
|
+
export declare const TagStepDetailsFilterSensitiveLog: (obj: TagStepDetails) => any;
|
|
4036
|
+
/**
|
|
4037
|
+
* @internal
|
|
4038
|
+
*/
|
|
4039
|
+
export declare const WorkflowStepFilterSensitiveLog: (obj: WorkflowStep) => any;
|
|
4040
|
+
/**
|
|
4041
|
+
* @internal
|
|
4042
|
+
*/
|
|
4043
|
+
export declare const CreateWorkflowRequestFilterSensitiveLog: (obj: CreateWorkflowRequest) => any;
|
|
4044
|
+
/**
|
|
4045
|
+
* @internal
|
|
4046
|
+
*/
|
|
4047
|
+
export declare const CreateWorkflowResponseFilterSensitiveLog: (obj: CreateWorkflowResponse) => any;
|
|
4048
|
+
/**
|
|
4049
|
+
* @internal
|
|
4050
|
+
*/
|
|
4051
|
+
export declare const DeleteAccessRequestFilterSensitiveLog: (obj: DeleteAccessRequest) => any;
|
|
4052
|
+
/**
|
|
4053
|
+
* @internal
|
|
4054
|
+
*/
|
|
4055
|
+
export declare const DeleteAgreementRequestFilterSensitiveLog: (obj: DeleteAgreementRequest) => any;
|
|
4056
|
+
/**
|
|
4057
|
+
* @internal
|
|
4058
|
+
*/
|
|
4059
|
+
export declare const DeleteCertificateRequestFilterSensitiveLog: (obj: DeleteCertificateRequest) => any;
|
|
4060
|
+
/**
|
|
4061
|
+
* @internal
|
|
4062
|
+
*/
|
|
4063
|
+
export declare const DeleteConnectorRequestFilterSensitiveLog: (obj: DeleteConnectorRequest) => any;
|
|
4064
|
+
/**
|
|
4065
|
+
* @internal
|
|
4066
|
+
*/
|
|
4067
|
+
export declare const DeleteProfileRequestFilterSensitiveLog: (obj: DeleteProfileRequest) => any;
|
|
4068
|
+
/**
|
|
4069
|
+
* @internal
|
|
4070
|
+
*/
|
|
4071
|
+
export declare const DeleteServerRequestFilterSensitiveLog: (obj: DeleteServerRequest) => any;
|
|
4072
|
+
/**
|
|
4073
|
+
* @internal
|
|
4074
|
+
*/
|
|
4075
|
+
export declare const DeleteSshPublicKeyRequestFilterSensitiveLog: (obj: DeleteSshPublicKeyRequest) => any;
|
|
4076
|
+
/**
|
|
4077
|
+
* @internal
|
|
4078
|
+
*/
|
|
4079
|
+
export declare const DeleteUserRequestFilterSensitiveLog: (obj: DeleteUserRequest) => any;
|
|
4080
|
+
/**
|
|
4081
|
+
* @internal
|
|
4082
|
+
*/
|
|
4083
|
+
export declare const DeleteWorkflowRequestFilterSensitiveLog: (obj: DeleteWorkflowRequest) => any;
|
|
4084
|
+
/**
|
|
4085
|
+
* @internal
|
|
4086
|
+
*/
|
|
4087
|
+
export declare const DescribeAccessRequestFilterSensitiveLog: (obj: DescribeAccessRequest) => any;
|
|
4088
|
+
/**
|
|
4089
|
+
* @internal
|
|
4090
|
+
*/
|
|
4091
|
+
export declare const DescribedAccessFilterSensitiveLog: (obj: DescribedAccess) => any;
|
|
4092
|
+
/**
|
|
4093
|
+
* @internal
|
|
4094
|
+
*/
|
|
4095
|
+
export declare const DescribeAccessResponseFilterSensitiveLog: (obj: DescribeAccessResponse) => any;
|
|
4096
|
+
/**
|
|
4097
|
+
* @internal
|
|
4098
|
+
*/
|
|
4099
|
+
export declare const DescribeAgreementRequestFilterSensitiveLog: (obj: DescribeAgreementRequest) => any;
|
|
4100
|
+
/**
|
|
4101
|
+
* @internal
|
|
4102
|
+
*/
|
|
4103
|
+
export declare const DescribedAgreementFilterSensitiveLog: (obj: DescribedAgreement) => any;
|
|
4104
|
+
/**
|
|
4105
|
+
* @internal
|
|
4106
|
+
*/
|
|
4107
|
+
export declare const DescribeAgreementResponseFilterSensitiveLog: (obj: DescribeAgreementResponse) => any;
|
|
4108
|
+
/**
|
|
4109
|
+
* @internal
|
|
4110
|
+
*/
|
|
4111
|
+
export declare const DescribeCertificateRequestFilterSensitiveLog: (obj: DescribeCertificateRequest) => any;
|
|
4112
|
+
/**
|
|
4113
|
+
* @internal
|
|
4114
|
+
*/
|
|
4115
|
+
export declare const DescribedCertificateFilterSensitiveLog: (obj: DescribedCertificate) => any;
|
|
4116
|
+
/**
|
|
4117
|
+
* @internal
|
|
4118
|
+
*/
|
|
4119
|
+
export declare const DescribeCertificateResponseFilterSensitiveLog: (obj: DescribeCertificateResponse) => any;
|
|
4120
|
+
/**
|
|
4121
|
+
* @internal
|
|
4122
|
+
*/
|
|
4123
|
+
export declare const DescribeConnectorRequestFilterSensitiveLog: (obj: DescribeConnectorRequest) => any;
|
|
4124
|
+
/**
|
|
4125
|
+
* @internal
|
|
4126
|
+
*/
|
|
4127
|
+
export declare const DescribedConnectorFilterSensitiveLog: (obj: DescribedConnector) => any;
|
|
4128
|
+
/**
|
|
4129
|
+
* @internal
|
|
4130
|
+
*/
|
|
4131
|
+
export declare const DescribeConnectorResponseFilterSensitiveLog: (obj: DescribeConnectorResponse) => any;
|
|
4132
|
+
/**
|
|
4133
|
+
* @internal
|
|
4134
|
+
*/
|
|
4135
|
+
export declare const S3FileLocationFilterSensitiveLog: (obj: S3FileLocation) => any;
|
|
4136
|
+
/**
|
|
4137
|
+
* @internal
|
|
4138
|
+
*/
|
|
4139
|
+
export declare const FileLocationFilterSensitiveLog: (obj: FileLocation) => any;
|
|
4140
|
+
/**
|
|
4141
|
+
* @internal
|
|
4142
|
+
*/
|
|
4143
|
+
export declare const LoggingConfigurationFilterSensitiveLog: (obj: LoggingConfiguration) => any;
|
|
4144
|
+
/**
|
|
4145
|
+
* @internal
|
|
4146
|
+
*/
|
|
4147
|
+
export declare const ExecutionErrorFilterSensitiveLog: (obj: ExecutionError) => any;
|
|
4148
|
+
/**
|
|
4149
|
+
* @internal
|
|
4150
|
+
*/
|
|
4151
|
+
export declare const ExecutionStepResultFilterSensitiveLog: (obj: ExecutionStepResult) => any;
|
|
4152
|
+
/**
|
|
4153
|
+
* @internal
|
|
4154
|
+
*/
|
|
4155
|
+
export declare const ExecutionResultsFilterSensitiveLog: (obj: ExecutionResults) => any;
|
|
4156
|
+
/**
|
|
4157
|
+
* @internal
|
|
4158
|
+
*/
|
|
4159
|
+
export declare const UserDetailsFilterSensitiveLog: (obj: UserDetails) => any;
|
|
4160
|
+
/**
|
|
4161
|
+
* @internal
|
|
4162
|
+
*/
|
|
4163
|
+
export declare const ServiceMetadataFilterSensitiveLog: (obj: ServiceMetadata) => any;
|
|
4164
|
+
/**
|
|
4165
|
+
* @internal
|
|
4166
|
+
*/
|
|
4167
|
+
export declare const DescribedExecutionFilterSensitiveLog: (obj: DescribedExecution) => any;
|
|
4168
|
+
/**
|
|
4169
|
+
* @internal
|
|
4170
|
+
*/
|
|
4171
|
+
export declare const DescribedProfileFilterSensitiveLog: (obj: DescribedProfile) => any;
|
|
4172
|
+
/**
|
|
4173
|
+
* @internal
|
|
4174
|
+
*/
|
|
4175
|
+
export declare const DescribedSecurityPolicyFilterSensitiveLog: (obj: DescribedSecurityPolicy) => any;
|
|
4176
|
+
/**
|
|
4177
|
+
* @internal
|
|
4178
|
+
*/
|
|
4179
|
+
export declare const DescribedServerFilterSensitiveLog: (obj: DescribedServer) => any;
|
|
4180
|
+
/**
|
|
4181
|
+
* @internal
|
|
4182
|
+
*/
|
|
4183
|
+
export declare const SshPublicKeyFilterSensitiveLog: (obj: SshPublicKey) => any;
|
|
4184
|
+
/**
|
|
4185
|
+
* @internal
|
|
4186
|
+
*/
|
|
4187
|
+
export declare const DescribedUserFilterSensitiveLog: (obj: DescribedUser) => any;
|
|
4188
|
+
/**
|
|
4189
|
+
* @internal
|
|
4190
|
+
*/
|
|
4191
|
+
export declare const DescribedWorkflowFilterSensitiveLog: (obj: DescribedWorkflow) => any;
|
|
4192
|
+
/**
|
|
4193
|
+
* @internal
|
|
4194
|
+
*/
|
|
4195
|
+
export declare const DescribeExecutionRequestFilterSensitiveLog: (obj: DescribeExecutionRequest) => any;
|
|
4196
|
+
/**
|
|
4197
|
+
* @internal
|
|
4198
|
+
*/
|
|
4199
|
+
export declare const DescribeExecutionResponseFilterSensitiveLog: (obj: DescribeExecutionResponse) => any;
|
|
4200
|
+
/**
|
|
4201
|
+
* @internal
|
|
4202
|
+
*/
|
|
4203
|
+
export declare const DescribeProfileRequestFilterSensitiveLog: (obj: DescribeProfileRequest) => any;
|
|
4204
|
+
/**
|
|
4205
|
+
* @internal
|
|
4206
|
+
*/
|
|
4207
|
+
export declare const DescribeProfileResponseFilterSensitiveLog: (obj: DescribeProfileResponse) => any;
|
|
4208
|
+
/**
|
|
4209
|
+
* @internal
|
|
4210
|
+
*/
|
|
4211
|
+
export declare const DescribeSecurityPolicyRequestFilterSensitiveLog: (obj: DescribeSecurityPolicyRequest) => any;
|
|
4212
|
+
/**
|
|
4213
|
+
* @internal
|
|
4214
|
+
*/
|
|
4215
|
+
export declare const DescribeSecurityPolicyResponseFilterSensitiveLog: (obj: DescribeSecurityPolicyResponse) => any;
|
|
4216
|
+
/**
|
|
4217
|
+
* @internal
|
|
4218
|
+
*/
|
|
4219
|
+
export declare const DescribeServerRequestFilterSensitiveLog: (obj: DescribeServerRequest) => any;
|
|
4220
|
+
/**
|
|
4221
|
+
* @internal
|
|
4222
|
+
*/
|
|
4223
|
+
export declare const DescribeServerResponseFilterSensitiveLog: (obj: DescribeServerResponse) => any;
|
|
4224
|
+
/**
|
|
4225
|
+
* @internal
|
|
4226
|
+
*/
|
|
4227
|
+
export declare const DescribeUserRequestFilterSensitiveLog: (obj: DescribeUserRequest) => any;
|
|
4228
|
+
/**
|
|
4229
|
+
* @internal
|
|
4230
|
+
*/
|
|
4231
|
+
export declare const DescribeUserResponseFilterSensitiveLog: (obj: DescribeUserResponse) => any;
|
|
4232
|
+
/**
|
|
4233
|
+
* @internal
|
|
4234
|
+
*/
|
|
4235
|
+
export declare const DescribeWorkflowRequestFilterSensitiveLog: (obj: DescribeWorkflowRequest) => any;
|
|
4236
|
+
/**
|
|
4237
|
+
* @internal
|
|
4238
|
+
*/
|
|
4239
|
+
export declare const DescribeWorkflowResponseFilterSensitiveLog: (obj: DescribeWorkflowResponse) => any;
|
|
4240
|
+
/**
|
|
4241
|
+
* @internal
|
|
4242
|
+
*/
|
|
4243
|
+
export declare const ImportCertificateRequestFilterSensitiveLog: (obj: ImportCertificateRequest) => any;
|
|
4244
|
+
/**
|
|
4245
|
+
* @internal
|
|
4246
|
+
*/
|
|
4247
|
+
export declare const ImportCertificateResponseFilterSensitiveLog: (obj: ImportCertificateResponse) => any;
|
|
4248
|
+
/**
|
|
4249
|
+
* @internal
|
|
4250
|
+
*/
|
|
4251
|
+
export declare const ImportSshPublicKeyRequestFilterSensitiveLog: (obj: ImportSshPublicKeyRequest) => any;
|
|
4252
|
+
/**
|
|
4253
|
+
* @internal
|
|
4254
|
+
*/
|
|
4255
|
+
export declare const ImportSshPublicKeyResponseFilterSensitiveLog: (obj: ImportSshPublicKeyResponse) => any;
|
|
4256
|
+
/**
|
|
4257
|
+
* @internal
|
|
4258
|
+
*/
|
|
4259
|
+
export declare const ListAccessesRequestFilterSensitiveLog: (obj: ListAccessesRequest) => any;
|
|
4260
|
+
/**
|
|
4261
|
+
* @internal
|
|
4262
|
+
*/
|
|
4263
|
+
export declare const ListedAccessFilterSensitiveLog: (obj: ListedAccess) => any;
|
|
4264
|
+
/**
|
|
4265
|
+
* @internal
|
|
4266
|
+
*/
|
|
4267
|
+
export declare const ListAccessesResponseFilterSensitiveLog: (obj: ListAccessesResponse) => any;
|
|
4268
|
+
/**
|
|
4269
|
+
* @internal
|
|
4270
|
+
*/
|
|
4271
|
+
export declare const ListAgreementsRequestFilterSensitiveLog: (obj: ListAgreementsRequest) => any;
|
|
4272
|
+
/**
|
|
4273
|
+
* @internal
|
|
4274
|
+
*/
|
|
4275
|
+
export declare const ListedAgreementFilterSensitiveLog: (obj: ListedAgreement) => any;
|
|
4276
|
+
/**
|
|
4277
|
+
* @internal
|
|
4278
|
+
*/
|
|
4279
|
+
export declare const ListAgreementsResponseFilterSensitiveLog: (obj: ListAgreementsResponse) => any;
|
|
4280
|
+
/**
|
|
4281
|
+
* @internal
|
|
4282
|
+
*/
|
|
4283
|
+
export declare const ListCertificatesRequestFilterSensitiveLog: (obj: ListCertificatesRequest) => any;
|
|
4284
|
+
/**
|
|
4285
|
+
* @internal
|
|
4286
|
+
*/
|
|
4287
|
+
export declare const ListedCertificateFilterSensitiveLog: (obj: ListedCertificate) => any;
|
|
4288
|
+
/**
|
|
4289
|
+
* @internal
|
|
4290
|
+
*/
|
|
4291
|
+
export declare const ListCertificatesResponseFilterSensitiveLog: (obj: ListCertificatesResponse) => any;
|
|
4292
|
+
/**
|
|
4293
|
+
* @internal
|
|
4294
|
+
*/
|
|
4295
|
+
export declare const ListConnectorsRequestFilterSensitiveLog: (obj: ListConnectorsRequest) => any;
|
|
4296
|
+
/**
|
|
4297
|
+
* @internal
|
|
4298
|
+
*/
|
|
4299
|
+
export declare const ListedConnectorFilterSensitiveLog: (obj: ListedConnector) => any;
|
|
4300
|
+
/**
|
|
4301
|
+
* @internal
|
|
4302
|
+
*/
|
|
4303
|
+
export declare const ListConnectorsResponseFilterSensitiveLog: (obj: ListConnectorsResponse) => any;
|
|
4304
|
+
/**
|
|
4305
|
+
* @internal
|
|
4306
|
+
*/
|
|
4307
|
+
export declare const ListedExecutionFilterSensitiveLog: (obj: ListedExecution) => any;
|
|
4308
|
+
/**
|
|
4309
|
+
* @internal
|
|
4310
|
+
*/
|
|
4311
|
+
export declare const ListedProfileFilterSensitiveLog: (obj: ListedProfile) => any;
|
|
4312
|
+
/**
|
|
4313
|
+
* @internal
|
|
4314
|
+
*/
|
|
4315
|
+
export declare const ListedServerFilterSensitiveLog: (obj: ListedServer) => any;
|
|
4316
|
+
/**
|
|
4317
|
+
* @internal
|
|
4318
|
+
*/
|
|
4319
|
+
export declare const ListedUserFilterSensitiveLog: (obj: ListedUser) => any;
|
|
4320
|
+
/**
|
|
4321
|
+
* @internal
|
|
4322
|
+
*/
|
|
4323
|
+
export declare const ListedWorkflowFilterSensitiveLog: (obj: ListedWorkflow) => any;
|
|
4324
|
+
/**
|
|
4325
|
+
* @internal
|
|
4326
|
+
*/
|
|
4327
|
+
export declare const ListExecutionsRequestFilterSensitiveLog: (obj: ListExecutionsRequest) => any;
|
|
4328
|
+
/**
|
|
4329
|
+
* @internal
|
|
4330
|
+
*/
|
|
4331
|
+
export declare const ListExecutionsResponseFilterSensitiveLog: (obj: ListExecutionsResponse) => any;
|
|
4332
|
+
/**
|
|
4333
|
+
* @internal
|
|
4334
|
+
*/
|
|
4335
|
+
export declare const ListProfilesRequestFilterSensitiveLog: (obj: ListProfilesRequest) => any;
|
|
4336
|
+
/**
|
|
4337
|
+
* @internal
|
|
4338
|
+
*/
|
|
4339
|
+
export declare const ListProfilesResponseFilterSensitiveLog: (obj: ListProfilesResponse) => any;
|
|
4340
|
+
/**
|
|
4341
|
+
* @internal
|
|
4342
|
+
*/
|
|
4343
|
+
export declare const ListSecurityPoliciesRequestFilterSensitiveLog: (obj: ListSecurityPoliciesRequest) => any;
|
|
4344
|
+
/**
|
|
4345
|
+
* @internal
|
|
4346
|
+
*/
|
|
4347
|
+
export declare const ListSecurityPoliciesResponseFilterSensitiveLog: (obj: ListSecurityPoliciesResponse) => any;
|
|
4348
|
+
/**
|
|
4349
|
+
* @internal
|
|
4350
|
+
*/
|
|
4351
|
+
export declare const ListServersRequestFilterSensitiveLog: (obj: ListServersRequest) => any;
|
|
4352
|
+
/**
|
|
4353
|
+
* @internal
|
|
4354
|
+
*/
|
|
4355
|
+
export declare const ListServersResponseFilterSensitiveLog: (obj: ListServersResponse) => any;
|
|
4356
|
+
/**
|
|
4357
|
+
* @internal
|
|
4358
|
+
*/
|
|
4359
|
+
export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
|
|
4360
|
+
/**
|
|
4361
|
+
* @internal
|
|
4362
|
+
*/
|
|
4363
|
+
export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
|
|
4364
|
+
/**
|
|
4365
|
+
* @internal
|
|
4366
|
+
*/
|
|
4367
|
+
export declare const ListUsersRequestFilterSensitiveLog: (obj: ListUsersRequest) => any;
|
|
4368
|
+
/**
|
|
4369
|
+
* @internal
|
|
4370
|
+
*/
|
|
4371
|
+
export declare const ListUsersResponseFilterSensitiveLog: (obj: ListUsersResponse) => any;
|
|
4372
|
+
/**
|
|
4373
|
+
* @internal
|
|
4374
|
+
*/
|
|
4375
|
+
export declare const ListWorkflowsRequestFilterSensitiveLog: (obj: ListWorkflowsRequest) => any;
|
|
4376
|
+
/**
|
|
4377
|
+
* @internal
|
|
4378
|
+
*/
|
|
4379
|
+
export declare const ListWorkflowsResponseFilterSensitiveLog: (obj: ListWorkflowsResponse) => any;
|
|
4380
|
+
/**
|
|
4381
|
+
* @internal
|
|
4382
|
+
*/
|
|
4383
|
+
export declare const SendWorkflowStepStateRequestFilterSensitiveLog: (obj: SendWorkflowStepStateRequest) => any;
|
|
4384
|
+
/**
|
|
4385
|
+
* @internal
|
|
4386
|
+
*/
|
|
4387
|
+
export declare const SendWorkflowStepStateResponseFilterSensitiveLog: (obj: SendWorkflowStepStateResponse) => any;
|
|
4388
|
+
/**
|
|
4389
|
+
* @internal
|
|
4390
|
+
*/
|
|
4391
|
+
export declare const StartFileTransferRequestFilterSensitiveLog: (obj: StartFileTransferRequest) => any;
|
|
4392
|
+
/**
|
|
4393
|
+
* @internal
|
|
4394
|
+
*/
|
|
4395
|
+
export declare const StartFileTransferResponseFilterSensitiveLog: (obj: StartFileTransferResponse) => any;
|
|
4396
|
+
/**
|
|
4397
|
+
* @internal
|
|
4398
|
+
*/
|
|
4399
|
+
export declare const StartServerRequestFilterSensitiveLog: (obj: StartServerRequest) => any;
|
|
4400
|
+
/**
|
|
4401
|
+
* @internal
|
|
4402
|
+
*/
|
|
4403
|
+
export declare const StopServerRequestFilterSensitiveLog: (obj: StopServerRequest) => any;
|
|
4404
|
+
/**
|
|
4405
|
+
* @internal
|
|
4406
|
+
*/
|
|
4407
|
+
export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
|
|
4408
|
+
/**
|
|
4409
|
+
* @internal
|
|
4410
|
+
*/
|
|
4411
|
+
export declare const TestIdentityProviderRequestFilterSensitiveLog: (obj: TestIdentityProviderRequest) => any;
|
|
4412
|
+
/**
|
|
4413
|
+
* @internal
|
|
4414
|
+
*/
|
|
4415
|
+
export declare const TestIdentityProviderResponseFilterSensitiveLog: (obj: TestIdentityProviderResponse) => any;
|
|
4416
|
+
/**
|
|
4417
|
+
* @internal
|
|
4418
|
+
*/
|
|
4419
|
+
export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
|
|
4420
|
+
/**
|
|
4421
|
+
* @internal
|
|
4422
|
+
*/
|
|
4423
|
+
export declare const UpdateAccessRequestFilterSensitiveLog: (obj: UpdateAccessRequest) => any;
|
|
4424
|
+
/**
|
|
4425
|
+
* @internal
|
|
4426
|
+
*/
|
|
4427
|
+
export declare const UpdateAccessResponseFilterSensitiveLog: (obj: UpdateAccessResponse) => any;
|
|
4428
|
+
/**
|
|
4429
|
+
* @internal
|
|
4430
|
+
*/
|
|
4431
|
+
export declare const UpdateAgreementRequestFilterSensitiveLog: (obj: UpdateAgreementRequest) => any;
|
|
4432
|
+
/**
|
|
4433
|
+
* @internal
|
|
4434
|
+
*/
|
|
4435
|
+
export declare const UpdateAgreementResponseFilterSensitiveLog: (obj: UpdateAgreementResponse) => any;
|
|
4436
|
+
/**
|
|
4437
|
+
* @internal
|
|
4438
|
+
*/
|
|
4439
|
+
export declare const UpdateCertificateRequestFilterSensitiveLog: (obj: UpdateCertificateRequest) => any;
|
|
4440
|
+
/**
|
|
4441
|
+
* @internal
|
|
4442
|
+
*/
|
|
4443
|
+
export declare const UpdateCertificateResponseFilterSensitiveLog: (obj: UpdateCertificateResponse) => any;
|
|
4444
|
+
/**
|
|
4445
|
+
* @internal
|
|
4446
|
+
*/
|
|
4447
|
+
export declare const UpdateConnectorRequestFilterSensitiveLog: (obj: UpdateConnectorRequest) => any;
|
|
4448
|
+
/**
|
|
4449
|
+
* @internal
|
|
4450
|
+
*/
|
|
4451
|
+
export declare const UpdateConnectorResponseFilterSensitiveLog: (obj: UpdateConnectorResponse) => any;
|
|
4452
|
+
/**
|
|
4453
|
+
* @internal
|
|
4454
|
+
*/
|
|
4455
|
+
export declare const UpdateProfileRequestFilterSensitiveLog: (obj: UpdateProfileRequest) => any;
|
|
4456
|
+
/**
|
|
4457
|
+
* @internal
|
|
4458
|
+
*/
|
|
4459
|
+
export declare const UpdateProfileResponseFilterSensitiveLog: (obj: UpdateProfileResponse) => any;
|
|
4460
|
+
/**
|
|
4461
|
+
* @internal
|
|
4462
|
+
*/
|
|
4463
|
+
export declare const UpdateServerRequestFilterSensitiveLog: (obj: UpdateServerRequest) => any;
|
|
4464
|
+
/**
|
|
4465
|
+
* @internal
|
|
4466
|
+
*/
|
|
4467
|
+
export declare const UpdateServerResponseFilterSensitiveLog: (obj: UpdateServerResponse) => any;
|
|
4468
|
+
/**
|
|
4469
|
+
* @internal
|
|
4470
|
+
*/
|
|
4471
|
+
export declare const UpdateUserRequestFilterSensitiveLog: (obj: UpdateUserRequest) => any;
|
|
4472
|
+
/**
|
|
4473
|
+
* @internal
|
|
4474
|
+
*/
|
|
4475
|
+
export declare const UpdateUserResponseFilterSensitiveLog: (obj: UpdateUserResponse) => any;
|