aws-sdk 2.768.0 → 2.772.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +40 -1
- package/README.md +1 -1
- package/apis/accessanalyzer-2019-11-01.min.json +70 -48
- package/apis/amplify-2017-07-25.min.json +58 -46
- package/apis/budgets-2016-10-20.min.json +411 -0
- package/apis/budgets-2016-10-20.paginators.json +18 -0
- package/apis/ce-2017-10-25.min.json +119 -87
- package/apis/dms-2016-01-01.min.json +15 -3
- package/apis/ec2-2016-11-15.min.json +33 -7
- package/apis/elasticache-2015-02-02.min.json +425 -106
- package/apis/elasticache-2015-02-02.paginators.json +12 -0
- package/apis/eventbridge-2015-10-07.min.json +20 -3
- package/apis/events-2015-10-07.min.json +20 -3
- package/apis/groundstation-2019-05-23.min.json +1 -0
- package/apis/iot-2015-05-28.min.json +4 -1
- package/apis/macie2-2020-01-01.min.json +159 -22
- package/apis/medialive-2017-10-14.min.json +366 -194
- package/apis/mediapackage-2017-10-12.min.json +214 -93
- package/apis/rds-2014-10-31.min.json +20 -2
- package/apis/rekognition-2016-06-27.min.json +206 -76
- package/apis/servicecatalog-2015-12-10.min.json +60 -30
- package/apis/servicecatalog-2015-12-10.paginators.json +5 -0
- package/apis/snowball-2016-06-30.min.json +61 -9
- package/apis/ssm-2014-11-06.min.json +147 -126
- package/apis/transfer-2018-11-05.min.json +32 -28
- package/apis/workmail-2017-10-01.min.json +93 -30
- package/apis/xray-2016-04-12.min.json +11 -5
- package/apis/xray-2016-04-12.paginators.json +0 -15
- package/clients/accessanalyzer.d.ts +26 -4
- package/clients/amplify.d.ts +17 -0
- package/clients/budgets.d.ts +358 -0
- package/clients/cloudwatchevents.d.ts +27 -0
- package/clients/computeoptimizer.d.ts +15 -15
- package/clients/costexplorer.d.ts +64 -12
- package/clients/dms.d.ts +26 -2
- package/clients/ec2.d.ts +28 -8
- package/clients/eks.d.ts +2 -2
- package/clients/elasticache.d.ts +416 -4
- package/clients/eventbridge.d.ts +27 -0
- package/clients/glue.d.ts +1 -1
- package/clients/groundstation.d.ts +5 -1
- package/clients/iot.d.ts +10 -6
- package/clients/macie2.d.ts +182 -62
- package/clients/medialive.d.ts +206 -4
- package/clients/mediapackage.d.ts +58 -0
- package/clients/rds.d.ts +26 -14
- package/clients/rekognition.d.ts +155 -14
- package/clients/sagemaker.d.ts +5 -5
- package/clients/servicecatalog.d.ts +66 -21
- package/clients/snowball.d.ts +122 -52
- package/clients/sns.d.ts +1 -1
- package/clients/ssm.d.ts +63 -11
- package/clients/transfer.d.ts +77 -71
- package/clients/workmail.d.ts +91 -1
- package/clients/workspaces.d.ts +12 -12
- package/clients/xray.d.ts +29 -21
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +27 -27
- package/dist/aws-sdk.js +1087 -483
- package/dist/aws-sdk.min.js +78 -78
- package/lib/config-base.d.ts +3 -0
- package/lib/core.d.ts +1 -1
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/transfer.d.ts
CHANGED
|
@@ -124,11 +124,11 @@ declare class Transfer extends Service {
|
|
|
124
124
|
*/
|
|
125
125
|
startServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
126
126
|
/**
|
|
127
|
-
* 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.
|
|
127
|
+
* 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 will 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.
|
|
128
128
|
*/
|
|
129
129
|
stopServer(params: Transfer.Types.StopServerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
130
130
|
/**
|
|
131
|
-
* 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.
|
|
131
|
+
* 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 will 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.
|
|
132
132
|
*/
|
|
133
133
|
stopServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
134
134
|
/**
|
|
@@ -183,11 +183,11 @@ declare namespace Transfer {
|
|
|
183
183
|
*/
|
|
184
184
|
Certificate?: Certificate;
|
|
185
185
|
/**
|
|
186
|
-
* The virtual private cloud (VPC) endpoint settings that are configured for your
|
|
186
|
+
* The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
|
|
187
187
|
*/
|
|
188
188
|
EndpointDetails?: EndpointDetails;
|
|
189
189
|
/**
|
|
190
|
-
* The type of VPC endpoint that you want your
|
|
190
|
+
* The type of VPC endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
|
|
191
191
|
*/
|
|
192
192
|
EndpointType?: EndpointType;
|
|
193
193
|
/**
|
|
@@ -199,7 +199,7 @@ declare namespace Transfer {
|
|
|
199
199
|
*/
|
|
200
200
|
IdentityProviderDetails?: IdentityProviderDetails;
|
|
201
201
|
/**
|
|
202
|
-
* Specifies the mode of authentication for a
|
|
202
|
+
* Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
|
|
203
203
|
*/
|
|
204
204
|
IdentityProviderType?: IdentityProviderType;
|
|
205
205
|
/**
|
|
@@ -207,7 +207,7 @@ declare namespace Transfer {
|
|
|
207
207
|
*/
|
|
208
208
|
LoggingRole?: Role;
|
|
209
209
|
/**
|
|
210
|
-
* 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 AWS Certificate Manager (ACM) which will be used to identify your
|
|
210
|
+
* 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 AWS Certificate Manager (ACM) which will be 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 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.
|
|
211
211
|
*/
|
|
212
212
|
Protocols?: Protocols;
|
|
213
213
|
/**
|
|
@@ -215,23 +215,23 @@ declare namespace Transfer {
|
|
|
215
215
|
*/
|
|
216
216
|
SecurityPolicyName?: SecurityPolicyName;
|
|
217
217
|
/**
|
|
218
|
-
* Key-value pairs that can be used to group and search for
|
|
218
|
+
* Key-value pairs that can be used to group and search for servers.
|
|
219
219
|
*/
|
|
220
220
|
Tags?: Tags;
|
|
221
221
|
}
|
|
222
222
|
export interface CreateServerResponse {
|
|
223
223
|
/**
|
|
224
|
-
* The service-assigned ID of the
|
|
224
|
+
* The service-assigned ID of the server that is created.
|
|
225
225
|
*/
|
|
226
226
|
ServerId: ServerId;
|
|
227
227
|
}
|
|
228
228
|
export interface CreateUserRequest {
|
|
229
229
|
/**
|
|
230
|
-
* The landing directory (folder) for a user when they log in to the
|
|
230
|
+
* The landing directory (folder) for a user when they log in to the server using the client. An example is your-Amazon-S3-bucket-name>/home/username .
|
|
231
231
|
*/
|
|
232
232
|
HomeDirectory?: HomeDirectory;
|
|
233
233
|
/**
|
|
234
|
-
* The type of landing directory (folder) you want your users' home directory to be when they log into the
|
|
234
|
+
* The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
|
|
235
235
|
*/
|
|
236
236
|
HomeDirectoryType?: HomeDirectoryType;
|
|
237
237
|
/**
|
|
@@ -243,15 +243,15 @@ declare namespace Transfer {
|
|
|
243
243
|
*/
|
|
244
244
|
Policy?: Policy;
|
|
245
245
|
/**
|
|
246
|
-
* The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the
|
|
246
|
+
* The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
|
|
247
247
|
*/
|
|
248
248
|
Role: Role;
|
|
249
249
|
/**
|
|
250
|
-
* A system-assigned unique identifier for a
|
|
250
|
+
* A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
|
|
251
251
|
*/
|
|
252
252
|
ServerId: ServerId;
|
|
253
253
|
/**
|
|
254
|
-
* The public portion of the Secure Shell (SSH) key used to authenticate the user to the
|
|
254
|
+
* The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.
|
|
255
255
|
*/
|
|
256
256
|
SshPublicKeyBody?: SshPublicKeyBody;
|
|
257
257
|
/**
|
|
@@ -259,24 +259,24 @@ declare namespace Transfer {
|
|
|
259
259
|
*/
|
|
260
260
|
Tags?: Tags;
|
|
261
261
|
/**
|
|
262
|
-
* A unique string that identifies a user and is associated with a
|
|
262
|
+
* A unique string that identifies a user and is associated with a as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.
|
|
263
263
|
*/
|
|
264
264
|
UserName: UserName;
|
|
265
265
|
}
|
|
266
266
|
export interface CreateUserResponse {
|
|
267
267
|
/**
|
|
268
|
-
* The ID of the
|
|
268
|
+
* The ID of the server that the user is attached to.
|
|
269
269
|
*/
|
|
270
270
|
ServerId: ServerId;
|
|
271
271
|
/**
|
|
272
|
-
* A unique string that identifies a user account associated with a
|
|
272
|
+
* A unique string that identifies a user account associated with a server.
|
|
273
273
|
*/
|
|
274
274
|
UserName: UserName;
|
|
275
275
|
}
|
|
276
276
|
export type DateImported = Date;
|
|
277
277
|
export interface DeleteServerRequest {
|
|
278
278
|
/**
|
|
279
|
-
* A unique system-assigned identifier for a
|
|
279
|
+
* A unique system-assigned identifier for a server instance.
|
|
280
280
|
*/
|
|
281
281
|
ServerId: ServerId;
|
|
282
282
|
}
|
|
@@ -296,11 +296,11 @@ declare namespace Transfer {
|
|
|
296
296
|
}
|
|
297
297
|
export interface DeleteUserRequest {
|
|
298
298
|
/**
|
|
299
|
-
* A system-assigned unique identifier for a
|
|
299
|
+
* A system-assigned unique identifier for a server instance that has the user assigned to it.
|
|
300
300
|
*/
|
|
301
301
|
ServerId: ServerId;
|
|
302
302
|
/**
|
|
303
|
-
* A unique string that identifies a user that is being deleted from a
|
|
303
|
+
* A unique string that identifies a user that is being deleted from a server.
|
|
304
304
|
*/
|
|
305
305
|
UserName: UserName;
|
|
306
306
|
}
|
|
@@ -318,29 +318,29 @@ declare namespace Transfer {
|
|
|
318
318
|
}
|
|
319
319
|
export interface DescribeServerRequest {
|
|
320
320
|
/**
|
|
321
|
-
* A system-assigned unique identifier for a
|
|
321
|
+
* A system-assigned unique identifier for a server.
|
|
322
322
|
*/
|
|
323
323
|
ServerId: ServerId;
|
|
324
324
|
}
|
|
325
325
|
export interface DescribeServerResponse {
|
|
326
326
|
/**
|
|
327
|
-
* An array containing the properties of a
|
|
327
|
+
* An array containing the properties of a server with the ServerID you specified.
|
|
328
328
|
*/
|
|
329
329
|
Server: DescribedServer;
|
|
330
330
|
}
|
|
331
331
|
export interface DescribeUserRequest {
|
|
332
332
|
/**
|
|
333
|
-
* A system-assigned unique identifier for a
|
|
333
|
+
* A system-assigned unique identifier for a server that has this user assigned.
|
|
334
334
|
*/
|
|
335
335
|
ServerId: ServerId;
|
|
336
336
|
/**
|
|
337
|
-
* The name of the user assigned to one or more
|
|
337
|
+
* The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer Family service and perform file transfer tasks.
|
|
338
338
|
*/
|
|
339
339
|
UserName: UserName;
|
|
340
340
|
}
|
|
341
341
|
export interface DescribeUserResponse {
|
|
342
342
|
/**
|
|
343
|
-
* A system-assigned unique identifier for a
|
|
343
|
+
* A system-assigned unique identifier for a server that has this user assigned.
|
|
344
344
|
*/
|
|
345
345
|
ServerId: ServerId;
|
|
346
346
|
/**
|
|
@@ -376,7 +376,7 @@ declare namespace Transfer {
|
|
|
376
376
|
}
|
|
377
377
|
export interface DescribedServer {
|
|
378
378
|
/**
|
|
379
|
-
* Specifies the unique Amazon Resource Name (ARN) of the
|
|
379
|
+
* Specifies the unique Amazon Resource Name (ARN) of the server.
|
|
380
380
|
*/
|
|
381
381
|
Arn: Arn;
|
|
382
382
|
/**
|
|
@@ -384,11 +384,11 @@ declare namespace Transfer {
|
|
|
384
384
|
*/
|
|
385
385
|
Certificate?: Certificate;
|
|
386
386
|
/**
|
|
387
|
-
* Specifies the virtual private cloud (VPC) endpoint settings that you configured for your
|
|
387
|
+
* Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.
|
|
388
388
|
*/
|
|
389
389
|
EndpointDetails?: EndpointDetails;
|
|
390
390
|
/**
|
|
391
|
-
* Defines the type of endpoint that your
|
|
391
|
+
* Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
|
|
392
392
|
*/
|
|
393
393
|
EndpointType?: EndpointType;
|
|
394
394
|
/**
|
|
@@ -396,15 +396,15 @@ declare namespace Transfer {
|
|
|
396
396
|
*/
|
|
397
397
|
HostKeyFingerprint?: HostKeyFingerprint;
|
|
398
398
|
/**
|
|
399
|
-
* Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a
|
|
399
|
+
* Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is SERVICE_MANAGED.
|
|
400
400
|
*/
|
|
401
401
|
IdentityProviderDetails?: IdentityProviderDetails;
|
|
402
402
|
/**
|
|
403
|
-
* Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this
|
|
403
|
+
* Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
|
|
404
404
|
*/
|
|
405
405
|
IdentityProviderType?: IdentityProviderType;
|
|
406
406
|
/**
|
|
407
|
-
* Specifies the AWS Identity and Access Management (IAM) role that allows a
|
|
407
|
+
* Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
|
|
408
408
|
*/
|
|
409
409
|
LoggingRole?: Role;
|
|
410
410
|
/**
|
|
@@ -416,19 +416,19 @@ declare namespace Transfer {
|
|
|
416
416
|
*/
|
|
417
417
|
SecurityPolicyName?: SecurityPolicyName;
|
|
418
418
|
/**
|
|
419
|
-
* Specifies the unique system-assigned identifier for a
|
|
419
|
+
* Specifies the unique system-assigned identifier for a server that you instantiate.
|
|
420
420
|
*/
|
|
421
421
|
ServerId?: ServerId;
|
|
422
422
|
/**
|
|
423
|
-
* Specifies the condition of a
|
|
423
|
+
* Specifies the condition of a server for 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.
|
|
424
424
|
*/
|
|
425
425
|
State?: State;
|
|
426
426
|
/**
|
|
427
|
-
* Specifies the key-value pairs that you can use to search for and group
|
|
427
|
+
* Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
|
|
428
428
|
*/
|
|
429
429
|
Tags?: Tags;
|
|
430
430
|
/**
|
|
431
|
-
* Specifies the number of users that are assigned to a
|
|
431
|
+
* Specifies the number of users that are assigned to a server you specified with the ServerId.
|
|
432
432
|
*/
|
|
433
433
|
UserCount?: UserCount;
|
|
434
434
|
}
|
|
@@ -454,7 +454,7 @@ declare namespace Transfer {
|
|
|
454
454
|
*/
|
|
455
455
|
Policy?: Policy;
|
|
456
456
|
/**
|
|
457
|
-
* Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a
|
|
457
|
+
* Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a server to access your resources when servicing your users' transfer requests.
|
|
458
458
|
*/
|
|
459
459
|
Role?: Role;
|
|
460
460
|
/**
|
|
@@ -466,27 +466,31 @@ declare namespace Transfer {
|
|
|
466
466
|
*/
|
|
467
467
|
Tags?: Tags;
|
|
468
468
|
/**
|
|
469
|
-
* Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your
|
|
469
|
+
* Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.
|
|
470
470
|
*/
|
|
471
471
|
UserName?: UserName;
|
|
472
472
|
}
|
|
473
473
|
export interface EndpointDetails {
|
|
474
474
|
/**
|
|
475
|
-
* A list of address allocation IDs that are required to attach an Elastic IP address to your
|
|
475
|
+
* 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.
|
|
476
476
|
*/
|
|
477
477
|
AddressAllocationIds?: AddressAllocationIds;
|
|
478
478
|
/**
|
|
479
|
-
* A list of subnet IDs that are required to host your
|
|
479
|
+
* A list of subnet IDs that are required to host your server endpoint in your VPC. This property can only be set when EndpointType is set to VPC.
|
|
480
480
|
*/
|
|
481
481
|
SubnetIds?: SubnetIds;
|
|
482
482
|
/**
|
|
483
|
-
* The ID of the VPC endpoint. This property can only be
|
|
483
|
+
* The ID of the VPC endpoint. This property can only be set when EndpointType is set to VPC_ENDPOINT.
|
|
484
484
|
*/
|
|
485
485
|
VpcEndpointId?: VpcEndpointId;
|
|
486
486
|
/**
|
|
487
|
-
* The VPC ID of the VPC in which a
|
|
487
|
+
* The VPC ID of the VPC in which a server's endpoint will be hosted. This property can only be set when EndpointType is set to VPC.
|
|
488
488
|
*/
|
|
489
489
|
VpcId?: VpcId;
|
|
490
|
+
/**
|
|
491
|
+
* A list of security groups IDs that are available to attach to your server's endpoint. This property can only be set when EndpointType is set to VPC. You can only edit the SecurityGroupIds property in the UpdateServer API and only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC.
|
|
492
|
+
*/
|
|
493
|
+
SecurityGroupIds?: SecurityGroupIds;
|
|
490
494
|
}
|
|
491
495
|
export type EndpointType = "PUBLIC"|"VPC"|"VPC_ENDPOINT"|string;
|
|
492
496
|
export type Fips = boolean;
|
|
@@ -518,7 +522,7 @@ declare namespace Transfer {
|
|
|
518
522
|
export type IdentityProviderType = "SERVICE_MANAGED"|"API_GATEWAY"|string;
|
|
519
523
|
export interface ImportSshPublicKeyRequest {
|
|
520
524
|
/**
|
|
521
|
-
* A system-assigned unique identifier for a
|
|
525
|
+
* A system-assigned unique identifier for a server.
|
|
522
526
|
*/
|
|
523
527
|
ServerId: ServerId;
|
|
524
528
|
/**
|
|
@@ -526,13 +530,13 @@ declare namespace Transfer {
|
|
|
526
530
|
*/
|
|
527
531
|
SshPublicKeyBody: SshPublicKeyBody;
|
|
528
532
|
/**
|
|
529
|
-
* The name of the user account that is assigned to one or more
|
|
533
|
+
* The name of the user account that is assigned to one or more servers.
|
|
530
534
|
*/
|
|
531
535
|
UserName: UserName;
|
|
532
536
|
}
|
|
533
537
|
export interface ImportSshPublicKeyResponse {
|
|
534
538
|
/**
|
|
535
|
-
* A system-assigned unique identifier for a
|
|
539
|
+
* A system-assigned unique identifier for a server.
|
|
536
540
|
*/
|
|
537
541
|
ServerId: ServerId;
|
|
538
542
|
/**
|
|
@@ -566,21 +570,21 @@ declare namespace Transfer {
|
|
|
566
570
|
}
|
|
567
571
|
export interface ListServersRequest {
|
|
568
572
|
/**
|
|
569
|
-
* Specifies the number of
|
|
573
|
+
* Specifies the number of servers to return as a response to the ListServers query.
|
|
570
574
|
*/
|
|
571
575
|
MaxResults?: MaxResults;
|
|
572
576
|
/**
|
|
573
|
-
* When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional
|
|
577
|
+
* When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.
|
|
574
578
|
*/
|
|
575
579
|
NextToken?: NextToken;
|
|
576
580
|
}
|
|
577
581
|
export interface ListServersResponse {
|
|
578
582
|
/**
|
|
579
|
-
* When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional
|
|
583
|
+
* When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.
|
|
580
584
|
*/
|
|
581
585
|
NextToken?: NextToken;
|
|
582
586
|
/**
|
|
583
|
-
* An array of
|
|
587
|
+
* An array of servers that were listed.
|
|
584
588
|
*/
|
|
585
589
|
Servers: ListedServers;
|
|
586
590
|
}
|
|
@@ -622,7 +626,7 @@ declare namespace Transfer {
|
|
|
622
626
|
*/
|
|
623
627
|
NextToken?: NextToken;
|
|
624
628
|
/**
|
|
625
|
-
* A system-assigned unique identifier for a
|
|
629
|
+
* A system-assigned unique identifier for a server that has users assigned to it.
|
|
626
630
|
*/
|
|
627
631
|
ServerId: ServerId;
|
|
628
632
|
}
|
|
@@ -632,7 +636,7 @@ declare namespace Transfer {
|
|
|
632
636
|
*/
|
|
633
637
|
NextToken?: NextToken;
|
|
634
638
|
/**
|
|
635
|
-
* A system-assigned unique identifier for a
|
|
639
|
+
* A system-assigned unique identifier for a server that the users are assigned to.
|
|
636
640
|
*/
|
|
637
641
|
ServerId: ServerId;
|
|
638
642
|
/**
|
|
@@ -642,31 +646,31 @@ declare namespace Transfer {
|
|
|
642
646
|
}
|
|
643
647
|
export interface ListedServer {
|
|
644
648
|
/**
|
|
645
|
-
* Specifies the unique Amazon Resource Name (ARN) for a
|
|
649
|
+
* Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
|
|
646
650
|
*/
|
|
647
651
|
Arn: Arn;
|
|
648
652
|
/**
|
|
649
|
-
* Specifies the authentication method used to validate a user for a
|
|
653
|
+
* Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
|
|
650
654
|
*/
|
|
651
655
|
IdentityProviderType?: IdentityProviderType;
|
|
652
656
|
/**
|
|
653
|
-
* Specifies the type of VPC endpoint that your
|
|
657
|
+
* Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
|
|
654
658
|
*/
|
|
655
659
|
EndpointType?: EndpointType;
|
|
656
660
|
/**
|
|
657
|
-
* Specifies the AWS Identity and Access Management (IAM) role that allows a
|
|
661
|
+
* Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
|
|
658
662
|
*/
|
|
659
663
|
LoggingRole?: Role;
|
|
660
664
|
/**
|
|
661
|
-
* Specifies the unique system assigned identifier for
|
|
665
|
+
* Specifies the unique system assigned identifier for the servers that were listed.
|
|
662
666
|
*/
|
|
663
667
|
ServerId?: ServerId;
|
|
664
668
|
/**
|
|
665
|
-
* Specifies the condition of a
|
|
669
|
+
* Specifies the condition of a server for 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.
|
|
666
670
|
*/
|
|
667
671
|
State?: State;
|
|
668
672
|
/**
|
|
669
|
-
* Specifies the number of users that are assigned to a
|
|
673
|
+
* Specifies the number of users that are assigned to a server you specified with the ServerId.
|
|
670
674
|
*/
|
|
671
675
|
UserCount?: UserCount;
|
|
672
676
|
}
|
|
@@ -709,6 +713,8 @@ declare namespace Transfer {
|
|
|
709
713
|
export type Protocols = Protocol[];
|
|
710
714
|
export type Response = string;
|
|
711
715
|
export type Role = string;
|
|
716
|
+
export type SecurityGroupId = string;
|
|
717
|
+
export type SecurityGroupIds = SecurityGroupId[];
|
|
712
718
|
export type SecurityPolicyName = string;
|
|
713
719
|
export type SecurityPolicyNames = SecurityPolicyName[];
|
|
714
720
|
export type SecurityPolicyOption = string;
|
|
@@ -735,7 +741,7 @@ declare namespace Transfer {
|
|
|
735
741
|
export type SshPublicKeys = SshPublicKey[];
|
|
736
742
|
export interface StartServerRequest {
|
|
737
743
|
/**
|
|
738
|
-
* A system-assigned unique identifier for a
|
|
744
|
+
* A system-assigned unique identifier for a server that you start.
|
|
739
745
|
*/
|
|
740
746
|
ServerId: ServerId;
|
|
741
747
|
}
|
|
@@ -743,7 +749,7 @@ declare namespace Transfer {
|
|
|
743
749
|
export type StatusCode = number;
|
|
744
750
|
export interface StopServerRequest {
|
|
745
751
|
/**
|
|
746
|
-
* A system-assigned unique identifier for a
|
|
752
|
+
* A system-assigned unique identifier for a server that you stopped.
|
|
747
753
|
*/
|
|
748
754
|
ServerId: ServerId;
|
|
749
755
|
}
|
|
@@ -775,7 +781,7 @@ declare namespace Transfer {
|
|
|
775
781
|
export type Tags = Tag[];
|
|
776
782
|
export interface TestIdentityProviderRequest {
|
|
777
783
|
/**
|
|
778
|
-
* A system-assigned identifier for a specific
|
|
784
|
+
* A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.
|
|
779
785
|
*/
|
|
780
786
|
ServerId: ServerId;
|
|
781
787
|
/**
|
|
@@ -829,15 +835,15 @@ declare namespace Transfer {
|
|
|
829
835
|
*/
|
|
830
836
|
Certificate?: Certificate;
|
|
831
837
|
/**
|
|
832
|
-
* The virtual private cloud (VPC) endpoint settings that are configured for your
|
|
838
|
+
* The virtual private cloud (VPC) endpoint settings that are configured for your server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.
|
|
833
839
|
*/
|
|
834
840
|
EndpointDetails?: EndpointDetails;
|
|
835
841
|
/**
|
|
836
|
-
* The type of endpoint that you want your
|
|
842
|
+
* The type of endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
|
|
837
843
|
*/
|
|
838
844
|
EndpointType?: EndpointType;
|
|
839
845
|
/**
|
|
840
|
-
* The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key. If you aren't planning to migrate existing users from an existing
|
|
846
|
+
* The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key. If you aren't planning to migrate existing users from an existing 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 AWS Transfer Family User Guide.
|
|
841
847
|
*/
|
|
842
848
|
HostKey?: HostKey;
|
|
843
849
|
/**
|
|
@@ -857,23 +863,23 @@ declare namespace Transfer {
|
|
|
857
863
|
*/
|
|
858
864
|
SecurityPolicyName?: SecurityPolicyName;
|
|
859
865
|
/**
|
|
860
|
-
* A system-assigned unique identifier for a
|
|
866
|
+
* A system-assigned unique identifier for a server instance that the user account is assigned to.
|
|
861
867
|
*/
|
|
862
868
|
ServerId: ServerId;
|
|
863
869
|
}
|
|
864
870
|
export interface UpdateServerResponse {
|
|
865
871
|
/**
|
|
866
|
-
* A system-assigned unique identifier for a
|
|
872
|
+
* A system-assigned unique identifier for a server that the user account is assigned to.
|
|
867
873
|
*/
|
|
868
874
|
ServerId: ServerId;
|
|
869
875
|
}
|
|
870
876
|
export interface UpdateUserRequest {
|
|
871
877
|
/**
|
|
872
|
-
* Specifies the landing directory (folder) for a user when they log in to the
|
|
878
|
+
* Specifies the landing directory (folder) for a user when they log in to the server using their file transfer protocol client. An example is your-Amazon-S3-bucket-name>/home/username.
|
|
873
879
|
*/
|
|
874
880
|
HomeDirectory?: HomeDirectory;
|
|
875
881
|
/**
|
|
876
|
-
* The type of landing directory (folder) you want your users' home directory to be when they log into the
|
|
882
|
+
* The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
|
|
877
883
|
*/
|
|
878
884
|
HomeDirectoryType?: HomeDirectoryType;
|
|
879
885
|
/**
|
|
@@ -885,25 +891,25 @@ declare namespace Transfer {
|
|
|
885
891
|
*/
|
|
886
892
|
Policy?: Policy;
|
|
887
893
|
/**
|
|
888
|
-
* The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the
|
|
894
|
+
* The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
|
|
889
895
|
*/
|
|
890
896
|
Role?: Role;
|
|
891
897
|
/**
|
|
892
|
-
* A system-assigned unique identifier for a
|
|
898
|
+
* A system-assigned unique identifier for a server instance that the user account is assigned to.
|
|
893
899
|
*/
|
|
894
900
|
ServerId: ServerId;
|
|
895
901
|
/**
|
|
896
|
-
* A unique string that identifies a user and is associated with a
|
|
902
|
+
* A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.
|
|
897
903
|
*/
|
|
898
904
|
UserName: UserName;
|
|
899
905
|
}
|
|
900
906
|
export interface UpdateUserResponse {
|
|
901
907
|
/**
|
|
902
|
-
* A system-assigned unique identifier for a
|
|
908
|
+
* A system-assigned unique identifier for a server instance that the user account is assigned to.
|
|
903
909
|
*/
|
|
904
910
|
ServerId: ServerId;
|
|
905
911
|
/**
|
|
906
|
-
* The unique identifier for a user that is assigned to a
|
|
912
|
+
* The unique identifier for a user that is assigned to a server instance that was specified in the request.
|
|
907
913
|
*/
|
|
908
914
|
UserName: UserName;
|
|
909
915
|
}
|