cdk-comprehend-s3olap 2.0.48 → 2.0.49
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/.jsii +4 -4
- package/lib/cdk-comprehend-s3olap.js +2 -2
- package/lib/comprehend-lambdas.js +2 -2
- package/lib/iam-roles.js +4 -4
- package/node_modules/aws-sdk/CHANGELOG.md +10 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/appsync-2017-07-25.min.json +34 -3
- package/node_modules/aws-sdk/apis/detective-2018-10-26.min.json +213 -39
- package/node_modules/aws-sdk/apis/detective-2018-10-26.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/guardduty-2017-11-28.min.json +776 -162
- package/node_modules/aws-sdk/apis/guardduty-2017-11-28.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/lookoutvision-2020-11-20.min.json +13 -4
- package/node_modules/aws-sdk/apis/macie2-2020-01-01.min.json +149 -6
- package/node_modules/aws-sdk/apis/macie2-2020-01-01.waiters2.json +25 -0
- package/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json +7 -1
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json +717 -67
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.paginators.json +24 -0
- package/node_modules/aws-sdk/clients/appsync.d.ts +41 -3
- package/node_modules/aws-sdk/clients/autoscaling.d.ts +118 -118
- package/node_modules/aws-sdk/clients/detective.d.ts +176 -4
- package/node_modules/aws-sdk/clients/guardduty.d.ts +604 -1
- package/node_modules/aws-sdk/clients/lookoutvision.d.ts +14 -2
- package/node_modules/aws-sdk/clients/macie2.d.ts +131 -9
- package/node_modules/aws-sdk/clients/macie2.js +1 -0
- package/node_modules/aws-sdk/clients/rds.d.ts +2 -2
- package/node_modules/aws-sdk/clients/rekognition.d.ts +12 -4
- package/node_modules/aws-sdk/clients/securityhub.d.ts +3 -3
- package/node_modules/aws-sdk/clients/transfer.d.ts +1000 -86
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +1 -1
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +567 -560
- package/node_modules/aws-sdk/dist/aws-sdk.js +10 -4
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +22 -22
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +6 -6
@@ -13,13 +13,37 @@ declare class Transfer extends Service {
|
|
13
13
|
constructor(options?: Transfer.Types.ClientConfiguration)
|
14
14
|
config: Config & Transfer.Types.ClientConfiguration;
|
15
15
|
/**
|
16
|
-
* Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using
|
16
|
+
* Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.
|
17
17
|
*/
|
18
18
|
createAccess(params: Transfer.Types.CreateAccessRequest, callback?: (err: AWSError, data: Transfer.Types.CreateAccessResponse) => void): Request<Transfer.Types.CreateAccessResponse, AWSError>;
|
19
19
|
/**
|
20
|
-
* Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using
|
20
|
+
* Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.
|
21
21
|
*/
|
22
22
|
createAccess(callback?: (err: AWSError, data: Transfer.Types.CreateAccessResponse) => void): Request<Transfer.Types.CreateAccessResponse, AWSError>;
|
23
|
+
/**
|
24
|
+
* Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes. The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.
|
25
|
+
*/
|
26
|
+
createAgreement(params: Transfer.Types.CreateAgreementRequest, callback?: (err: AWSError, data: Transfer.Types.CreateAgreementResponse) => void): Request<Transfer.Types.CreateAgreementResponse, AWSError>;
|
27
|
+
/**
|
28
|
+
* Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes. The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.
|
29
|
+
*/
|
30
|
+
createAgreement(callback?: (err: AWSError, data: Transfer.Types.CreateAgreementResponse) => void): Request<Transfer.Types.CreateAgreementResponse, AWSError>;
|
31
|
+
/**
|
32
|
+
* Creates the connector, which captures the parameters for an outbound connection for the AS2 protocol. The connector is required for sending files from a customer's non Amazon Web Services server.
|
33
|
+
*/
|
34
|
+
createConnector(params: Transfer.Types.CreateConnectorRequest, callback?: (err: AWSError, data: Transfer.Types.CreateConnectorResponse) => void): Request<Transfer.Types.CreateConnectorResponse, AWSError>;
|
35
|
+
/**
|
36
|
+
* Creates the connector, which captures the parameters for an outbound connection for the AS2 protocol. The connector is required for sending files from a customer's non Amazon Web Services server.
|
37
|
+
*/
|
38
|
+
createConnector(callback?: (err: AWSError, data: Transfer.Types.CreateConnectorResponse) => void): Request<Transfer.Types.CreateConnectorResponse, AWSError>;
|
39
|
+
/**
|
40
|
+
* Creates the profile for the AS2 process. The agreement is between the partner and the AS2 process.
|
41
|
+
*/
|
42
|
+
createProfile(params: Transfer.Types.CreateProfileRequest, callback?: (err: AWSError, data: Transfer.Types.CreateProfileResponse) => void): Request<Transfer.Types.CreateProfileResponse, AWSError>;
|
43
|
+
/**
|
44
|
+
* Creates the profile for the AS2 process. The agreement is between the partner and the AS2 process.
|
45
|
+
*/
|
46
|
+
createProfile(callback?: (err: AWSError, data: Transfer.Types.CreateProfileResponse) => void): Request<Transfer.Types.CreateProfileResponse, AWSError>;
|
23
47
|
/**
|
24
48
|
* Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.
|
25
49
|
*/
|
@@ -29,11 +53,11 @@ declare class Transfer extends Service {
|
|
29
53
|
*/
|
30
54
|
createServer(callback?: (err: AWSError, data: Transfer.Types.CreateServerResponse) => void): Request<Transfer.Types.CreateServerResponse, AWSError>;
|
31
55
|
/**
|
32
|
-
* Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's
|
56
|
+
* Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.
|
33
57
|
*/
|
34
58
|
createUser(params: Transfer.Types.CreateUserRequest, callback?: (err: AWSError, data: Transfer.Types.CreateUserResponse) => void): Request<Transfer.Types.CreateUserResponse, AWSError>;
|
35
59
|
/**
|
36
|
-
* Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's
|
60
|
+
* Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.
|
37
61
|
*/
|
38
62
|
createUser(callback?: (err: AWSError, data: Transfer.Types.CreateUserResponse) => void): Request<Transfer.Types.CreateUserResponse, AWSError>;
|
39
63
|
/**
|
@@ -52,6 +76,38 @@ declare class Transfer extends Service {
|
|
52
76
|
* Allows you to delete the access specified in the ServerID and ExternalID parameters.
|
53
77
|
*/
|
54
78
|
deleteAccess(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
79
|
+
/**
|
80
|
+
* Delete the agreement that's specified in the provided AgreementId.
|
81
|
+
*/
|
82
|
+
deleteAgreement(params: Transfer.Types.DeleteAgreementRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
83
|
+
/**
|
84
|
+
* Delete the agreement that's specified in the provided AgreementId.
|
85
|
+
*/
|
86
|
+
deleteAgreement(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
87
|
+
/**
|
88
|
+
* Deletes the certificate that's specified in the CertificateId parameter.
|
89
|
+
*/
|
90
|
+
deleteCertificate(params: Transfer.Types.DeleteCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
91
|
+
/**
|
92
|
+
* Deletes the certificate that's specified in the CertificateId parameter.
|
93
|
+
*/
|
94
|
+
deleteCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
95
|
+
/**
|
96
|
+
* Deletes the agreement that's specified in the provided ConnectorId.
|
97
|
+
*/
|
98
|
+
deleteConnector(params: Transfer.Types.DeleteConnectorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
99
|
+
/**
|
100
|
+
* Deletes the agreement that's specified in the provided ConnectorId.
|
101
|
+
*/
|
102
|
+
deleteConnector(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
103
|
+
/**
|
104
|
+
* Deletes the profile that's specified in the ProfileId parameter.
|
105
|
+
*/
|
106
|
+
deleteProfile(params: Transfer.Types.DeleteProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
107
|
+
/**
|
108
|
+
* Deletes the profile that's specified in the ProfileId parameter.
|
109
|
+
*/
|
110
|
+
deleteProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
55
111
|
/**
|
56
112
|
* Deletes the file transfer protocol-enabled server that you specify. No response returns from this operation.
|
57
113
|
*/
|
@@ -85,13 +141,37 @@ declare class Transfer extends Service {
|
|
85
141
|
*/
|
86
142
|
deleteWorkflow(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
87
143
|
/**
|
88
|
-
* Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its
|
144
|
+
* Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId. The response from this call returns the properties of the access that is associated with the ServerId value that was specified.
|
89
145
|
*/
|
90
146
|
describeAccess(params: Transfer.Types.DescribeAccessRequest, callback?: (err: AWSError, data: Transfer.Types.DescribeAccessResponse) => void): Request<Transfer.Types.DescribeAccessResponse, AWSError>;
|
91
147
|
/**
|
92
|
-
* Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its
|
148
|
+
* Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId. The response from this call returns the properties of the access that is associated with the ServerId value that was specified.
|
93
149
|
*/
|
94
150
|
describeAccess(callback?: (err: AWSError, data: Transfer.Types.DescribeAccessResponse) => void): Request<Transfer.Types.DescribeAccessResponse, AWSError>;
|
151
|
+
/**
|
152
|
+
* Describes the agreement that's identified by the AgreementId.
|
153
|
+
*/
|
154
|
+
describeAgreement(params: Transfer.Types.DescribeAgreementRequest, callback?: (err: AWSError, data: Transfer.Types.DescribeAgreementResponse) => void): Request<Transfer.Types.DescribeAgreementResponse, AWSError>;
|
155
|
+
/**
|
156
|
+
* Describes the agreement that's identified by the AgreementId.
|
157
|
+
*/
|
158
|
+
describeAgreement(callback?: (err: AWSError, data: Transfer.Types.DescribeAgreementResponse) => void): Request<Transfer.Types.DescribeAgreementResponse, AWSError>;
|
159
|
+
/**
|
160
|
+
* Describes the certificate that's identified by the CertificateId.
|
161
|
+
*/
|
162
|
+
describeCertificate(params: Transfer.Types.DescribeCertificateRequest, callback?: (err: AWSError, data: Transfer.Types.DescribeCertificateResponse) => void): Request<Transfer.Types.DescribeCertificateResponse, AWSError>;
|
163
|
+
/**
|
164
|
+
* Describes the certificate that's identified by the CertificateId.
|
165
|
+
*/
|
166
|
+
describeCertificate(callback?: (err: AWSError, data: Transfer.Types.DescribeCertificateResponse) => void): Request<Transfer.Types.DescribeCertificateResponse, AWSError>;
|
167
|
+
/**
|
168
|
+
* Describes the connector that's identified by the ConnectorId.
|
169
|
+
*/
|
170
|
+
describeConnector(params: Transfer.Types.DescribeConnectorRequest, callback?: (err: AWSError, data: Transfer.Types.DescribeConnectorResponse) => void): Request<Transfer.Types.DescribeConnectorResponse, AWSError>;
|
171
|
+
/**
|
172
|
+
* Describes the connector that's identified by the ConnectorId.
|
173
|
+
*/
|
174
|
+
describeConnector(callback?: (err: AWSError, data: Transfer.Types.DescribeConnectorResponse) => void): Request<Transfer.Types.DescribeConnectorResponse, AWSError>;
|
95
175
|
/**
|
96
176
|
* You can use DescribeExecution to check the details of the execution of the specified workflow.
|
97
177
|
*/
|
@@ -100,6 +180,14 @@ declare class Transfer extends Service {
|
|
100
180
|
* You can use DescribeExecution to check the details of the execution of the specified workflow.
|
101
181
|
*/
|
102
182
|
describeExecution(callback?: (err: AWSError, data: Transfer.Types.DescribeExecutionResponse) => void): Request<Transfer.Types.DescribeExecutionResponse, AWSError>;
|
183
|
+
/**
|
184
|
+
* Returns the details of the profile that's specified by the ProfileId.
|
185
|
+
*/
|
186
|
+
describeProfile(params: Transfer.Types.DescribeProfileRequest, callback?: (err: AWSError, data: Transfer.Types.DescribeProfileResponse) => void): Request<Transfer.Types.DescribeProfileResponse, AWSError>;
|
187
|
+
/**
|
188
|
+
* Returns the details of the profile that's specified by the ProfileId.
|
189
|
+
*/
|
190
|
+
describeProfile(callback?: (err: AWSError, data: Transfer.Types.DescribeProfileResponse) => void): Request<Transfer.Types.DescribeProfileResponse, AWSError>;
|
103
191
|
/**
|
104
192
|
* Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
|
105
193
|
*/
|
@@ -132,6 +220,14 @@ declare class Transfer extends Service {
|
|
132
220
|
* Describes the specified workflow.
|
133
221
|
*/
|
134
222
|
describeWorkflow(callback?: (err: AWSError, data: Transfer.Types.DescribeWorkflowResponse) => void): Request<Transfer.Types.DescribeWorkflowResponse, AWSError>;
|
223
|
+
/**
|
224
|
+
* Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
|
225
|
+
*/
|
226
|
+
importCertificate(params: Transfer.Types.ImportCertificateRequest, callback?: (err: AWSError, data: Transfer.Types.ImportCertificateResponse) => void): Request<Transfer.Types.ImportCertificateResponse, AWSError>;
|
227
|
+
/**
|
228
|
+
* Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
|
229
|
+
*/
|
230
|
+
importCertificate(callback?: (err: AWSError, data: Transfer.Types.ImportCertificateResponse) => void): Request<Transfer.Types.ImportCertificateResponse, AWSError>;
|
135
231
|
/**
|
136
232
|
* Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId. The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.
|
137
233
|
*/
|
@@ -148,6 +244,30 @@ declare class Transfer extends Service {
|
|
148
244
|
* Lists the details for all the accesses you have on your server.
|
149
245
|
*/
|
150
246
|
listAccesses(callback?: (err: AWSError, data: Transfer.Types.ListAccessesResponse) => void): Request<Transfer.Types.ListAccessesResponse, AWSError>;
|
247
|
+
/**
|
248
|
+
* Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.
|
249
|
+
*/
|
250
|
+
listAgreements(params: Transfer.Types.ListAgreementsRequest, callback?: (err: AWSError, data: Transfer.Types.ListAgreementsResponse) => void): Request<Transfer.Types.ListAgreementsResponse, AWSError>;
|
251
|
+
/**
|
252
|
+
* Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.
|
253
|
+
*/
|
254
|
+
listAgreements(callback?: (err: AWSError, data: Transfer.Types.ListAgreementsResponse) => void): Request<Transfer.Types.ListAgreementsResponse, AWSError>;
|
255
|
+
/**
|
256
|
+
* Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.
|
257
|
+
*/
|
258
|
+
listCertificates(params: Transfer.Types.ListCertificatesRequest, callback?: (err: AWSError, data: Transfer.Types.ListCertificatesResponse) => void): Request<Transfer.Types.ListCertificatesResponse, AWSError>;
|
259
|
+
/**
|
260
|
+
* Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.
|
261
|
+
*/
|
262
|
+
listCertificates(callback?: (err: AWSError, data: Transfer.Types.ListCertificatesResponse) => void): Request<Transfer.Types.ListCertificatesResponse, AWSError>;
|
263
|
+
/**
|
264
|
+
* Lists the connectors for the specified Region.
|
265
|
+
*/
|
266
|
+
listConnectors(params: Transfer.Types.ListConnectorsRequest, callback?: (err: AWSError, data: Transfer.Types.ListConnectorsResponse) => void): Request<Transfer.Types.ListConnectorsResponse, AWSError>;
|
267
|
+
/**
|
268
|
+
* Lists the connectors for the specified Region.
|
269
|
+
*/
|
270
|
+
listConnectors(callback?: (err: AWSError, data: Transfer.Types.ListConnectorsResponse) => void): Request<Transfer.Types.ListConnectorsResponse, AWSError>;
|
151
271
|
/**
|
152
272
|
* Lists all executions for the specified workflow.
|
153
273
|
*/
|
@@ -156,6 +276,14 @@ declare class Transfer extends Service {
|
|
156
276
|
* Lists all executions for the specified workflow.
|
157
277
|
*/
|
158
278
|
listExecutions(callback?: (err: AWSError, data: Transfer.Types.ListExecutionsResponse) => void): Request<Transfer.Types.ListExecutionsResponse, AWSError>;
|
279
|
+
/**
|
280
|
+
* Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.
|
281
|
+
*/
|
282
|
+
listProfiles(params: Transfer.Types.ListProfilesRequest, callback?: (err: AWSError, data: Transfer.Types.ListProfilesResponse) => void): Request<Transfer.Types.ListProfilesResponse, AWSError>;
|
283
|
+
/**
|
284
|
+
* Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.
|
285
|
+
*/
|
286
|
+
listProfiles(callback?: (err: AWSError, data: Transfer.Types.ListProfilesResponse) => void): Request<Transfer.Types.ListProfilesResponse, AWSError>;
|
159
287
|
/**
|
160
288
|
* Lists the security policies that are attached to your file transfer protocol-enabled servers.
|
161
289
|
*/
|
@@ -204,6 +332,14 @@ declare class Transfer extends Service {
|
|
204
332
|
* Sends a callback for asynchronous custom steps. The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.
|
205
333
|
*/
|
206
334
|
sendWorkflowStepState(callback?: (err: AWSError, data: Transfer.Types.SendWorkflowStepStateResponse) => void): Request<Transfer.Types.SendWorkflowStepStateResponse, AWSError>;
|
335
|
+
/**
|
336
|
+
* Begins an outbound file transfer. You specify the ConnectorId and the file paths for where to send the files.
|
337
|
+
*/
|
338
|
+
startFileTransfer(params: Transfer.Types.StartFileTransferRequest, callback?: (err: AWSError, data: Transfer.Types.StartFileTransferResponse) => void): Request<Transfer.Types.StartFileTransferResponse, AWSError>;
|
339
|
+
/**
|
340
|
+
* Begins an outbound file transfer. You specify the ConnectorId and the file paths for where to send the files.
|
341
|
+
*/
|
342
|
+
startFileTransfer(callback?: (err: AWSError, data: Transfer.Types.StartFileTransferResponse) => void): Request<Transfer.Types.StartFileTransferResponse, AWSError>;
|
207
343
|
/**
|
208
344
|
* Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs. The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition. No response is returned from this call.
|
209
345
|
*/
|
@@ -213,11 +349,11 @@ declare class Transfer extends Service {
|
|
213
349
|
*/
|
214
350
|
startServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
215
351
|
/**
|
216
|
-
* Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server. Stopping the server
|
352
|
+
* Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server. Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed. The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition. No response is returned from this call.
|
217
353
|
*/
|
218
354
|
stopServer(params: Transfer.Types.StopServerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
219
355
|
/**
|
220
|
-
* Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server. Stopping the server
|
356
|
+
* Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server. Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed. The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition. No response is returned from this call.
|
221
357
|
*/
|
222
358
|
stopServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
223
359
|
/**
|
@@ -252,6 +388,38 @@ declare class Transfer extends Service {
|
|
252
388
|
* Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.
|
253
389
|
*/
|
254
390
|
updateAccess(callback?: (err: AWSError, data: Transfer.Types.UpdateAccessResponse) => void): Request<Transfer.Types.UpdateAccessResponse, AWSError>;
|
391
|
+
/**
|
392
|
+
* Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.
|
393
|
+
*/
|
394
|
+
updateAgreement(params: Transfer.Types.UpdateAgreementRequest, callback?: (err: AWSError, data: Transfer.Types.UpdateAgreementResponse) => void): Request<Transfer.Types.UpdateAgreementResponse, AWSError>;
|
395
|
+
/**
|
396
|
+
* Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.
|
397
|
+
*/
|
398
|
+
updateAgreement(callback?: (err: AWSError, data: Transfer.Types.UpdateAgreementResponse) => void): Request<Transfer.Types.UpdateAgreementResponse, AWSError>;
|
399
|
+
/**
|
400
|
+
* Updates the active and inactive dates for a certificate.
|
401
|
+
*/
|
402
|
+
updateCertificate(params: Transfer.Types.UpdateCertificateRequest, callback?: (err: AWSError, data: Transfer.Types.UpdateCertificateResponse) => void): Request<Transfer.Types.UpdateCertificateResponse, AWSError>;
|
403
|
+
/**
|
404
|
+
* Updates the active and inactive dates for a certificate.
|
405
|
+
*/
|
406
|
+
updateCertificate(callback?: (err: AWSError, data: Transfer.Types.UpdateCertificateResponse) => void): Request<Transfer.Types.UpdateCertificateResponse, AWSError>;
|
407
|
+
/**
|
408
|
+
* Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you want to update, along with the new values for the parameters to update.
|
409
|
+
*/
|
410
|
+
updateConnector(params: Transfer.Types.UpdateConnectorRequest, callback?: (err: AWSError, data: Transfer.Types.UpdateConnectorResponse) => void): Request<Transfer.Types.UpdateConnectorResponse, AWSError>;
|
411
|
+
/**
|
412
|
+
* Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you want to update, along with the new values for the parameters to update.
|
413
|
+
*/
|
414
|
+
updateConnector(callback?: (err: AWSError, data: Transfer.Types.UpdateConnectorResponse) => void): Request<Transfer.Types.UpdateConnectorResponse, AWSError>;
|
415
|
+
/**
|
416
|
+
* Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.
|
417
|
+
*/
|
418
|
+
updateProfile(params: Transfer.Types.UpdateProfileRequest, callback?: (err: AWSError, data: Transfer.Types.UpdateProfileResponse) => void): Request<Transfer.Types.UpdateProfileResponse, AWSError>;
|
419
|
+
/**
|
420
|
+
* Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.
|
421
|
+
*/
|
422
|
+
updateProfile(callback?: (err: AWSError, data: Transfer.Types.UpdateProfileResponse) => void): Request<Transfer.Types.UpdateProfileResponse, AWSError>;
|
255
423
|
/**
|
256
424
|
* Updates the file transfer protocol-enabled server's properties after that server has been created. The UpdateServer call returns the ServerId of the server you updated.
|
257
425
|
*/
|
@@ -288,9 +456,59 @@ declare class Transfer extends Service {
|
|
288
456
|
declare namespace Transfer {
|
289
457
|
export type AddressAllocationId = string;
|
290
458
|
export type AddressAllocationIds = AddressAllocationId[];
|
459
|
+
export type AgreementId = string;
|
460
|
+
export type AgreementStatusType = "ACTIVE"|"INACTIVE"|string;
|
291
461
|
export type Arn = string;
|
462
|
+
export interface As2ConnectorConfig {
|
463
|
+
/**
|
464
|
+
* A unique identifier for the AS2 process.
|
465
|
+
*/
|
466
|
+
LocalProfileId?: ProfileId;
|
467
|
+
/**
|
468
|
+
* A unique identifier for the partner for the connector.
|
469
|
+
*/
|
470
|
+
PartnerProfileId?: ProfileId;
|
471
|
+
/**
|
472
|
+
* A short description to help identify the connector.
|
473
|
+
*/
|
474
|
+
MessageSubject?: MessageSubject;
|
475
|
+
/**
|
476
|
+
* Specifies whether the AS2 file is compressed.
|
477
|
+
*/
|
478
|
+
Compression?: CompressionEnum;
|
479
|
+
/**
|
480
|
+
* The algorithm that is used to encrypt the file.
|
481
|
+
*/
|
482
|
+
EncryptionAlgorithm?: EncryptionAlg;
|
483
|
+
/**
|
484
|
+
* The algorithm that is used to sign the AS2 transfers for this partner profile.
|
485
|
+
*/
|
486
|
+
SigningAlgorithm?: SigningAlg;
|
487
|
+
/**
|
488
|
+
* The signing algorithm for the MDN response.
|
489
|
+
*/
|
490
|
+
MdnSigningAlgorithm?: MdnSigningAlg;
|
491
|
+
/**
|
492
|
+
* Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values: SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not). NONE: Specifies that no MDN response is required.
|
493
|
+
*/
|
494
|
+
MdnResponse?: MdnResponse;
|
495
|
+
}
|
496
|
+
export type As2Id = string;
|
497
|
+
export type As2Transport = "HTTP"|string;
|
498
|
+
export type As2Transports = As2Transport[];
|
292
499
|
export type CallbackToken = string;
|
500
|
+
export type CertDate = Date;
|
501
|
+
export type CertSerial = string;
|
293
502
|
export type Certificate = string;
|
503
|
+
export type CertificateBodyType = string;
|
504
|
+
export type CertificateChainType = string;
|
505
|
+
export type CertificateId = string;
|
506
|
+
export type CertificateIds = CertificateId[];
|
507
|
+
export type CertificateStatusType = "ACTIVE"|"PENDING_ROTATION"|"INACTIVE"|string;
|
508
|
+
export type CertificateType = "CERTIFICATE"|"CERTIFICATE_WITH_PRIVATE_KEY"|string;
|
509
|
+
export type CertificateUsageType = "SIGNING"|"ENCRYPTION"|string;
|
510
|
+
export type CompressionEnum = "ZLIB"|"DISABLED"|string;
|
511
|
+
export type ConnectorId = string;
|
294
512
|
export interface CopyStepDetails {
|
295
513
|
/**
|
296
514
|
* The name of the step, used as an identifier.
|
@@ -315,20 +533,20 @@ declare namespace Transfer {
|
|
315
533
|
*/
|
316
534
|
HomeDirectory?: HomeDirectory;
|
317
535
|
/**
|
318
|
-
* The type of landing directory (folder) you want your users' home directory to be when they log
|
536
|
+
* The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
|
319
537
|
*/
|
320
538
|
HomeDirectoryType?: HomeDirectoryType;
|
321
539
|
/**
|
322
|
-
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your
|
540
|
+
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL. The following is an Entry and Target pair example. [ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ] In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("chroot"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value. The following is an Entry and Target pair example for chroot. [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
|
323
541
|
*/
|
324
542
|
HomeDirectoryMappings?: HomeDirectoryMappings;
|
325
543
|
/**
|
326
|
-
* A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. This
|
544
|
+
* 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 access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies. For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument. For an example of a session policy, see Example session policy. For more information, see AssumeRole in the Security Token Service API Reference.
|
327
545
|
*/
|
328
546
|
Policy?: Policy;
|
329
547
|
PosixProfile?: PosixProfile;
|
330
548
|
/**
|
331
|
-
*
|
549
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
|
332
550
|
*/
|
333
551
|
Role: Role;
|
334
552
|
/**
|
@@ -336,7 +554,7 @@ declare namespace Transfer {
|
|
336
554
|
*/
|
337
555
|
ServerId: ServerId;
|
338
556
|
/**
|
339
|
-
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using
|
557
|
+
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of your Active Directory group. The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
|
340
558
|
*/
|
341
559
|
ExternalId: ExternalId;
|
342
560
|
}
|
@@ -346,13 +564,105 @@ declare namespace Transfer {
|
|
346
564
|
*/
|
347
565
|
ServerId: ServerId;
|
348
566
|
/**
|
349
|
-
* The external ID of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using
|
567
|
+
* The external ID of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family.
|
350
568
|
*/
|
351
569
|
ExternalId: ExternalId;
|
352
570
|
}
|
571
|
+
export interface CreateAgreementRequest {
|
572
|
+
/**
|
573
|
+
* A name or short description to identify the agreement.
|
574
|
+
*/
|
575
|
+
Description?: Description;
|
576
|
+
/**
|
577
|
+
* A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
|
578
|
+
*/
|
579
|
+
ServerId: ServerId;
|
580
|
+
/**
|
581
|
+
* A unique identifier for the AS2 local profile.
|
582
|
+
*/
|
583
|
+
LocalProfileId: ProfileId;
|
584
|
+
/**
|
585
|
+
* A unique identifier for the partner profile used in the agreement.
|
586
|
+
*/
|
587
|
+
PartnerProfileId: ProfileId;
|
588
|
+
/**
|
589
|
+
* The landing directory (folder) for files transferred by using the AS2 protocol. A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory .
|
590
|
+
*/
|
591
|
+
BaseDirectory: HomeDirectory;
|
592
|
+
/**
|
593
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users' Amazon S3 buckets.
|
594
|
+
*/
|
595
|
+
AccessRole: Role;
|
596
|
+
/**
|
597
|
+
* The status of the agreement. The agreement can be either ACTIVE or INACTIVE.
|
598
|
+
*/
|
599
|
+
Status?: AgreementStatusType;
|
600
|
+
/**
|
601
|
+
* Key-value pairs that can be used to group and search for agreements.
|
602
|
+
*/
|
603
|
+
Tags?: Tags;
|
604
|
+
}
|
605
|
+
export interface CreateAgreementResponse {
|
606
|
+
/**
|
607
|
+
* The unique identifier for the agreement. Use this ID for deleting, or updating an agreement, as well as in any other API calls that require that you specify the agreement ID.
|
608
|
+
*/
|
609
|
+
AgreementId: AgreementId;
|
610
|
+
}
|
611
|
+
export interface CreateConnectorRequest {
|
612
|
+
/**
|
613
|
+
* The URL of the partner's AS2 endpoint.
|
614
|
+
*/
|
615
|
+
Url: Url;
|
616
|
+
/**
|
617
|
+
* A structure that contains the parameters for a connector object.
|
618
|
+
*/
|
619
|
+
As2Config: As2ConnectorConfig;
|
620
|
+
/**
|
621
|
+
* With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.
|
622
|
+
*/
|
623
|
+
AccessRole: Role;
|
624
|
+
/**
|
625
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
|
626
|
+
*/
|
627
|
+
LoggingRole?: Role;
|
628
|
+
/**
|
629
|
+
* Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
|
630
|
+
*/
|
631
|
+
Tags?: Tags;
|
632
|
+
}
|
633
|
+
export interface CreateConnectorResponse {
|
634
|
+
/**
|
635
|
+
* The unique identifier for the connector, returned after the API call succeeds.
|
636
|
+
*/
|
637
|
+
ConnectorId: ConnectorId;
|
638
|
+
}
|
639
|
+
export interface CreateProfileRequest {
|
640
|
+
/**
|
641
|
+
* The As2Id is the AS2-name, as defined in the defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.
|
642
|
+
*/
|
643
|
+
As2Id: As2Id;
|
644
|
+
/**
|
645
|
+
* Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.
|
646
|
+
*/
|
647
|
+
ProfileType: ProfileType;
|
648
|
+
/**
|
649
|
+
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
|
650
|
+
*/
|
651
|
+
CertificateIds?: CertificateIds;
|
652
|
+
/**
|
653
|
+
* Key-value pairs that can be used to group and search for AS2 profiles.
|
654
|
+
*/
|
655
|
+
Tags?: Tags;
|
656
|
+
}
|
657
|
+
export interface CreateProfileResponse {
|
658
|
+
/**
|
659
|
+
* The unique identifier for the AS2 profile, returned after the API call succeeds.
|
660
|
+
*/
|
661
|
+
ProfileId: ProfileId;
|
662
|
+
}
|
353
663
|
export interface CreateServerRequest {
|
354
664
|
/**
|
355
|
-
* The Amazon Resource Name (ARN) of the
|
665
|
+
* The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS. To request a new public certificate, see Request a public certificate in the Certificate Manager User Guide. To import an existing certificate into ACM, see Importing certificates into ACM in the Certificate Manager User Guide. To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Certificate Manager User Guide. Certificates with the following cryptographic algorithms and key sizes are supported: 2048-bit RSA (RSA_2048) 4096-bit RSA (RSA_4096) Elliptic Prime Curve 256 bit (EC_prime256v1) Elliptic Prime Curve 384 bit (EC_secp384r1) Elliptic Prime Curve 521 bit (EC_secp521r1) The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
|
356
666
|
*/
|
357
667
|
Certificate?: Certificate;
|
358
668
|
/**
|
@@ -360,7 +670,7 @@ declare namespace Transfer {
|
|
360
670
|
*/
|
361
671
|
Domain?: Domain;
|
362
672
|
/**
|
363
|
-
* The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make
|
673
|
+
* The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
|
364
674
|
*/
|
365
675
|
EndpointDetails?: EndpointDetails;
|
366
676
|
/**
|
@@ -368,7 +678,7 @@ declare namespace Transfer {
|
|
368
678
|
*/
|
369
679
|
EndpointType?: EndpointType;
|
370
680
|
/**
|
371
|
-
* The RSA, ECDSA, or ED25519 private key to use for your server. Use the following command to generate an RSA 2048 bit key with no passphrase: ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key. Use a minimum value of 2048 for the -b option
|
681
|
+
* The RSA, ECDSA, or ED25519 private key to use for your server. Use the following command to generate an RSA 2048 bit key with no passphrase: ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key. Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096. Use the following command to generate an ECDSA 256 bit key with no passphrase: ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key. Valid values for the -b option for ECDSA are 256, 384, and 521. Use the following command to generate an ED25519 key with no passphrase: ssh-keygen -t ed25519 -N "" -f my-new-server-key. For all of these commands, you can replace my-new-server-key with a string of your choice. If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see Change the host key for your SFTP-enabled server in the Transfer Family User Guide.
|
372
682
|
*/
|
373
683
|
HostKey?: HostKey;
|
374
684
|
/**
|
@@ -376,27 +686,27 @@ declare namespace Transfer {
|
|
376
686
|
*/
|
377
687
|
IdentityProviderDetails?: IdentityProviderDetails;
|
378
688
|
/**
|
379
|
-
*
|
689
|
+
* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter or the IdentityProviderDetails data type.
|
380
690
|
*/
|
381
691
|
IdentityProviderType?: IdentityProviderType;
|
382
692
|
/**
|
383
|
-
*
|
693
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
|
384
694
|
*/
|
385
695
|
LoggingRole?: Role;
|
386
696
|
/**
|
387
|
-
*
|
697
|
+
* Specifies a string to display when users connect to a server. This string is displayed after the user authenticates. The SFTP protocol does not support post-authentication display banners.
|
388
698
|
*/
|
389
699
|
PostAuthenticationLoginBanner?: PostAuthenticationLoginBanner;
|
390
700
|
/**
|
391
|
-
*
|
701
|
+
* Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system: This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
|
392
702
|
*/
|
393
703
|
PreAuthenticationLoginBanner?: PreAuthenticationLoginBanner;
|
394
704
|
/**
|
395
|
-
* Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are: SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH FTPS (File Transfer Protocol Secure): File transfer with TLS encryption FTP (File Transfer Protocol): Unencrypted file transfer If you select FTPS, you must choose a certificate stored in
|
705
|
+
* Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are: SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH FTPS (File Transfer Protocol Secure): File transfer with TLS encryption FTP (File Transfer Protocol): Unencrypted file transfer AS2 (Applicability Statement 2): used for transporting structured business-to-business data If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY. If Protocol includes FTP, then AddressAllocationIds cannot be associated. If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED. If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.
|
396
706
|
*/
|
397
707
|
Protocols?: Protocols;
|
398
708
|
/**
|
399
|
-
* The protocol settings that are configured for your server.
|
709
|
+
* The protocol settings that are configured for your server. To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call. To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter. As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
|
400
710
|
*/
|
401
711
|
ProtocolDetails?: ProtocolDetails;
|
402
712
|
/**
|
@@ -408,7 +718,7 @@ declare namespace Transfer {
|
|
408
718
|
*/
|
409
719
|
Tags?: Tags;
|
410
720
|
/**
|
411
|
-
* Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
|
721
|
+
* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
|
412
722
|
*/
|
413
723
|
WorkflowDetails?: WorkflowDetails;
|
414
724
|
}
|
@@ -424,15 +734,15 @@ declare namespace Transfer {
|
|
424
734
|
*/
|
425
735
|
HomeDirectory?: HomeDirectory;
|
426
736
|
/**
|
427
|
-
* The type of landing directory (folder) you want your users' home directory to be when they log
|
737
|
+
* The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
|
428
738
|
*/
|
429
739
|
HomeDirectoryType?: HomeDirectoryType;
|
430
740
|
/**
|
431
|
-
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your
|
741
|
+
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL. The following is an Entry and Target pair example. [ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ] In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value. The following is an Entry and Target pair example for chroot. [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
|
432
742
|
*/
|
433
743
|
HomeDirectoryMappings?: HomeDirectoryMappings;
|
434
744
|
/**
|
435
|
-
* A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. This
|
745
|
+
* 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 access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies. For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument. For an example of a session policy, see Example session policy. For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
|
436
746
|
*/
|
437
747
|
Policy?: Policy;
|
438
748
|
/**
|
@@ -440,7 +750,7 @@ declare namespace Transfer {
|
|
440
750
|
*/
|
441
751
|
PosixProfile?: PosixProfile;
|
442
752
|
/**
|
443
|
-
*
|
753
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
|
444
754
|
*/
|
445
755
|
Role: Role;
|
446
756
|
/**
|
@@ -476,7 +786,7 @@ declare namespace Transfer {
|
|
476
786
|
*/
|
477
787
|
Description?: WorkflowDescription;
|
478
788
|
/**
|
479
|
-
* Specifies the details for the steps that are in the specified workflow. The TYPE specifies which of the following actions is being taken for this step. COPY:
|
789
|
+
* Specifies the details for the steps that are in the specified workflow. The TYPE specifies which of the following actions is being taken for this step. COPY: Copy the file to another location. CUSTOM: Perform a custom step with an Lambda function target. DELETE: Delete the file. TAG: Add a tag to the file. Currently, copying and tagging are supported only on S3. For file location, you specify either the S3 bucket and key, or the EFS file system ID and path.
|
480
790
|
*/
|
481
791
|
Steps: WorkflowSteps;
|
482
792
|
/**
|
@@ -522,10 +832,38 @@ declare namespace Transfer {
|
|
522
832
|
*/
|
523
833
|
ServerId: ServerId;
|
524
834
|
/**
|
525
|
-
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using
|
835
|
+
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of your Active Directory group. The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
|
526
836
|
*/
|
527
837
|
ExternalId: ExternalId;
|
528
838
|
}
|
839
|
+
export interface DeleteAgreementRequest {
|
840
|
+
/**
|
841
|
+
* A unique identifier for the agreement. This identifier is returned when you create an agreement.
|
842
|
+
*/
|
843
|
+
AgreementId: AgreementId;
|
844
|
+
/**
|
845
|
+
* The server ID associated with the agreement that you are deleting.
|
846
|
+
*/
|
847
|
+
ServerId: ServerId;
|
848
|
+
}
|
849
|
+
export interface DeleteCertificateRequest {
|
850
|
+
/**
|
851
|
+
* The ID of the certificate object that you are deleting.
|
852
|
+
*/
|
853
|
+
CertificateId: CertificateId;
|
854
|
+
}
|
855
|
+
export interface DeleteConnectorRequest {
|
856
|
+
/**
|
857
|
+
* The unique identifier for the connector.
|
858
|
+
*/
|
859
|
+
ConnectorId: ConnectorId;
|
860
|
+
}
|
861
|
+
export interface DeleteProfileRequest {
|
862
|
+
/**
|
863
|
+
* The ID of the profile that you are deleting.
|
864
|
+
*/
|
865
|
+
ProfileId: ProfileId;
|
866
|
+
}
|
529
867
|
export interface DeleteServerRequest {
|
530
868
|
/**
|
531
869
|
* A unique system-assigned identifier for a server instance.
|
@@ -578,7 +916,7 @@ declare namespace Transfer {
|
|
578
916
|
*/
|
579
917
|
ServerId: ServerId;
|
580
918
|
/**
|
581
|
-
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using
|
919
|
+
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of your Active Directory group. The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
|
582
920
|
*/
|
583
921
|
ExternalId: ExternalId;
|
584
922
|
}
|
@@ -592,6 +930,46 @@ declare namespace Transfer {
|
|
592
930
|
*/
|
593
931
|
Access: DescribedAccess;
|
594
932
|
}
|
933
|
+
export interface DescribeAgreementRequest {
|
934
|
+
/**
|
935
|
+
* A unique identifier for the agreement. This identifier is returned when you create an agreement.
|
936
|
+
*/
|
937
|
+
AgreementId: AgreementId;
|
938
|
+
/**
|
939
|
+
* The server ID that's associated with the agreement.
|
940
|
+
*/
|
941
|
+
ServerId: ServerId;
|
942
|
+
}
|
943
|
+
export interface DescribeAgreementResponse {
|
944
|
+
/**
|
945
|
+
* The details for the specified agreement, returned as a DescribedAgreement object.
|
946
|
+
*/
|
947
|
+
Agreement: DescribedAgreement;
|
948
|
+
}
|
949
|
+
export interface DescribeCertificateRequest {
|
950
|
+
/**
|
951
|
+
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
|
952
|
+
*/
|
953
|
+
CertificateId: CertificateId;
|
954
|
+
}
|
955
|
+
export interface DescribeCertificateResponse {
|
956
|
+
/**
|
957
|
+
* The details for the specified certificate, returned as an object.
|
958
|
+
*/
|
959
|
+
Certificate: DescribedCertificate;
|
960
|
+
}
|
961
|
+
export interface DescribeConnectorRequest {
|
962
|
+
/**
|
963
|
+
* The unique identifier for the connector.
|
964
|
+
*/
|
965
|
+
ConnectorId: ConnectorId;
|
966
|
+
}
|
967
|
+
export interface DescribeConnectorResponse {
|
968
|
+
/**
|
969
|
+
* The structure that contains the details of the connector.
|
970
|
+
*/
|
971
|
+
Connector: DescribedConnector;
|
972
|
+
}
|
595
973
|
export interface DescribeExecutionRequest {
|
596
974
|
/**
|
597
975
|
* A unique identifier for the execution of a workflow.
|
@@ -612,6 +990,18 @@ declare namespace Transfer {
|
|
612
990
|
*/
|
613
991
|
Execution: DescribedExecution;
|
614
992
|
}
|
993
|
+
export interface DescribeProfileRequest {
|
994
|
+
/**
|
995
|
+
* The identifier of the profile that you want described.
|
996
|
+
*/
|
997
|
+
ProfileId: ProfileId;
|
998
|
+
}
|
999
|
+
export interface DescribeProfileResponse {
|
1000
|
+
/**
|
1001
|
+
* The details of the specified profile, returned as an object.
|
1002
|
+
*/
|
1003
|
+
Profile: DescribedProfile;
|
1004
|
+
}
|
615
1005
|
export interface DescribeSecurityPolicyRequest {
|
616
1006
|
/**
|
617
1007
|
* Specifies the name of the security policy that is attached to the server.
|
@@ -642,7 +1032,7 @@ declare namespace Transfer {
|
|
642
1032
|
*/
|
643
1033
|
ServerId: ServerId;
|
644
1034
|
/**
|
645
|
-
* The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the
|
1035
|
+
* The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Transfer Family service and perform file transfer tasks.
|
646
1036
|
*/
|
647
1037
|
UserName: UserName;
|
648
1038
|
}
|
@@ -674,27 +1064,157 @@ declare namespace Transfer {
|
|
674
1064
|
*/
|
675
1065
|
HomeDirectory?: HomeDirectory;
|
676
1066
|
/**
|
677
|
-
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your
|
1067
|
+
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL. In most cases, you can use this value instead of the session policy to lock down the associated access to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
|
678
1068
|
*/
|
679
1069
|
HomeDirectoryMappings?: HomeDirectoryMappings;
|
680
1070
|
/**
|
681
|
-
* The type of landing directory (folder) you want your users' home directory to be when they log
|
1071
|
+
* The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
|
682
1072
|
*/
|
683
1073
|
HomeDirectoryType?: HomeDirectoryType;
|
684
1074
|
/**
|
685
|
-
* A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
|
1075
|
+
* 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 access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
|
686
1076
|
*/
|
687
1077
|
Policy?: Policy;
|
688
1078
|
PosixProfile?: PosixProfile;
|
689
1079
|
/**
|
690
|
-
*
|
1080
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
|
691
1081
|
*/
|
692
1082
|
Role?: Role;
|
693
1083
|
/**
|
694
|
-
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using
|
1084
|
+
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of your Active Directory group. The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
|
695
1085
|
*/
|
696
1086
|
ExternalId?: ExternalId;
|
697
1087
|
}
|
1088
|
+
export interface DescribedAgreement {
|
1089
|
+
/**
|
1090
|
+
* The unique Amazon Resource Name (ARN) for the agreement.
|
1091
|
+
*/
|
1092
|
+
Arn: Arn;
|
1093
|
+
/**
|
1094
|
+
* A unique identifier for the agreement. This identifier is returned when you create an agreement.
|
1095
|
+
*/
|
1096
|
+
AgreementId?: AgreementId;
|
1097
|
+
/**
|
1098
|
+
* The name or short description that's used to identify the agreement.
|
1099
|
+
*/
|
1100
|
+
Description?: Description;
|
1101
|
+
/**
|
1102
|
+
* The current status of the agreement, either ACTIVE or INACTIVE.
|
1103
|
+
*/
|
1104
|
+
Status?: AgreementStatusType;
|
1105
|
+
/**
|
1106
|
+
* A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.
|
1107
|
+
*/
|
1108
|
+
ServerId?: ServerId;
|
1109
|
+
/**
|
1110
|
+
* A unique identifier for the AS2 process.
|
1111
|
+
*/
|
1112
|
+
LocalProfileId?: ProfileId;
|
1113
|
+
/**
|
1114
|
+
* A unique identifier for the partner in the agreement.
|
1115
|
+
*/
|
1116
|
+
PartnerProfileId?: ProfileId;
|
1117
|
+
/**
|
1118
|
+
* The landing directory (folder) for files that are transferred by using the AS2 protocol.
|
1119
|
+
*/
|
1120
|
+
BaseDirectory?: HomeDirectory;
|
1121
|
+
/**
|
1122
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users' Amazon S3 buckets.
|
1123
|
+
*/
|
1124
|
+
AccessRole?: Role;
|
1125
|
+
/**
|
1126
|
+
* Key-value pairs that can be used to group and search for agreements.
|
1127
|
+
*/
|
1128
|
+
Tags?: Tags;
|
1129
|
+
}
|
1130
|
+
export interface DescribedCertificate {
|
1131
|
+
/**
|
1132
|
+
* The unique Amazon Resource Name (ARN) for the certificate.
|
1133
|
+
*/
|
1134
|
+
Arn: Arn;
|
1135
|
+
/**
|
1136
|
+
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
|
1137
|
+
*/
|
1138
|
+
CertificateId?: CertificateId;
|
1139
|
+
/**
|
1140
|
+
* Specifies whether this certificate is used for signing or encryption.
|
1141
|
+
*/
|
1142
|
+
Usage?: CertificateUsageType;
|
1143
|
+
/**
|
1144
|
+
* The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.
|
1145
|
+
*/
|
1146
|
+
Status?: CertificateStatusType;
|
1147
|
+
/**
|
1148
|
+
* The file name for the certificate.
|
1149
|
+
*/
|
1150
|
+
Certificate?: CertificateBodyType;
|
1151
|
+
/**
|
1152
|
+
* The list of certificates that make up the chain for the certificate.
|
1153
|
+
*/
|
1154
|
+
CertificateChain?: CertificateChainType;
|
1155
|
+
/**
|
1156
|
+
* An optional date that specifies when the certificate becomes active.
|
1157
|
+
*/
|
1158
|
+
ActiveDate?: CertDate;
|
1159
|
+
/**
|
1160
|
+
* An optional date that specifies when the certificate becomes inactive.
|
1161
|
+
*/
|
1162
|
+
InactiveDate?: CertDate;
|
1163
|
+
/**
|
1164
|
+
* The serial number for the certificate.
|
1165
|
+
*/
|
1166
|
+
Serial?: CertSerial;
|
1167
|
+
/**
|
1168
|
+
* The earliest date that the certificate is valid.
|
1169
|
+
*/
|
1170
|
+
NotBeforeDate?: CertDate;
|
1171
|
+
/**
|
1172
|
+
* The final date that the certificate is valid.
|
1173
|
+
*/
|
1174
|
+
NotAfterDate?: CertDate;
|
1175
|
+
/**
|
1176
|
+
* If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.
|
1177
|
+
*/
|
1178
|
+
Type?: CertificateType;
|
1179
|
+
/**
|
1180
|
+
* The name or description that's used to identity the certificate.
|
1181
|
+
*/
|
1182
|
+
Description?: Description;
|
1183
|
+
/**
|
1184
|
+
* Key-value pairs that can be used to group and search for certificates.
|
1185
|
+
*/
|
1186
|
+
Tags?: Tags;
|
1187
|
+
}
|
1188
|
+
export interface DescribedConnector {
|
1189
|
+
/**
|
1190
|
+
* The unique Amazon Resource Name (ARN) for the connector.
|
1191
|
+
*/
|
1192
|
+
Arn: Arn;
|
1193
|
+
/**
|
1194
|
+
* The unique identifier for the connector.
|
1195
|
+
*/
|
1196
|
+
ConnectorId?: ConnectorId;
|
1197
|
+
/**
|
1198
|
+
* The URL of the partner's AS2 endpoint.
|
1199
|
+
*/
|
1200
|
+
Url?: Url;
|
1201
|
+
/**
|
1202
|
+
* A structure that contains the parameters for a connector object.
|
1203
|
+
*/
|
1204
|
+
As2Config?: As2ConnectorConfig;
|
1205
|
+
/**
|
1206
|
+
* With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.
|
1207
|
+
*/
|
1208
|
+
AccessRole?: Role;
|
1209
|
+
/**
|
1210
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
|
1211
|
+
*/
|
1212
|
+
LoggingRole?: Role;
|
1213
|
+
/**
|
1214
|
+
* Key-value pairs that can be used to group and search for connectors.
|
1215
|
+
*/
|
1216
|
+
Tags?: Tags;
|
1217
|
+
}
|
698
1218
|
export interface DescribedExecution {
|
699
1219
|
/**
|
700
1220
|
* A unique identifier for the execution of a workflow.
|
@@ -705,7 +1225,7 @@ declare namespace Transfer {
|
|
705
1225
|
*/
|
706
1226
|
InitialFileLocation?: FileLocation;
|
707
1227
|
/**
|
708
|
-
* A container object for the session details associated with a workflow.
|
1228
|
+
* A container object for the session details that are associated with a workflow.
|
709
1229
|
*/
|
710
1230
|
ServiceMetadata?: ServiceMetadata;
|
711
1231
|
/**
|
@@ -726,6 +1246,32 @@ declare namespace Transfer {
|
|
726
1246
|
*/
|
727
1247
|
Results?: ExecutionResults;
|
728
1248
|
}
|
1249
|
+
export interface DescribedProfile {
|
1250
|
+
/**
|
1251
|
+
* The unique Amazon Resource Name (ARN) for the profile.
|
1252
|
+
*/
|
1253
|
+
Arn: Arn;
|
1254
|
+
/**
|
1255
|
+
* A unique identifier for the local or partner AS2 profile.
|
1256
|
+
*/
|
1257
|
+
ProfileId?: ProfileId;
|
1258
|
+
/**
|
1259
|
+
* Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.
|
1260
|
+
*/
|
1261
|
+
ProfileType?: ProfileType;
|
1262
|
+
/**
|
1263
|
+
* The unique identifier for the AS2 process.
|
1264
|
+
*/
|
1265
|
+
As2Id?: As2Id;
|
1266
|
+
/**
|
1267
|
+
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
|
1268
|
+
*/
|
1269
|
+
CertificateIds?: CertificateIds;
|
1270
|
+
/**
|
1271
|
+
* Key-value pairs that can be used to group and search for profiles.
|
1272
|
+
*/
|
1273
|
+
Tags?: Tags;
|
1274
|
+
}
|
729
1275
|
export interface DescribedSecurityPolicy {
|
730
1276
|
/**
|
731
1277
|
* Specifies whether this policy enables Federal Information Processing Standards (FIPS).
|
@@ -770,7 +1316,7 @@ declare namespace Transfer {
|
|
770
1316
|
*/
|
771
1317
|
Domain?: Domain;
|
772
1318
|
/**
|
773
|
-
* The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make
|
1319
|
+
* The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
|
774
1320
|
*/
|
775
1321
|
EndpointDetails?: EndpointDetails;
|
776
1322
|
/**
|
@@ -786,19 +1332,19 @@ declare namespace Transfer {
|
|
786
1332
|
*/
|
787
1333
|
IdentityProviderDetails?: IdentityProviderDetails;
|
788
1334
|
/**
|
789
|
-
*
|
1335
|
+
* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter or the IdentityProviderDetails data type.
|
790
1336
|
*/
|
791
1337
|
IdentityProviderType?: IdentityProviderType;
|
792
1338
|
/**
|
793
|
-
*
|
1339
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
|
794
1340
|
*/
|
795
1341
|
LoggingRole?: Role;
|
796
1342
|
/**
|
797
|
-
*
|
1343
|
+
* Specifies a string to display when users connect to a server. This string is displayed after the user authenticates. The SFTP protocol does not support post-authentication display banners.
|
798
1344
|
*/
|
799
1345
|
PostAuthenticationLoginBanner?: PostAuthenticationLoginBanner;
|
800
1346
|
/**
|
801
|
-
*
|
1347
|
+
* Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system: This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
|
802
1348
|
*/
|
803
1349
|
PreAuthenticationLoginBanner?: PreAuthenticationLoginBanner;
|
804
1350
|
/**
|
@@ -814,7 +1360,7 @@ declare namespace Transfer {
|
|
814
1360
|
*/
|
815
1361
|
ServerId?: ServerId;
|
816
1362
|
/**
|
817
|
-
*
|
1363
|
+
* The condition of the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
|
818
1364
|
*/
|
819
1365
|
State?: State;
|
820
1366
|
/**
|
@@ -826,7 +1372,7 @@ declare namespace Transfer {
|
|
826
1372
|
*/
|
827
1373
|
UserCount?: UserCount;
|
828
1374
|
/**
|
829
|
-
* Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
|
1375
|
+
* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
|
830
1376
|
*/
|
831
1377
|
WorkflowDetails?: WorkflowDetails;
|
832
1378
|
}
|
@@ -840,15 +1386,15 @@ declare namespace Transfer {
|
|
840
1386
|
*/
|
841
1387
|
HomeDirectory?: HomeDirectory;
|
842
1388
|
/**
|
843
|
-
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your
|
1389
|
+
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL. In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
|
844
1390
|
*/
|
845
1391
|
HomeDirectoryMappings?: HomeDirectoryMappings;
|
846
1392
|
/**
|
847
|
-
* The type of landing directory (folder) you want your users' home directory to be when they log
|
1393
|
+
* The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
|
848
1394
|
*/
|
849
1395
|
HomeDirectoryType?: HomeDirectoryType;
|
850
1396
|
/**
|
851
|
-
* A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
|
1397
|
+
* 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 access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
|
852
1398
|
*/
|
853
1399
|
Policy?: Policy;
|
854
1400
|
/**
|
@@ -856,7 +1402,7 @@ declare namespace Transfer {
|
|
856
1402
|
*/
|
857
1403
|
PosixProfile?: PosixProfile;
|
858
1404
|
/**
|
859
|
-
*
|
1405
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
|
860
1406
|
*/
|
861
1407
|
Role?: Role;
|
862
1408
|
/**
|
@@ -898,6 +1444,7 @@ declare namespace Transfer {
|
|
898
1444
|
*/
|
899
1445
|
Tags?: Tags;
|
900
1446
|
}
|
1447
|
+
export type Description = string;
|
901
1448
|
export type DirectoryId = string;
|
902
1449
|
export type Domain = "S3"|"EFS"|string;
|
903
1450
|
export interface EfsFileLocation {
|
@@ -912,6 +1459,7 @@ declare namespace Transfer {
|
|
912
1459
|
}
|
913
1460
|
export type EfsFileSystemId = string;
|
914
1461
|
export type EfsPath = string;
|
1462
|
+
export type EncryptionAlg = "AES128_CBC"|"AES192_CBC"|"AES256_CBC"|string;
|
915
1463
|
export interface EndpointDetails {
|
916
1464
|
/**
|
917
1465
|
* A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint. This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.
|
@@ -961,7 +1509,7 @@ declare namespace Transfer {
|
|
961
1509
|
export type ExecutionStatus = "IN_PROGRESS"|"COMPLETED"|"EXCEPTION"|"HANDLING_EXCEPTION"|string;
|
962
1510
|
export interface ExecutionStepResult {
|
963
1511
|
/**
|
964
|
-
* One of the available step types. COPY:
|
1512
|
+
* One of the available step types. COPY: Copy the file to another location. CUSTOM: Perform a custom step with an Lambda function target. DELETE: Delete the file. TAG: Add a tag to the file.
|
965
1513
|
*/
|
966
1514
|
StepType?: WorkflowStepType;
|
967
1515
|
/**
|
@@ -969,7 +1517,7 @@ declare namespace Transfer {
|
|
969
1517
|
*/
|
970
1518
|
Outputs?: StepResultOutputsJson;
|
971
1519
|
/**
|
972
|
-
* Specifies the details for an error, if it occurred during execution of the specified
|
1520
|
+
* Specifies the details for an error, if it occurred during execution of the specified workflow step.
|
973
1521
|
*/
|
974
1522
|
Error?: ExecutionError;
|
975
1523
|
}
|
@@ -977,7 +1525,7 @@ declare namespace Transfer {
|
|
977
1525
|
export type ExternalId = string;
|
978
1526
|
export interface FileLocation {
|
979
1527
|
/**
|
980
|
-
* Specifies the S3 details for the file being used, such as bucket,
|
1528
|
+
* Specifies the S3 details for the file being used, such as bucket, ETag, and so forth.
|
981
1529
|
*/
|
982
1530
|
S3FileLocation?: S3FileLocation;
|
983
1531
|
/**
|
@@ -985,6 +1533,8 @@ declare namespace Transfer {
|
|
985
1533
|
*/
|
986
1534
|
EfsFileLocation?: EfsFileLocation;
|
987
1535
|
}
|
1536
|
+
export type FilePath = string;
|
1537
|
+
export type FilePaths = FilePath[];
|
988
1538
|
export type Fips = boolean;
|
989
1539
|
export type Function = string;
|
990
1540
|
export type HomeDirectory = string;
|
@@ -1012,7 +1562,7 @@ declare namespace Transfer {
|
|
1012
1562
|
*/
|
1013
1563
|
InvocationRole?: Role;
|
1014
1564
|
/**
|
1015
|
-
* The identifier of the
|
1565
|
+
* The identifier of the Directory Service directory that you want to stop sharing.
|
1016
1566
|
*/
|
1017
1567
|
DirectoryId?: DirectoryId;
|
1018
1568
|
/**
|
@@ -1021,6 +1571,46 @@ declare namespace Transfer {
|
|
1021
1571
|
Function?: Function;
|
1022
1572
|
}
|
1023
1573
|
export type IdentityProviderType = "SERVICE_MANAGED"|"API_GATEWAY"|"AWS_DIRECTORY_SERVICE"|"AWS_LAMBDA"|string;
|
1574
|
+
export interface ImportCertificateRequest {
|
1575
|
+
/**
|
1576
|
+
* Specifies whether this certificate is used for signing or encryption.
|
1577
|
+
*/
|
1578
|
+
Usage: CertificateUsageType;
|
1579
|
+
/**
|
1580
|
+
* The file that contains the certificate to import.
|
1581
|
+
*/
|
1582
|
+
Certificate: CertificateBodyType;
|
1583
|
+
/**
|
1584
|
+
* An optional list of certificates that make up the chain for the certificate that's being imported.
|
1585
|
+
*/
|
1586
|
+
CertificateChain?: CertificateChainType;
|
1587
|
+
/**
|
1588
|
+
* The file that contains the private key for the certificate that's being imported.
|
1589
|
+
*/
|
1590
|
+
PrivateKey?: PrivateKeyType;
|
1591
|
+
/**
|
1592
|
+
* An optional date that specifies when the certificate becomes active.
|
1593
|
+
*/
|
1594
|
+
ActiveDate?: CertDate;
|
1595
|
+
/**
|
1596
|
+
* An optional date that specifies when the certificate becomes inactive.
|
1597
|
+
*/
|
1598
|
+
InactiveDate?: CertDate;
|
1599
|
+
/**
|
1600
|
+
* A short description that helps identify the certificate.
|
1601
|
+
*/
|
1602
|
+
Description?: Description;
|
1603
|
+
/**
|
1604
|
+
* Key-value pairs that can be used to group and search for certificates.
|
1605
|
+
*/
|
1606
|
+
Tags?: Tags;
|
1607
|
+
}
|
1608
|
+
export interface ImportCertificateResponse {
|
1609
|
+
/**
|
1610
|
+
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
|
1611
|
+
*/
|
1612
|
+
CertificateId: CertificateId;
|
1613
|
+
}
|
1024
1614
|
export interface ImportSshPublicKeyRequest {
|
1025
1615
|
/**
|
1026
1616
|
* A system-assigned unique identifier for a server.
|
@@ -1087,13 +1677,77 @@ declare namespace Transfer {
|
|
1087
1677
|
*/
|
1088
1678
|
Accesses: ListedAccesses;
|
1089
1679
|
}
|
1680
|
+
export interface ListAgreementsRequest {
|
1681
|
+
/**
|
1682
|
+
* The maximum number of agreements to return.
|
1683
|
+
*/
|
1684
|
+
MaxResults?: MaxResults;
|
1685
|
+
/**
|
1686
|
+
* When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.
|
1687
|
+
*/
|
1688
|
+
NextToken?: NextToken;
|
1689
|
+
/**
|
1690
|
+
* The identifier of the server for which you want a list of agreements.
|
1691
|
+
*/
|
1692
|
+
ServerId: ServerId;
|
1693
|
+
}
|
1694
|
+
export interface ListAgreementsResponse {
|
1695
|
+
/**
|
1696
|
+
* Returns a token that you can use to call ListAgreements again and receive additional results, if there are any.
|
1697
|
+
*/
|
1698
|
+
NextToken?: NextToken;
|
1699
|
+
/**
|
1700
|
+
* Returns an array, where each item contains the details of an agreement.
|
1701
|
+
*/
|
1702
|
+
Agreements: ListedAgreements;
|
1703
|
+
}
|
1704
|
+
export interface ListCertificatesRequest {
|
1705
|
+
/**
|
1706
|
+
* The maximum number of certificates to return.
|
1707
|
+
*/
|
1708
|
+
MaxResults?: MaxResults;
|
1709
|
+
/**
|
1710
|
+
* When you can get additional results from the ListCertificates call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional certificates.
|
1711
|
+
*/
|
1712
|
+
NextToken?: NextToken;
|
1713
|
+
}
|
1714
|
+
export interface ListCertificatesResponse {
|
1715
|
+
/**
|
1716
|
+
* Returns the next token, which you can use to list the next certificate.
|
1717
|
+
*/
|
1718
|
+
NextToken?: NextToken;
|
1719
|
+
/**
|
1720
|
+
* Returns an array of the certificates that are specified in the ListCertificates call.
|
1721
|
+
*/
|
1722
|
+
Certificates: ListedCertificates;
|
1723
|
+
}
|
1724
|
+
export interface ListConnectorsRequest {
|
1725
|
+
/**
|
1726
|
+
* The maximum number of connectors to return.
|
1727
|
+
*/
|
1728
|
+
MaxResults?: MaxResults;
|
1729
|
+
/**
|
1730
|
+
* When you can get additional results from the ListConnectors call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional connectors.
|
1731
|
+
*/
|
1732
|
+
NextToken?: NextToken;
|
1733
|
+
}
|
1734
|
+
export interface ListConnectorsResponse {
|
1735
|
+
/**
|
1736
|
+
* Returns a token that you can use to call ListConnectors again and receive additional results, if there are any.
|
1737
|
+
*/
|
1738
|
+
NextToken?: NextToken;
|
1739
|
+
/**
|
1740
|
+
* Returns an array, where each item contains the details of a connector.
|
1741
|
+
*/
|
1742
|
+
Connectors: ListedConnectors;
|
1743
|
+
}
|
1090
1744
|
export interface ListExecutionsRequest {
|
1091
1745
|
/**
|
1092
|
-
* Specifies the
|
1746
|
+
* Specifies the maximum number of executions to return.
|
1093
1747
|
*/
|
1094
1748
|
MaxResults?: MaxResults;
|
1095
1749
|
/**
|
1096
|
-
* ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions. This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so,
|
1750
|
+
* ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions. This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the max-results: aws transfer list-executions --max-results 10 This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, supplying the NextToken value you received: aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.
|
1097
1751
|
*/
|
1098
1752
|
NextToken?: NextToken;
|
1099
1753
|
/**
|
@@ -1115,6 +1769,30 @@ declare namespace Transfer {
|
|
1115
1769
|
*/
|
1116
1770
|
Executions: ListedExecutions;
|
1117
1771
|
}
|
1772
|
+
export interface ListProfilesRequest {
|
1773
|
+
/**
|
1774
|
+
* The maximum number of profiles to return.
|
1775
|
+
*/
|
1776
|
+
MaxResults?: MaxResults;
|
1777
|
+
/**
|
1778
|
+
* When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results.
|
1779
|
+
*/
|
1780
|
+
NextToken?: NextToken;
|
1781
|
+
/**
|
1782
|
+
* Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.
|
1783
|
+
*/
|
1784
|
+
ProfileType?: ProfileType;
|
1785
|
+
}
|
1786
|
+
export interface ListProfilesResponse {
|
1787
|
+
/**
|
1788
|
+
* Returns a token that you can use to call ListProfiles again and receive additional results, if there are any.
|
1789
|
+
*/
|
1790
|
+
NextToken?: NextToken;
|
1791
|
+
/**
|
1792
|
+
* Returns an array, where each item contains the details of a profile.
|
1793
|
+
*/
|
1794
|
+
Profiles: ListedProfiles;
|
1795
|
+
}
|
1118
1796
|
export interface ListSecurityPoliciesRequest {
|
1119
1797
|
/**
|
1120
1798
|
* Specifies the number of security policies to return as a response to the ListSecurityPolicies query.
|
@@ -1237,19 +1915,100 @@ declare namespace Transfer {
|
|
1237
1915
|
*/
|
1238
1916
|
HomeDirectory?: HomeDirectory;
|
1239
1917
|
/**
|
1240
|
-
* The type of landing directory (folder) you want your users' home directory to be when they log
|
1918
|
+
* The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
|
1241
1919
|
*/
|
1242
1920
|
HomeDirectoryType?: HomeDirectoryType;
|
1243
1921
|
/**
|
1244
|
-
*
|
1922
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
|
1245
1923
|
*/
|
1246
1924
|
Role?: Role;
|
1247
1925
|
/**
|
1248
|
-
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using
|
1926
|
+
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of your Active Directory group. The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
|
1249
1927
|
*/
|
1250
1928
|
ExternalId?: ExternalId;
|
1251
1929
|
}
|
1252
1930
|
export type ListedAccesses = ListedAccess[];
|
1931
|
+
export interface ListedAgreement {
|
1932
|
+
/**
|
1933
|
+
* The Amazon Resource Name (ARN) of the specified agreement.
|
1934
|
+
*/
|
1935
|
+
Arn?: Arn;
|
1936
|
+
/**
|
1937
|
+
* A unique identifier for the agreement. This identifier is returned when you create an agreement.
|
1938
|
+
*/
|
1939
|
+
AgreementId?: AgreementId;
|
1940
|
+
/**
|
1941
|
+
* The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.
|
1942
|
+
*/
|
1943
|
+
Description?: Description;
|
1944
|
+
/**
|
1945
|
+
* The agreement can be either ACTIVE or INACTIVE.
|
1946
|
+
*/
|
1947
|
+
Status?: AgreementStatusType;
|
1948
|
+
/**
|
1949
|
+
* The unique identifier for the agreement.
|
1950
|
+
*/
|
1951
|
+
ServerId?: ServerId;
|
1952
|
+
/**
|
1953
|
+
* A unique identifier for the AS2 process.
|
1954
|
+
*/
|
1955
|
+
LocalProfileId?: ProfileId;
|
1956
|
+
/**
|
1957
|
+
* A unique identifier for the partner process.
|
1958
|
+
*/
|
1959
|
+
PartnerProfileId?: ProfileId;
|
1960
|
+
}
|
1961
|
+
export type ListedAgreements = ListedAgreement[];
|
1962
|
+
export interface ListedCertificate {
|
1963
|
+
/**
|
1964
|
+
* The Amazon Resource Name (ARN) of the specified certificate.
|
1965
|
+
*/
|
1966
|
+
Arn?: Arn;
|
1967
|
+
/**
|
1968
|
+
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
|
1969
|
+
*/
|
1970
|
+
CertificateId?: CertificateId;
|
1971
|
+
/**
|
1972
|
+
* Specifies whether this certificate is used for signing or encryption.
|
1973
|
+
*/
|
1974
|
+
Usage?: CertificateUsageType;
|
1975
|
+
/**
|
1976
|
+
* The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.
|
1977
|
+
*/
|
1978
|
+
Status?: CertificateStatusType;
|
1979
|
+
/**
|
1980
|
+
* An optional date that specifies when the certificate becomes active.
|
1981
|
+
*/
|
1982
|
+
ActiveDate?: CertDate;
|
1983
|
+
/**
|
1984
|
+
* An optional date that specifies when the certificate becomes inactive.
|
1985
|
+
*/
|
1986
|
+
InactiveDate?: CertDate;
|
1987
|
+
/**
|
1988
|
+
* The type for the certificate. If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.
|
1989
|
+
*/
|
1990
|
+
Type?: CertificateType;
|
1991
|
+
/**
|
1992
|
+
* The name or short description that's used to identify the certificate.
|
1993
|
+
*/
|
1994
|
+
Description?: Description;
|
1995
|
+
}
|
1996
|
+
export type ListedCertificates = ListedCertificate[];
|
1997
|
+
export interface ListedConnector {
|
1998
|
+
/**
|
1999
|
+
* The Amazon Resource Name (ARN) of the specified connector.
|
2000
|
+
*/
|
2001
|
+
Arn?: Arn;
|
2002
|
+
/**
|
2003
|
+
* The unique identifier for the connector.
|
2004
|
+
*/
|
2005
|
+
ConnectorId?: ConnectorId;
|
2006
|
+
/**
|
2007
|
+
* The URL of the partner's AS2 endpoint.
|
2008
|
+
*/
|
2009
|
+
Url?: Url;
|
2010
|
+
}
|
2011
|
+
export type ListedConnectors = ListedConnector[];
|
1253
2012
|
export interface ListedExecution {
|
1254
2013
|
/**
|
1255
2014
|
* A unique identifier for the execution of a workflow.
|
@@ -1260,7 +2019,7 @@ declare namespace Transfer {
|
|
1260
2019
|
*/
|
1261
2020
|
InitialFileLocation?: FileLocation;
|
1262
2021
|
/**
|
1263
|
-
* A container object for the session details associated with a workflow.
|
2022
|
+
* A container object for the session details that are associated with a workflow.
|
1264
2023
|
*/
|
1265
2024
|
ServiceMetadata?: ServiceMetadata;
|
1266
2025
|
/**
|
@@ -1269,6 +2028,25 @@ declare namespace Transfer {
|
|
1269
2028
|
Status?: ExecutionStatus;
|
1270
2029
|
}
|
1271
2030
|
export type ListedExecutions = ListedExecution[];
|
2031
|
+
export interface ListedProfile {
|
2032
|
+
/**
|
2033
|
+
* The Amazon Resource Name (ARN) of the specified profile.
|
2034
|
+
*/
|
2035
|
+
Arn?: Arn;
|
2036
|
+
/**
|
2037
|
+
* A unique identifier for the local or partner AS2 profile.
|
2038
|
+
*/
|
2039
|
+
ProfileId?: ProfileId;
|
2040
|
+
/**
|
2041
|
+
* The unique identifier for the AS2 process.
|
2042
|
+
*/
|
2043
|
+
As2Id?: As2Id;
|
2044
|
+
/**
|
2045
|
+
* Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.
|
2046
|
+
*/
|
2047
|
+
ProfileType?: ProfileType;
|
2048
|
+
}
|
2049
|
+
export type ListedProfiles = ListedProfile[];
|
1272
2050
|
export interface ListedServer {
|
1273
2051
|
/**
|
1274
2052
|
* Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
|
@@ -1279,7 +2057,7 @@ declare namespace Transfer {
|
|
1279
2057
|
*/
|
1280
2058
|
Domain?: Domain;
|
1281
2059
|
/**
|
1282
|
-
*
|
2060
|
+
* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter or the IdentityProviderDetails data type.
|
1283
2061
|
*/
|
1284
2062
|
IdentityProviderType?: IdentityProviderType;
|
1285
2063
|
/**
|
@@ -1287,7 +2065,7 @@ declare namespace Transfer {
|
|
1287
2065
|
*/
|
1288
2066
|
EndpointType?: EndpointType;
|
1289
2067
|
/**
|
1290
|
-
*
|
2068
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
|
1291
2069
|
*/
|
1292
2070
|
LoggingRole?: Role;
|
1293
2071
|
/**
|
@@ -1295,7 +2073,7 @@ declare namespace Transfer {
|
|
1295
2073
|
*/
|
1296
2074
|
ServerId?: ServerId;
|
1297
2075
|
/**
|
1298
|
-
*
|
2076
|
+
* The condition of the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
|
1299
2077
|
*/
|
1300
2078
|
State?: State;
|
1301
2079
|
/**
|
@@ -1314,11 +2092,11 @@ declare namespace Transfer {
|
|
1314
2092
|
*/
|
1315
2093
|
HomeDirectory?: HomeDirectory;
|
1316
2094
|
/**
|
1317
|
-
* The type of landing directory (folder) you want your users' home directory to be when they log
|
2095
|
+
* The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
|
1318
2096
|
*/
|
1319
2097
|
HomeDirectoryType?: HomeDirectoryType;
|
1320
2098
|
/**
|
1321
|
-
*
|
2099
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests. The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS. The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
|
1322
2100
|
*/
|
1323
2101
|
Role?: Role;
|
1324
2102
|
/**
|
@@ -1349,18 +2127,21 @@ declare namespace Transfer {
|
|
1349
2127
|
export type LogGroupName = string;
|
1350
2128
|
export interface LoggingConfiguration {
|
1351
2129
|
/**
|
1352
|
-
*
|
2130
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
|
1353
2131
|
*/
|
1354
2132
|
LoggingRole?: Role;
|
1355
2133
|
/**
|
1356
|
-
* The name of the CloudWatch logging group for the
|
2134
|
+
* The name of the CloudWatch logging group for the Transfer Family server to which this workflow belongs.
|
1357
2135
|
*/
|
1358
2136
|
LogGroupName?: LogGroupName;
|
1359
2137
|
}
|
1360
2138
|
export type MapEntry = string;
|
1361
2139
|
export type MapTarget = string;
|
1362
2140
|
export type MaxResults = number;
|
2141
|
+
export type MdnResponse = "SYNC"|"NONE"|string;
|
2142
|
+
export type MdnSigningAlg = "SHA256"|"SHA384"|"SHA512"|"SHA1"|"NONE"|"DEFAULT"|string;
|
1363
2143
|
export type Message = string;
|
2144
|
+
export type MessageSubject = string;
|
1364
2145
|
export type NextToken = string;
|
1365
2146
|
export type NullableRole = string;
|
1366
2147
|
export type OnUploadWorkflowDetails = WorkflowDetail[];
|
@@ -1384,7 +2165,10 @@ declare namespace Transfer {
|
|
1384
2165
|
}
|
1385
2166
|
export type PostAuthenticationLoginBanner = string;
|
1386
2167
|
export type PreAuthenticationLoginBanner = string;
|
1387
|
-
export type
|
2168
|
+
export type PrivateKeyType = string;
|
2169
|
+
export type ProfileId = string;
|
2170
|
+
export type ProfileType = "LOCAL"|"PARTNER"|string;
|
2171
|
+
export type Protocol = "SFTP"|"FTP"|"FTPS"|"AS2"|string;
|
1388
2172
|
export interface ProtocolDetails {
|
1389
2173
|
/**
|
1390
2174
|
* Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer. For example: aws transfer update-server --protocol-details PassiveIp=0.0.0.0 Replace 0.0.0.0 in the example above with the actual IP address you want to use. If you change the PassiveIp value, you must stop and then restart your Transfer Family server for the change to take effect. For details on using passive mode (PASV) in a NAT environment, see Configuring your FTPS server behind a firewall or NAT with Transfer Family.
|
@@ -1398,6 +2182,10 @@ declare namespace Transfer {
|
|
1398
2182
|
* Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket. Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as SETSTAT when uploading the file. However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when the file is otherwise successfully uploaded. Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client. While the SetStatOption ENABLE_NO_OP setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a SETSTAT call. If you want to preserve the original timestamp for your file, and modify other file attributes using SETSTAT, you can use Amazon EFS as backend storage with Transfer Family.
|
1399
2183
|
*/
|
1400
2184
|
SetStatOption?: SetStatOption;
|
2185
|
+
/**
|
2186
|
+
* Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
|
2187
|
+
*/
|
2188
|
+
As2Transports?: As2Transports;
|
1401
2189
|
}
|
1402
2190
|
export type Protocols = Protocol[];
|
1403
2191
|
export type Response = string;
|
@@ -1410,7 +2198,7 @@ declare namespace Transfer {
|
|
1410
2198
|
*/
|
1411
2199
|
Bucket?: S3Bucket;
|
1412
2200
|
/**
|
1413
|
-
* The name assigned to the file when it was created in S3. You use the object key to retrieve the object.
|
2201
|
+
* The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.
|
1414
2202
|
*/
|
1415
2203
|
Key?: S3Key;
|
1416
2204
|
/**
|
@@ -1428,7 +2216,7 @@ declare namespace Transfer {
|
|
1428
2216
|
*/
|
1429
2217
|
Bucket?: S3Bucket;
|
1430
2218
|
/**
|
1431
|
-
* The name assigned to the file when it was created in S3. You use the object key to retrieve the object.
|
2219
|
+
* The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.
|
1432
2220
|
*/
|
1433
2221
|
Key?: S3Key;
|
1434
2222
|
}
|
@@ -1483,6 +2271,7 @@ declare namespace Transfer {
|
|
1483
2271
|
}
|
1484
2272
|
export type SessionId = string;
|
1485
2273
|
export type SetStatOption = "DEFAULT"|"ENABLE_NO_OP"|string;
|
2274
|
+
export type SigningAlg = "SHA256"|"SHA384"|"SHA512"|"SHA1"|"NONE"|string;
|
1486
2275
|
export type SourceFileLocation = string;
|
1487
2276
|
export type SourceIp = string;
|
1488
2277
|
export interface SshPublicKey {
|
@@ -1503,6 +2292,22 @@ declare namespace Transfer {
|
|
1503
2292
|
export type SshPublicKeyCount = number;
|
1504
2293
|
export type SshPublicKeyId = string;
|
1505
2294
|
export type SshPublicKeys = SshPublicKey[];
|
2295
|
+
export interface StartFileTransferRequest {
|
2296
|
+
/**
|
2297
|
+
* The unique identifier for the connector.
|
2298
|
+
*/
|
2299
|
+
ConnectorId: ConnectorId;
|
2300
|
+
/**
|
2301
|
+
* An array of strings. Each string represents the absolute path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt .
|
2302
|
+
*/
|
2303
|
+
SendFilePaths: FilePaths;
|
2304
|
+
}
|
2305
|
+
export interface StartFileTransferResponse {
|
2306
|
+
/**
|
2307
|
+
* Returns the unique identifier for this file transfer.
|
2308
|
+
*/
|
2309
|
+
TransferId: TransferId;
|
2310
|
+
}
|
1506
2311
|
export interface StartServerRequest {
|
1507
2312
|
/**
|
1508
2313
|
* A system-assigned unique identifier for a server that you start.
|
@@ -1599,6 +2404,7 @@ declare namespace Transfer {
|
|
1599
2404
|
Url: Url;
|
1600
2405
|
}
|
1601
2406
|
export type TlsSessionResumptionMode = "DISABLED"|"ENABLED"|"ENFORCED"|string;
|
2407
|
+
export type TransferId = string;
|
1602
2408
|
export interface UntagResourceRequest {
|
1603
2409
|
/**
|
1604
2410
|
* The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.
|
@@ -1615,20 +2421,20 @@ declare namespace Transfer {
|
|
1615
2421
|
*/
|
1616
2422
|
HomeDirectory?: HomeDirectory;
|
1617
2423
|
/**
|
1618
|
-
* The type of landing directory (folder) you want your users' home directory to be when they log
|
2424
|
+
* The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
|
1619
2425
|
*/
|
1620
2426
|
HomeDirectoryType?: HomeDirectoryType;
|
1621
2427
|
/**
|
1622
|
-
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your
|
2428
|
+
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL. The following is an Entry and Target pair example. [ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ] In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("chroot"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value. The following is an Entry and Target pair example for chroot. [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
|
1623
2429
|
*/
|
1624
2430
|
HomeDirectoryMappings?: HomeDirectoryMappings;
|
1625
2431
|
/**
|
1626
|
-
* A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. This
|
2432
|
+
* 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 access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies. For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument. For an example of a session policy, see Example session policy. For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.
|
1627
2433
|
*/
|
1628
2434
|
Policy?: Policy;
|
1629
2435
|
PosixProfile?: PosixProfile;
|
1630
2436
|
/**
|
1631
|
-
*
|
2437
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
|
1632
2438
|
*/
|
1633
2439
|
Role?: Role;
|
1634
2440
|
/**
|
@@ -1636,7 +2442,7 @@ declare namespace Transfer {
|
|
1636
2442
|
*/
|
1637
2443
|
ServerId: ServerId;
|
1638
2444
|
/**
|
1639
|
-
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using
|
2445
|
+
* A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of your Active Directory group. The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
|
1640
2446
|
*/
|
1641
2447
|
ExternalId: ExternalId;
|
1642
2448
|
}
|
@@ -1650,17 +2456,125 @@ declare namespace Transfer {
|
|
1650
2456
|
*/
|
1651
2457
|
ExternalId: ExternalId;
|
1652
2458
|
}
|
2459
|
+
export interface UpdateAgreementRequest {
|
2460
|
+
/**
|
2461
|
+
* A unique identifier for the agreement. This identifier is returned when you create an agreement.
|
2462
|
+
*/
|
2463
|
+
AgreementId: AgreementId;
|
2464
|
+
/**
|
2465
|
+
* A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
|
2466
|
+
*/
|
2467
|
+
ServerId: ServerId;
|
2468
|
+
/**
|
2469
|
+
* To replace the existing description, provide a short description for the agreement.
|
2470
|
+
*/
|
2471
|
+
Description?: Description;
|
2472
|
+
/**
|
2473
|
+
* You can update the status for the agreement, either activating an inactive agreement or the reverse.
|
2474
|
+
*/
|
2475
|
+
Status?: AgreementStatusType;
|
2476
|
+
/**
|
2477
|
+
* To change the local profile identifier, provide a new value here.
|
2478
|
+
*/
|
2479
|
+
LocalProfileId?: ProfileId;
|
2480
|
+
/**
|
2481
|
+
* To change the partner profile identifier, provide a new value here.
|
2482
|
+
*/
|
2483
|
+
PartnerProfileId?: ProfileId;
|
2484
|
+
/**
|
2485
|
+
* To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory .
|
2486
|
+
*/
|
2487
|
+
BaseDirectory?: HomeDirectory;
|
2488
|
+
/**
|
2489
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users' Amazon S3 buckets.
|
2490
|
+
*/
|
2491
|
+
AccessRole?: Role;
|
2492
|
+
}
|
2493
|
+
export interface UpdateAgreementResponse {
|
2494
|
+
/**
|
2495
|
+
* A unique identifier for the agreement. This identifier is returned when you create an agreement.
|
2496
|
+
*/
|
2497
|
+
AgreementId: AgreementId;
|
2498
|
+
}
|
2499
|
+
export interface UpdateCertificateRequest {
|
2500
|
+
/**
|
2501
|
+
* The identifier of the certificate object that you are updating.
|
2502
|
+
*/
|
2503
|
+
CertificateId: CertificateId;
|
2504
|
+
/**
|
2505
|
+
* An optional date that specifies when the certificate becomes active.
|
2506
|
+
*/
|
2507
|
+
ActiveDate?: CertDate;
|
2508
|
+
/**
|
2509
|
+
* An optional date that specifies when the certificate becomes inactive.
|
2510
|
+
*/
|
2511
|
+
InactiveDate?: CertDate;
|
2512
|
+
/**
|
2513
|
+
* A short description to help identify the certificate.
|
2514
|
+
*/
|
2515
|
+
Description?: Description;
|
2516
|
+
}
|
2517
|
+
export interface UpdateCertificateResponse {
|
2518
|
+
/**
|
2519
|
+
* Returns the identifier of the certificate object that you are updating.
|
2520
|
+
*/
|
2521
|
+
CertificateId: CertificateId;
|
2522
|
+
}
|
2523
|
+
export interface UpdateConnectorRequest {
|
2524
|
+
/**
|
2525
|
+
* The unique identifier for the connector.
|
2526
|
+
*/
|
2527
|
+
ConnectorId: ConnectorId;
|
2528
|
+
/**
|
2529
|
+
* The URL of the partner's AS2 endpoint.
|
2530
|
+
*/
|
2531
|
+
Url?: Url;
|
2532
|
+
/**
|
2533
|
+
* A structure that contains the parameters for a connector object.
|
2534
|
+
*/
|
2535
|
+
As2Config?: As2ConnectorConfig;
|
2536
|
+
/**
|
2537
|
+
* With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.
|
2538
|
+
*/
|
2539
|
+
AccessRole?: Role;
|
2540
|
+
/**
|
2541
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
|
2542
|
+
*/
|
2543
|
+
LoggingRole?: Role;
|
2544
|
+
}
|
2545
|
+
export interface UpdateConnectorResponse {
|
2546
|
+
/**
|
2547
|
+
* Returns the identifier of the connector object that you are updating.
|
2548
|
+
*/
|
2549
|
+
ConnectorId: ConnectorId;
|
2550
|
+
}
|
2551
|
+
export interface UpdateProfileRequest {
|
2552
|
+
/**
|
2553
|
+
* The identifier of the profile object that you are updating.
|
2554
|
+
*/
|
2555
|
+
ProfileId: ProfileId;
|
2556
|
+
/**
|
2557
|
+
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
|
2558
|
+
*/
|
2559
|
+
CertificateIds?: CertificateIds;
|
2560
|
+
}
|
2561
|
+
export interface UpdateProfileResponse {
|
2562
|
+
/**
|
2563
|
+
* Returns the identifier for the profile that's being updated.
|
2564
|
+
*/
|
2565
|
+
ProfileId: ProfileId;
|
2566
|
+
}
|
1653
2567
|
export interface UpdateServerRequest {
|
1654
2568
|
/**
|
1655
2569
|
* The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS. To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide. To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide. To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate Manager User Guide. Certificates with the following cryptographic algorithms and key sizes are supported: 2048-bit RSA (RSA_2048) 4096-bit RSA (RSA_4096) Elliptic Prime Curve 256 bit (EC_prime256v1) Elliptic Prime Curve 384 bit (EC_secp384r1) Elliptic Prime Curve 521 bit (EC_secp521r1) The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
|
1656
2570
|
*/
|
1657
2571
|
Certificate?: Certificate;
|
1658
2572
|
/**
|
1659
|
-
* The protocol settings that are configured for your server.
|
2573
|
+
* The protocol settings that are configured for your server. To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call. To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter. As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
|
1660
2574
|
*/
|
1661
2575
|
ProtocolDetails?: ProtocolDetails;
|
1662
2576
|
/**
|
1663
|
-
* The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make
|
2577
|
+
* The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
|
1664
2578
|
*/
|
1665
2579
|
EndpointDetails?: EndpointDetails;
|
1666
2580
|
/**
|
@@ -1668,7 +2582,7 @@ declare namespace Transfer {
|
|
1668
2582
|
*/
|
1669
2583
|
EndpointType?: EndpointType;
|
1670
2584
|
/**
|
1671
|
-
* The RSA, ECDSA, or ED25519 private key to use for your server. Use the following command to generate an RSA 2048 bit key with no passphrase: ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key. Use a minimum value of 2048 for the -b option
|
2585
|
+
* The RSA, ECDSA, or ED25519 private key to use for your server. Use the following command to generate an RSA 2048 bit key with no passphrase: ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key. Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096. Use the following command to generate an ECDSA 256 bit key with no passphrase: ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key. Valid values for the -b option for ECDSA are 256, 384, and 521. Use the following command to generate an ED25519 key with no passphrase: ssh-keygen -t ed25519 -N "" -f my-new-server-key. For all of these commands, you can replace my-new-server-key with a string of your choice. If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see Change the host key for your SFTP-enabled server in the Transfer Family User Guide.
|
1672
2586
|
*/
|
1673
2587
|
HostKey?: HostKey;
|
1674
2588
|
/**
|
@@ -1676,15 +2590,15 @@ declare namespace Transfer {
|
|
1676
2590
|
*/
|
1677
2591
|
IdentityProviderDetails?: IdentityProviderDetails;
|
1678
2592
|
/**
|
1679
|
-
*
|
2593
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
|
1680
2594
|
*/
|
1681
2595
|
LoggingRole?: NullableRole;
|
1682
2596
|
/**
|
1683
|
-
*
|
2597
|
+
* Specifies a string to display when users connect to a server. This string is displayed after the user authenticates. The SFTP protocol does not support post-authentication display banners.
|
1684
2598
|
*/
|
1685
2599
|
PostAuthenticationLoginBanner?: PostAuthenticationLoginBanner;
|
1686
2600
|
/**
|
1687
|
-
*
|
2601
|
+
* Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system: This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
|
1688
2602
|
*/
|
1689
2603
|
PreAuthenticationLoginBanner?: PreAuthenticationLoginBanner;
|
1690
2604
|
/**
|
@@ -1700,7 +2614,7 @@ declare namespace Transfer {
|
|
1700
2614
|
*/
|
1701
2615
|
ServerId: ServerId;
|
1702
2616
|
/**
|
1703
|
-
* Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow. To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example. aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
|
2617
|
+
* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example. aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
|
1704
2618
|
*/
|
1705
2619
|
WorkflowDetails?: WorkflowDetails;
|
1706
2620
|
}
|
@@ -1716,15 +2630,15 @@ declare namespace Transfer {
|
|
1716
2630
|
*/
|
1717
2631
|
HomeDirectory?: HomeDirectory;
|
1718
2632
|
/**
|
1719
|
-
* The type of landing directory (folder) you want your users' home directory to be when they log
|
2633
|
+
* The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
|
1720
2634
|
*/
|
1721
2635
|
HomeDirectoryType?: HomeDirectoryType;
|
1722
2636
|
/**
|
1723
|
-
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your
|
2637
|
+
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL. The following is an Entry and Target pair example. [ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ] In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value. The following is an Entry and Target pair example for chroot. [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
|
1724
2638
|
*/
|
1725
2639
|
HomeDirectoryMappings?: HomeDirectoryMappings;
|
1726
2640
|
/**
|
1727
|
-
* A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. This
|
2641
|
+
* 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 access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies. For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument. For an example of a session policy, see Creating a session policy. For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
|
1728
2642
|
*/
|
1729
2643
|
Policy?: Policy;
|
1730
2644
|
/**
|
@@ -1732,7 +2646,7 @@ declare namespace Transfer {
|
|
1732
2646
|
*/
|
1733
2647
|
PosixProfile?: PosixProfile;
|
1734
2648
|
/**
|
1735
|
-
*
|
2649
|
+
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
|
1736
2650
|
*/
|
1737
2651
|
Role?: Role;
|
1738
2652
|
/**
|
@@ -1794,7 +2708,7 @@ declare namespace Transfer {
|
|
1794
2708
|
export type WorkflowId = string;
|
1795
2709
|
export interface WorkflowStep {
|
1796
2710
|
/**
|
1797
|
-
* Currently, the following step types are supported. COPY:
|
2711
|
+
* Currently, the following step types are supported. COPY: Copy the file to another location. CUSTOM: Perform a custom step with an Lambda function target. DELETE: Delete the file. TAG: Add a tag to the file.
|
1798
2712
|
*/
|
1799
2713
|
Type?: WorkflowStepType;
|
1800
2714
|
/**
|