@aws-sdk/client-transfer 3.379.1 → 3.385.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.
@@ -101,22 +101,27 @@ export type SigningAlg = (typeof SigningAlg)[keyof typeof SigningAlg];
101
101
  */
102
102
  export interface As2ConnectorConfig {
103
103
  /**
104
+ * @public
104
105
  * <p>A unique identifier for the AS2 local profile.</p>
105
106
  */
106
107
  LocalProfileId?: string;
107
108
  /**
109
+ * @public
108
110
  * <p>A unique identifier for the partner profile for the connector.</p>
109
111
  */
110
112
  PartnerProfileId?: string;
111
113
  /**
114
+ * @public
112
115
  * <p>Used as the <code>Subject</code> HTTP header attribute in AS2 messages that are being sent with the connector.</p>
113
116
  */
114
117
  MessageSubject?: string;
115
118
  /**
119
+ * @public
116
120
  * <p>Specifies whether the AS2 file is compressed.</p>
117
121
  */
118
122
  Compression?: CompressionEnum | string;
119
123
  /**
124
+ * @public
120
125
  * <p>The algorithm that is used to encrypt the file.</p>
121
126
  * <note>
122
127
  * <p>You can only specify <code>NONE</code> if the URL for your connector uses HTTPS. This ensures that
@@ -125,10 +130,12 @@ export interface As2ConnectorConfig {
125
130
  */
126
131
  EncryptionAlgorithm?: EncryptionAlg | string;
127
132
  /**
133
+ * @public
128
134
  * <p>The algorithm that is used to sign the AS2 messages sent with the connector.</p>
129
135
  */
130
136
  SigningAlgorithm?: SigningAlg | string;
131
137
  /**
138
+ * @public
132
139
  * <p>The signing algorithm for the MDN response.</p>
133
140
  * <note>
134
141
  * <p>If set to DEFAULT (or not set at all), the value for <code>SigningAlgorithm</code> is used.</p>
@@ -136,6 +143,7 @@ export interface As2ConnectorConfig {
136
143
  */
137
144
  MdnSigningAlgorithm?: MdnSigningAlg | string;
138
145
  /**
146
+ * @public
139
147
  * <p>Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether
140
148
  * the partner response for transfers is synchronous or asynchronous. Specify either of the following values:</p>
141
149
  * <ul>
@@ -151,6 +159,7 @@ export interface As2ConnectorConfig {
151
159
  */
152
160
  MdnResponse?: MdnResponse | string;
153
161
  /**
162
+ * @public
154
163
  * <p>Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication,
155
164
  * you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.</p>
156
165
  * <p>The default value for this parameter is <code>null</code>, which indicates that Basic authentication is not enabled for the connector.</p>
@@ -251,10 +260,12 @@ export declare class ConflictException extends __BaseException {
251
260
  */
252
261
  export interface EfsFileLocation {
253
262
  /**
263
+ * @public
254
264
  * <p>The identifier of the file system, assigned by Amazon EFS.</p>
255
265
  */
256
266
  FileSystemId?: string;
257
267
  /**
268
+ * @public
258
269
  * <p>The pathname for the folder being used by a workflow.</p>
259
270
  */
260
271
  Path?: string;
@@ -275,10 +286,12 @@ export interface EfsFileLocation {
275
286
  */
276
287
  export interface S3InputFileLocation {
277
288
  /**
289
+ * @public
278
290
  * <p>Specifies the S3 bucket for the customer input file.</p>
279
291
  */
280
292
  Bucket?: string;
281
293
  /**
294
+ * @public
282
295
  * <p>The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.</p>
283
296
  */
284
297
  Key?: string;
@@ -289,10 +302,12 @@ export interface S3InputFileLocation {
289
302
  */
290
303
  export interface InputFileLocation {
291
304
  /**
305
+ * @public
292
306
  * <p>Specifies the details for the Amazon S3 file that's being copied or decrypted.</p>
293
307
  */
294
308
  S3FileLocation?: S3InputFileLocation;
295
309
  /**
310
+ * @public
296
311
  * <p>Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being
297
312
  * decrypted.</p>
298
313
  */
@@ -316,10 +331,12 @@ export type OverwriteExisting = (typeof OverwriteExisting)[keyof typeof Overwrit
316
331
  */
317
332
  export interface CopyStepDetails {
318
333
  /**
334
+ * @public
319
335
  * <p>The name of the step, used as an identifier.</p>
320
336
  */
321
337
  Name?: string;
322
338
  /**
339
+ * @public
323
340
  * <p>Specifies the location for the file being copied. Use <code>$\{Transfer:UserName\}</code> or
324
341
  * <code>$\{Transfer:UploadDate\}</code> in this field to parametrize the destination prefix by
325
342
  * username or uploaded date.</p>
@@ -342,6 +359,7 @@ export interface CopyStepDetails {
342
359
  */
343
360
  DestinationFileLocation?: InputFileLocation;
344
361
  /**
362
+ * @public
345
363
  * <p>A flag that indicates whether to overwrite an existing file of the same name.
346
364
  * The default is <code>FALSE</code>.</p>
347
365
  * <p>If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:</p>
@@ -356,6 +374,7 @@ export interface CopyStepDetails {
356
374
  */
357
375
  OverwriteExisting?: OverwriteExisting | string;
358
376
  /**
377
+ * @public
359
378
  * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
360
379
  * for the workflow.</p>
361
380
  * <ul>
@@ -382,10 +401,12 @@ export interface CopyStepDetails {
382
401
  */
383
402
  export interface HomeDirectoryMapEntry {
384
403
  /**
404
+ * @public
385
405
  * <p>Represents an entry for <code>HomeDirectoryMappings</code>.</p>
386
406
  */
387
407
  Entry: string | undefined;
388
408
  /**
409
+ * @public
389
410
  * <p>Represents the map target that is used in a <code>HomeDirectorymapEntry</code>.</p>
390
411
  */
391
412
  Target: string | undefined;
@@ -412,14 +433,17 @@ export type HomeDirectoryType = (typeof HomeDirectoryType)[keyof typeof HomeDire
412
433
  */
413
434
  export interface PosixProfile {
414
435
  /**
436
+ * @public
415
437
  * <p>The POSIX user ID used for all EFS operations by this user.</p>
416
438
  */
417
439
  Uid: number | undefined;
418
440
  /**
441
+ * @public
419
442
  * <p>The POSIX group ID used for all EFS operations by this user.</p>
420
443
  */
421
444
  Gid: number | undefined;
422
445
  /**
446
+ * @public
423
447
  * <p>The secondary POSIX group IDs used for all EFS operations by this user.</p>
424
448
  */
425
449
  SecondaryGids?: number[];
@@ -429,11 +453,13 @@ export interface PosixProfile {
429
453
  */
430
454
  export interface CreateAccessRequest {
431
455
  /**
456
+ * @public
432
457
  * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
433
458
  * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
434
459
  */
435
460
  HomeDirectory?: string;
436
461
  /**
462
+ * @public
437
463
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
438
464
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer
439
465
  * protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
@@ -441,6 +467,7 @@ export interface CreateAccessRequest {
441
467
  */
442
468
  HomeDirectoryType?: HomeDirectoryType | string;
443
469
  /**
470
+ * @public
444
471
  * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
445
472
  * be visible to your user and how you want to make them visible. You must specify the
446
473
  * <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
@@ -464,6 +491,7 @@ export interface CreateAccessRequest {
464
491
  */
465
492
  HomeDirectoryMappings?: HomeDirectoryMapEntry[];
466
493
  /**
494
+ * @public
467
495
  * <p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's
468
496
  * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>$\{Transfer:UserName\}</code>,
469
497
  * <code>$\{Transfer:HomeDirectory\}</code>, and <code>$\{Transfer:HomeBucket\}</code>.</p>
@@ -480,6 +508,7 @@ export interface CreateAccessRequest {
480
508
  */
481
509
  Policy?: string;
482
510
  /**
511
+ * @public
483
512
  * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
484
513
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
485
514
  * your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
@@ -488,6 +517,7 @@ export interface CreateAccessRequest {
488
517
  */
489
518
  PosixProfile?: PosixProfile;
490
519
  /**
520
+ * @public
491
521
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
492
522
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
493
523
  * when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
@@ -495,10 +525,12 @@ export interface CreateAccessRequest {
495
525
  */
496
526
  Role: string | undefined;
497
527
  /**
528
+ * @public
498
529
  * <p>A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.</p>
499
530
  */
500
531
  ServerId: string | undefined;
501
532
  /**
533
+ * @public
502
534
  * <p>A unique identifier that is required to identify specific groups within your directory.
503
535
  * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
504
536
  * resources over the enabled protocols using Transfer Family. If you know the group name,
@@ -517,10 +549,12 @@ export interface CreateAccessRequest {
517
549
  */
518
550
  export interface CreateAccessResponse {
519
551
  /**
552
+ * @public
520
553
  * <p>The identifier of the server that the user is attached to.</p>
521
554
  */
522
555
  ServerId: string | undefined;
523
556
  /**
557
+ * @public
524
558
  * <p>The external identifier of the group whose users have access to your Amazon S3 or Amazon
525
559
  * EFS resources over the enabled protocols using Transfer Family.</p>
526
560
  */
@@ -606,10 +640,12 @@ export declare class ServiceUnavailableException extends __BaseException {
606
640
  */
607
641
  export interface Tag {
608
642
  /**
643
+ * @public
609
644
  * <p>The name assigned to the tag that you create.</p>
610
645
  */
611
646
  Key: string | undefined;
612
647
  /**
648
+ * @public
613
649
  * <p>Contains one or more values that you assigned to the key name you create.</p>
614
650
  */
615
651
  Value: string | undefined;
@@ -619,29 +655,35 @@ export interface Tag {
619
655
  */
620
656
  export interface CreateAgreementRequest {
621
657
  /**
658
+ * @public
622
659
  * <p>A name or short description to identify the agreement. </p>
623
660
  */
624
661
  Description?: string;
625
662
  /**
663
+ * @public
626
664
  * <p>A system-assigned unique identifier for a server instance. This is the specific server
627
665
  * that the agreement uses.</p>
628
666
  */
629
667
  ServerId: string | undefined;
630
668
  /**
669
+ * @public
631
670
  * <p>A unique identifier for the AS2 local profile.</p>
632
671
  */
633
672
  LocalProfileId: string | undefined;
634
673
  /**
674
+ * @public
635
675
  * <p>A unique identifier for the partner profile used in the agreement.</p>
636
676
  */
637
677
  PartnerProfileId: string | undefined;
638
678
  /**
679
+ * @public
639
680
  * <p>The landing directory (folder) for files transferred by using the AS2 protocol.</p>
640
681
  * <p>A <code>BaseDirectory</code> example is
641
682
  * <code>/DOC-EXAMPLE-BUCKET/home/mydirectory</code>.</p>
642
683
  */
643
684
  BaseDirectory: string | undefined;
644
685
  /**
686
+ * @public
645
687
  * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
646
688
  * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
647
689
  * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
@@ -659,11 +701,13 @@ export interface CreateAgreementRequest {
659
701
  */
660
702
  AccessRole: string | undefined;
661
703
  /**
704
+ * @public
662
705
  * <p>The status of the agreement. The agreement can be either <code>ACTIVE</code> or
663
706
  * <code>INACTIVE</code>.</p>
664
707
  */
665
708
  Status?: AgreementStatusType | string;
666
709
  /**
710
+ * @public
667
711
  * <p>Key-value pairs that can be used to group and search for agreements.</p>
668
712
  */
669
713
  Tags?: Tag[];
@@ -673,6 +717,7 @@ export interface CreateAgreementRequest {
673
717
  */
674
718
  export interface CreateAgreementResponse {
675
719
  /**
720
+ * @public
676
721
  * <p>The unique identifier for the agreement. Use this ID for deleting, or updating an
677
722
  * agreement, as well as in any other API calls that require that you specify the agreement
678
723
  * ID.</p>
@@ -699,10 +744,12 @@ export declare class ThrottlingException extends __BaseException {
699
744
  */
700
745
  export interface SftpConnectorConfig {
701
746
  /**
747
+ * @public
702
748
  * <p>The identifiers for the secrets (in Amazon Web Services Secrets Manager) that contain the SFTP user's private keys or passwords.</p>
703
749
  */
704
750
  UserSecretId?: string;
705
751
  /**
752
+ * @public
706
753
  * <p>The public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting. You can use the <code>ssh-keyscan</code> command against the SFTP server to retrieve the necessary key.</p>
707
754
  * <p>The three standard SSH public key format elements are <code><key type></code>,
708
755
  * <code><body base64></code>, and an optional <code><comment></code>, with spaces
@@ -726,14 +773,17 @@ export interface SftpConnectorConfig {
726
773
  */
727
774
  export interface CreateConnectorRequest {
728
775
  /**
776
+ * @public
729
777
  * <p>The URL of the partner's AS2 or SFTP endpoint.</p>
730
778
  */
731
779
  Url: string | undefined;
732
780
  /**
781
+ * @public
733
782
  * <p>A structure that contains the parameters for an AS2 connector object.</p>
734
783
  */
735
784
  As2Config?: As2ConnectorConfig;
736
785
  /**
786
+ * @public
737
787
  * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
738
788
  * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
739
789
  * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
@@ -751,16 +801,19 @@ export interface CreateConnectorRequest {
751
801
  */
752
802
  AccessRole: string | undefined;
753
803
  /**
804
+ * @public
754
805
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn
755
806
  * on CloudWatch logging for Amazon S3 events. When set, you can view connector
756
807
  * activity in your CloudWatch logs.</p>
757
808
  */
758
809
  LoggingRole?: string;
759
810
  /**
811
+ * @public
760
812
  * <p>Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.</p>
761
813
  */
762
814
  Tags?: Tag[];
763
815
  /**
816
+ * @public
764
817
  * <p>A structure that contains the parameters for an SFTP connector object.</p>
765
818
  */
766
819
  SftpConfig?: SftpConnectorConfig;
@@ -770,6 +823,7 @@ export interface CreateConnectorRequest {
770
823
  */
771
824
  export interface CreateConnectorResponse {
772
825
  /**
826
+ * @public
773
827
  * <p>The unique identifier for the connector, returned after the API call succeeds.</p>
774
828
  */
775
829
  ConnectorId: string | undefined;
@@ -791,6 +845,7 @@ export type ProfileType = (typeof ProfileType)[keyof typeof ProfileType];
791
845
  */
792
846
  export interface CreateProfileRequest {
793
847
  /**
848
+ * @public
794
849
  * <p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the
795
850
  * <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages
796
851
  * sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the
@@ -798,6 +853,7 @@ export interface CreateProfileRequest {
798
853
  */
799
854
  As2Id: string | undefined;
800
855
  /**
856
+ * @public
801
857
  * <p>Determines the type of profile to create:</p>
802
858
  * <ul>
803
859
  * <li>
@@ -810,10 +866,12 @@ export interface CreateProfileRequest {
810
866
  */
811
867
  ProfileType: ProfileType | string | undefined;
812
868
  /**
869
+ * @public
813
870
  * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
814
871
  */
815
872
  CertificateIds?: string[];
816
873
  /**
874
+ * @public
817
875
  * <p>Key-value pairs that can be used to group and search for AS2 profiles.</p>
818
876
  */
819
877
  Tags?: Tag[];
@@ -823,6 +881,7 @@ export interface CreateProfileRequest {
823
881
  */
824
882
  export interface CreateProfileResponse {
825
883
  /**
884
+ * @public
826
885
  * <p>The unique identifier for the AS2 profile, returned after the API call succeeds.</p>
827
886
  */
828
887
  ProfileId: string | undefined;
@@ -859,6 +918,7 @@ export type Domain = (typeof Domain)[keyof typeof Domain];
859
918
  */
860
919
  export interface EndpointDetails {
861
920
  /**
921
+ * @public
862
922
  * <p>A list of address allocation IDs that are required to attach an Elastic IP address to your
863
923
  * server's endpoint.</p>
864
924
  * <note>
@@ -868,6 +928,7 @@ export interface EndpointDetails {
868
928
  */
869
929
  AddressAllocationIds?: string[];
870
930
  /**
931
+ * @public
871
932
  * <p>A list of subnet IDs that are required to host your server endpoint in your VPC.</p>
872
933
  * <note>
873
934
  * <p>This property can only be set when <code>EndpointType</code> is set to
@@ -876,6 +937,7 @@ export interface EndpointDetails {
876
937
  */
877
938
  SubnetIds?: string[];
878
939
  /**
940
+ * @public
879
941
  * <p>The identifier of the VPC endpoint.</p>
880
942
  * <note>
881
943
  * <p>This property can only be set when <code>EndpointType</code> is set to
@@ -886,6 +948,7 @@ export interface EndpointDetails {
886
948
  */
887
949
  VpcEndpointId?: string;
888
950
  /**
951
+ * @public
889
952
  * <p>The VPC identifier of the VPC in which a server's endpoint will be hosted.</p>
890
953
  * <note>
891
954
  * <p>This property can only be set when <code>EndpointType</code> is set to
@@ -894,6 +957,7 @@ export interface EndpointDetails {
894
957
  */
895
958
  VpcId?: string;
896
959
  /**
960
+ * @public
897
961
  * <p>A list of security groups IDs that are available to attach to your server's
898
962
  * endpoint.</p>
899
963
  * <note>
@@ -942,23 +1006,28 @@ export type SftpAuthenticationMethods = (typeof SftpAuthenticationMethods)[keyof
942
1006
  */
943
1007
  export interface IdentityProviderDetails {
944
1008
  /**
1009
+ * @public
945
1010
  * <p>Provides the location of the service endpoint used to authenticate users.</p>
946
1011
  */
947
1012
  Url?: string;
948
1013
  /**
1014
+ * @public
949
1015
  * <p>This parameter is only applicable if your <code>IdentityProviderType</code> is <code>API_GATEWAY</code>. Provides the type of <code>InvocationRole</code> used to authenticate the user
950
1016
  * account.</p>
951
1017
  */
952
1018
  InvocationRole?: string;
953
1019
  /**
1020
+ * @public
954
1021
  * <p>The identifier of the Directory Service directory that you want to stop sharing.</p>
955
1022
  */
956
1023
  DirectoryId?: string;
957
1024
  /**
1025
+ * @public
958
1026
  * <p>The ARN for a Lambda function to use for the Identity provider.</p>
959
1027
  */
960
1028
  Function?: string;
961
1029
  /**
1030
+ * @public
962
1031
  * <p>For SFTP-enabled servers, and for custom identity providers <i>only</i>, you
963
1032
  * can specify whether to authenticate using a password, SSH key pair, or both.</p>
964
1033
  * <ul>
@@ -1031,6 +1100,7 @@ export type TlsSessionResumptionMode = (typeof TlsSessionResumptionMode)[keyof t
1031
1100
  */
1032
1101
  export interface ProtocolDetails {
1033
1102
  /**
1103
+ * @public
1034
1104
  * <p>
1035
1105
  * Indicates passive mode, for FTP and FTPS protocols.
1036
1106
  * Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer.
@@ -1058,6 +1128,7 @@ export interface ProtocolDetails {
1058
1128
  */
1059
1129
  PassiveIp?: string;
1060
1130
  /**
1131
+ * @public
1061
1132
  * <p>A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret
1062
1133
  * key between the control and data connection for an FTPS session. <code>TlsSessionResumptionMode</code> determines whether or not the server resumes recent,
1063
1134
  * negotiated sessions through a unique session ID. This property is available during <code>CreateServer</code> and <code>UpdateServer</code> calls.
@@ -1088,6 +1159,7 @@ export interface ProtocolDetails {
1088
1159
  */
1089
1160
  TlsSessionResumptionMode?: TlsSessionResumptionMode | string;
1090
1161
  /**
1162
+ * @public
1091
1163
  * <p>Use the <code>SetStatOption</code> to ignore the error that is generated when the client attempts to use <code>SETSTAT</code> on a file you are uploading to an S3 bucket.</p>
1092
1164
  * <p>Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as <code>SETSTAT</code> when uploading the file.
1093
1165
  * 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
@@ -1101,6 +1173,7 @@ export interface ProtocolDetails {
1101
1173
  */
1102
1174
  SetStatOption?: SetStatOption | string;
1103
1175
  /**
1176
+ * @public
1104
1177
  * <p>Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p>
1105
1178
  */
1106
1179
  As2Transports?: (As2Transport | string)[];
@@ -1128,10 +1201,12 @@ export type Protocol = (typeof Protocol)[keyof typeof Protocol];
1128
1201
  */
1129
1202
  export interface WorkflowDetail {
1130
1203
  /**
1204
+ * @public
1131
1205
  * <p>A unique identifier for the workflow.</p>
1132
1206
  */
1133
1207
  WorkflowId: string | undefined;
1134
1208
  /**
1209
+ * @public
1135
1210
  * <p>Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can
1136
1211
  * assume, so that all workflow steps can operate on the required resources</p>
1137
1212
  */
@@ -1144,6 +1219,7 @@ export interface WorkflowDetail {
1144
1219
  */
1145
1220
  export interface WorkflowDetails {
1146
1221
  /**
1222
+ * @public
1147
1223
  * <p>A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.</p>
1148
1224
  * <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p>
1149
1225
  * <p>
@@ -1152,6 +1228,7 @@ export interface WorkflowDetails {
1152
1228
  */
1153
1229
  OnUpload?: WorkflowDetail[];
1154
1230
  /**
1231
+ * @public
1155
1232
  * <p>A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server
1156
1233
  * that executes whenever there is a partial upload.</p>
1157
1234
  * <p>A <i>partial upload</i> occurs when a file is open when the session disconnects.</p>
@@ -1163,6 +1240,7 @@ export interface WorkflowDetails {
1163
1240
  */
1164
1241
  export interface CreateServerRequest {
1165
1242
  /**
1243
+ * @public
1166
1244
  * <p>The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required
1167
1245
  * when <code>Protocols</code> is set to <code>FTPS</code>.</p>
1168
1246
  * <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a>
@@ -1198,6 +1276,7 @@ export interface CreateServerRequest {
1198
1276
  */
1199
1277
  Certificate?: string;
1200
1278
  /**
1279
+ * @public
1201
1280
  * <p>The domain of the storage system that is used for file transfers. There are two domains
1202
1281
  * available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The
1203
1282
  * default value is S3.</p>
@@ -1207,6 +1286,7 @@ export interface CreateServerRequest {
1207
1286
  */
1208
1287
  Domain?: Domain | string;
1209
1288
  /**
1289
+ * @public
1210
1290
  * <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
1211
1291
  * When you host your endpoint within your VPC, you can make your endpoint accessible only to resources
1212
1292
  * within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over
@@ -1215,6 +1295,7 @@ export interface CreateServerRequest {
1215
1295
  */
1216
1296
  EndpointDetails?: EndpointDetails;
1217
1297
  /**
1298
+ * @public
1218
1299
  * <p>The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)
1219
1300
  * or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and
1220
1301
  * resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.</p>
@@ -1236,6 +1317,7 @@ export interface CreateServerRequest {
1236
1317
  */
1237
1318
  EndpointType?: EndpointType | string;
1238
1319
  /**
1320
+ * @public
1239
1321
  * <p>The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want
1240
1322
  * to rotate keys, or have a set of active keys that use different algorithms.</p>
1241
1323
  * <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
@@ -1259,6 +1341,7 @@ export interface CreateServerRequest {
1259
1341
  */
1260
1342
  HostKey?: string;
1261
1343
  /**
1344
+ * @public
1262
1345
  * <p>Required when <code>IdentityProviderType</code> is set to
1263
1346
  * <code>AWS_DIRECTORY_SERVICE</code>, <code>Amazon Web Services_LAMBDA</code> or <code>API_GATEWAY</code>. Accepts an array containing
1264
1347
  * all of the information required to use a directory in <code>AWS_DIRECTORY_SERVICE</code> or
@@ -1267,6 +1350,7 @@ export interface CreateServerRequest {
1267
1350
  */
1268
1351
  IdentityProviderDetails?: IdentityProviderDetails;
1269
1352
  /**
1353
+ * @public
1270
1354
  * <p>The mode of authentication for a server. The default value is
1271
1355
  * <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
1272
1356
  * the Transfer Family service.</p>
@@ -1283,12 +1367,14 @@ export interface CreateServerRequest {
1283
1367
  */
1284
1368
  IdentityProviderType?: IdentityProviderType | string;
1285
1369
  /**
1370
+ * @public
1286
1371
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
1287
1372
  * on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
1288
1373
  * your CloudWatch logs.</p>
1289
1374
  */
1290
1375
  LoggingRole?: string;
1291
1376
  /**
1377
+ * @public
1292
1378
  * <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p>
1293
1379
  * <note>
1294
1380
  * <p>The SFTP protocol does not support post-authentication display banners.</p>
@@ -1296,6 +1382,7 @@ export interface CreateServerRequest {
1296
1382
  */
1297
1383
  PostAuthenticationLoginBanner?: string;
1298
1384
  /**
1385
+ * @public
1299
1386
  * <p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.
1300
1387
  * For example, the following banner displays details about using the system:</p>
1301
1388
  * <p>
@@ -1306,6 +1393,7 @@ export interface CreateServerRequest {
1306
1393
  */
1307
1394
  PreAuthenticationLoginBanner?: string;
1308
1395
  /**
1396
+ * @public
1309
1397
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
1310
1398
  * client can connect to your server's endpoint. The available protocols are:</p>
1311
1399
  * <ul>
@@ -1358,6 +1446,7 @@ export interface CreateServerRequest {
1358
1446
  */
1359
1447
  Protocols?: (Protocol | string)[];
1360
1448
  /**
1449
+ * @public
1361
1450
  * <p>The protocol settings that are configured for your server.</p>
1362
1451
  * <ul>
1363
1452
  * <li>
@@ -1386,14 +1475,17 @@ export interface CreateServerRequest {
1386
1475
  */
1387
1476
  ProtocolDetails?: ProtocolDetails;
1388
1477
  /**
1478
+ * @public
1389
1479
  * <p>Specifies the name of the security policy that is attached to the server.</p>
1390
1480
  */
1391
1481
  SecurityPolicyName?: string;
1392
1482
  /**
1483
+ * @public
1393
1484
  * <p>Key-value pairs that can be used to group and search for servers.</p>
1394
1485
  */
1395
1486
  Tags?: Tag[];
1396
1487
  /**
1488
+ * @public
1397
1489
  * <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
1398
1490
  * <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> can also contain a
1399
1491
  * workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects
@@ -1401,6 +1493,7 @@ export interface CreateServerRequest {
1401
1493
  */
1402
1494
  WorkflowDetails?: WorkflowDetails;
1403
1495
  /**
1496
+ * @public
1404
1497
  * <p>Specifies the log groups to which your server logs are sent.</p>
1405
1498
  * <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p>
1406
1499
  * <p>
@@ -1421,6 +1514,7 @@ export interface CreateServerRequest {
1421
1514
  */
1422
1515
  export interface CreateServerResponse {
1423
1516
  /**
1517
+ * @public
1424
1518
  * <p>The service-assigned identifier of the server that is created.</p>
1425
1519
  */
1426
1520
  ServerId: string | undefined;
@@ -1430,11 +1524,13 @@ export interface CreateServerResponse {
1430
1524
  */
1431
1525
  export interface CreateUserRequest {
1432
1526
  /**
1527
+ * @public
1433
1528
  * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
1434
1529
  * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
1435
1530
  */
1436
1531
  HomeDirectory?: string;
1437
1532
  /**
1533
+ * @public
1438
1534
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
1439
1535
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer
1440
1536
  * protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
@@ -1442,6 +1538,7 @@ export interface CreateUserRequest {
1442
1538
  */
1443
1539
  HomeDirectoryType?: HomeDirectoryType | string;
1444
1540
  /**
1541
+ * @public
1445
1542
  * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
1446
1543
  * be visible to your user and how you want to make them visible. You must specify the
1447
1544
  * <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
@@ -1466,6 +1563,7 @@ export interface CreateUserRequest {
1466
1563
  */
1467
1564
  HomeDirectoryMappings?: HomeDirectoryMapEntry[];
1468
1565
  /**
1566
+ * @public
1469
1567
  * <p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's
1470
1568
  * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>$\{Transfer:UserName\}</code>,
1471
1569
  * <code>$\{Transfer:HomeDirectory\}</code>, and <code>$\{Transfer:HomeBucket\}</code>.</p>
@@ -1482,6 +1580,7 @@ export interface CreateUserRequest {
1482
1580
  */
1483
1581
  Policy?: string;
1484
1582
  /**
1583
+ * @public
1485
1584
  * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID
1486
1585
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
1487
1586
  * your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
@@ -1490,6 +1589,7 @@ export interface CreateUserRequest {
1490
1589
  */
1491
1590
  PosixProfile?: PosixProfile;
1492
1591
  /**
1592
+ * @public
1493
1593
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
1494
1594
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
1495
1595
  * when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
@@ -1497,11 +1597,13 @@ export interface CreateUserRequest {
1497
1597
  */
1498
1598
  Role: string | undefined;
1499
1599
  /**
1600
+ * @public
1500
1601
  * <p>A system-assigned unique identifier for a server instance. This is the specific server
1501
1602
  * that you added your user to.</p>
1502
1603
  */
1503
1604
  ServerId: string | undefined;
1504
1605
  /**
1606
+ * @public
1505
1607
  * <p>The public portion of the Secure Shell (SSH) key used to authenticate the user to the
1506
1608
  * server.</p>
1507
1609
  * <p>The three standard SSH public key format elements are <code><key type></code>,
@@ -1524,11 +1626,13 @@ export interface CreateUserRequest {
1524
1626
  */
1525
1627
  SshPublicKeyBody?: string;
1526
1628
  /**
1629
+ * @public
1527
1630
  * <p>Key-value pairs that can be used to group and search for users. Tags are metadata attached
1528
1631
  * to users for any purpose.</p>
1529
1632
  */
1530
1633
  Tags?: Tag[];
1531
1634
  /**
1635
+ * @public
1532
1636
  * <p>A unique string that identifies a user and is associated with a <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 100 characters
1533
1637
  * long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen
1534
1638
  * '-', period '.', and at sign '@'. The user name can't start
@@ -1541,10 +1645,12 @@ export interface CreateUserRequest {
1541
1645
  */
1542
1646
  export interface CreateUserResponse {
1543
1647
  /**
1648
+ * @public
1544
1649
  * <p>The identifier of the server that the user is attached to.</p>
1545
1650
  */
1546
1651
  ServerId: string | undefined;
1547
1652
  /**
1653
+ * @public
1548
1654
  * <p>A unique string that identifies a Transfer Family user.</p>
1549
1655
  */
1550
1656
  UserName: string | undefined;
@@ -1555,18 +1661,22 @@ export interface CreateUserResponse {
1555
1661
  */
1556
1662
  export interface CustomStepDetails {
1557
1663
  /**
1664
+ * @public
1558
1665
  * <p>The name of the step, used as an identifier.</p>
1559
1666
  */
1560
1667
  Name?: string;
1561
1668
  /**
1669
+ * @public
1562
1670
  * <p>The ARN for the Lambda function that is being called.</p>
1563
1671
  */
1564
1672
  Target?: string;
1565
1673
  /**
1674
+ * @public
1566
1675
  * <p>Timeout, in seconds, for the step.</p>
1567
1676
  */
1568
1677
  TimeoutSeconds?: number;
1569
1678
  /**
1679
+ * @public
1570
1680
  * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
1571
1681
  * for the workflow.</p>
1572
1682
  * <ul>
@@ -1599,14 +1709,17 @@ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType
1599
1709
  */
1600
1710
  export interface DecryptStepDetails {
1601
1711
  /**
1712
+ * @public
1602
1713
  * <p>The name of the step, used as an identifier.</p>
1603
1714
  */
1604
1715
  Name?: string;
1605
1716
  /**
1717
+ * @public
1606
1718
  * <p>The type of encryption used. Currently, this value must be <code>PGP</code>.</p>
1607
1719
  */
1608
1720
  Type: EncryptionType | string | undefined;
1609
1721
  /**
1722
+ * @public
1610
1723
  * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
1611
1724
  * for the workflow.</p>
1612
1725
  * <ul>
@@ -1622,6 +1735,7 @@ export interface DecryptStepDetails {
1622
1735
  */
1623
1736
  SourceFileLocation?: string;
1624
1737
  /**
1738
+ * @public
1625
1739
  * <p>A flag that indicates whether to overwrite an existing file of the same name.
1626
1740
  * The default is <code>FALSE</code>.</p>
1627
1741
  * <p>If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:</p>
@@ -1636,6 +1750,7 @@ export interface DecryptStepDetails {
1636
1750
  */
1637
1751
  OverwriteExisting?: OverwriteExisting | string;
1638
1752
  /**
1753
+ * @public
1639
1754
  * <p>Specifies the location for the file being decrypted. Use <code>$\{Transfer:UserName\}</code> or
1640
1755
  * <code>$\{Transfer:UploadDate\}</code> in this field to parametrize the destination prefix by
1641
1756
  * username or uploaded date.</p>
@@ -1664,10 +1779,12 @@ export interface DecryptStepDetails {
1664
1779
  */
1665
1780
  export interface DeleteStepDetails {
1666
1781
  /**
1782
+ * @public
1667
1783
  * <p>The name of the step, used as an identifier.</p>
1668
1784
  */
1669
1785
  Name?: string;
1670
1786
  /**
1787
+ * @public
1671
1788
  * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
1672
1789
  * for the workflow.</p>
1673
1790
  * <ul>
@@ -1689,10 +1806,12 @@ export interface DeleteStepDetails {
1689
1806
  */
1690
1807
  export interface S3Tag {
1691
1808
  /**
1809
+ * @public
1692
1810
  * <p>The name assigned to the tag that you create.</p>
1693
1811
  */
1694
1812
  Key: string | undefined;
1695
1813
  /**
1814
+ * @public
1696
1815
  * <p>The value that corresponds to the key.</p>
1697
1816
  */
1698
1817
  Value: string | undefined;
@@ -1704,14 +1823,17 @@ export interface S3Tag {
1704
1823
  */
1705
1824
  export interface TagStepDetails {
1706
1825
  /**
1826
+ * @public
1707
1827
  * <p>The name of the step, used as an identifier.</p>
1708
1828
  */
1709
1829
  Name?: string;
1710
1830
  /**
1831
+ * @public
1711
1832
  * <p>Array that contains from 1 to 10 key/value pairs.</p>
1712
1833
  */
1713
1834
  Tags?: S3Tag[];
1714
1835
  /**
1836
+ * @public
1715
1837
  * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
1716
1838
  * for the workflow.</p>
1717
1839
  * <ul>
@@ -1748,6 +1870,7 @@ export type WorkflowStepType = (typeof WorkflowStepType)[keyof typeof WorkflowSt
1748
1870
  */
1749
1871
  export interface WorkflowStep {
1750
1872
  /**
1873
+ * @public
1751
1874
  * <p>
1752
1875
  * Currently, the following step types are supported.
1753
1876
  * </p>
@@ -1786,6 +1909,7 @@ export interface WorkflowStep {
1786
1909
  */
1787
1910
  Type?: WorkflowStepType | string;
1788
1911
  /**
1912
+ * @public
1789
1913
  * <p>Details for a step that performs a file copy.</p>
1790
1914
  * <p>
1791
1915
  * Consists of the following values:
@@ -1805,20 +1929,24 @@ export interface WorkflowStep {
1805
1929
  */
1806
1930
  CopyStepDetails?: CopyStepDetails;
1807
1931
  /**
1932
+ * @public
1808
1933
  * <p>Details for a step that invokes an Lambda function.</p>
1809
1934
  * <p>Consists of the Lambda function's name, target, and timeout (in seconds). </p>
1810
1935
  */
1811
1936
  CustomStepDetails?: CustomStepDetails;
1812
1937
  /**
1938
+ * @public
1813
1939
  * <p>Details for a step that deletes the file.</p>
1814
1940
  */
1815
1941
  DeleteStepDetails?: DeleteStepDetails;
1816
1942
  /**
1943
+ * @public
1817
1944
  * <p>Details for a step that creates one or more tags.</p>
1818
1945
  * <p>You specify one or more tags. Each tag contains a key-value pair.</p>
1819
1946
  */
1820
1947
  TagStepDetails?: TagStepDetails;
1821
1948
  /**
1949
+ * @public
1822
1950
  * <p>Details for a step that decrypts an encrypted file.</p>
1823
1951
  * <p>Consists of the following values:</p>
1824
1952
  * <ul>
@@ -1848,10 +1976,12 @@ export interface WorkflowStep {
1848
1976
  */
1849
1977
  export interface CreateWorkflowRequest {
1850
1978
  /**
1979
+ * @public
1851
1980
  * <p>A textual description for the workflow.</p>
1852
1981
  */
1853
1982
  Description?: string;
1854
1983
  /**
1984
+ * @public
1855
1985
  * <p>Specifies the details for the steps that are in the specified workflow.</p>
1856
1986
  * <p>
1857
1987
  * The <code>TYPE</code> specifies which of the following actions is being taken for this step.
@@ -1898,6 +2028,7 @@ export interface CreateWorkflowRequest {
1898
2028
  */
1899
2029
  Steps: WorkflowStep[] | undefined;
1900
2030
  /**
2031
+ * @public
1901
2032
  * <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p>
1902
2033
  * <note>
1903
2034
  * <p>For custom steps, the Lambda function needs to send <code>FAILURE</code> to the call
@@ -1907,6 +2038,7 @@ export interface CreateWorkflowRequest {
1907
2038
  */
1908
2039
  OnExceptionSteps?: WorkflowStep[];
1909
2040
  /**
2041
+ * @public
1910
2042
  * <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached
1911
2043
  * to workflows for any purpose.</p>
1912
2044
  */
@@ -1917,6 +2049,7 @@ export interface CreateWorkflowRequest {
1917
2049
  */
1918
2050
  export interface CreateWorkflowResponse {
1919
2051
  /**
2052
+ * @public
1920
2053
  * <p>A unique identifier for the workflow.</p>
1921
2054
  */
1922
2055
  WorkflowId: string | undefined;
@@ -1938,10 +2071,12 @@ export type CustomStepStatus = (typeof CustomStepStatus)[keyof typeof CustomStep
1938
2071
  */
1939
2072
  export interface DeleteAccessRequest {
1940
2073
  /**
2074
+ * @public
1941
2075
  * <p>A system-assigned unique identifier for a server that has this user assigned.</p>
1942
2076
  */
1943
2077
  ServerId: string | undefined;
1944
2078
  /**
2079
+ * @public
1945
2080
  * <p>A unique identifier that is required to identify specific groups within your directory.
1946
2081
  * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
1947
2082
  * resources over the enabled protocols using Transfer Family. If you know the group name,
@@ -1960,10 +2095,12 @@ export interface DeleteAccessRequest {
1960
2095
  */
1961
2096
  export interface DeleteAgreementRequest {
1962
2097
  /**
2098
+ * @public
1963
2099
  * <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
1964
2100
  */
1965
2101
  AgreementId: string | undefined;
1966
2102
  /**
2103
+ * @public
1967
2104
  * <p>The server identifier associated with the agreement that you are deleting.</p>
1968
2105
  */
1969
2106
  ServerId: string | undefined;
@@ -1973,6 +2110,7 @@ export interface DeleteAgreementRequest {
1973
2110
  */
1974
2111
  export interface DeleteCertificateRequest {
1975
2112
  /**
2113
+ * @public
1976
2114
  * <p>The identifier of the certificate object that you are deleting.</p>
1977
2115
  */
1978
2116
  CertificateId: string | undefined;
@@ -1982,6 +2120,7 @@ export interface DeleteCertificateRequest {
1982
2120
  */
1983
2121
  export interface DeleteConnectorRequest {
1984
2122
  /**
2123
+ * @public
1985
2124
  * <p>The unique identifier for the connector.</p>
1986
2125
  */
1987
2126
  ConnectorId: string | undefined;
@@ -1991,10 +2130,12 @@ export interface DeleteConnectorRequest {
1991
2130
  */
1992
2131
  export interface DeleteHostKeyRequest {
1993
2132
  /**
2133
+ * @public
1994
2134
  * <p>The identifier of the server that contains the host key that you are deleting.</p>
1995
2135
  */
1996
2136
  ServerId: string | undefined;
1997
2137
  /**
2138
+ * @public
1998
2139
  * <p>The identifier of the host key that you are deleting.</p>
1999
2140
  */
2000
2141
  HostKeyId: string | undefined;
@@ -2004,6 +2145,7 @@ export interface DeleteHostKeyRequest {
2004
2145
  */
2005
2146
  export interface DeleteProfileRequest {
2006
2147
  /**
2148
+ * @public
2007
2149
  * <p>The identifier of the profile that you are deleting.</p>
2008
2150
  */
2009
2151
  ProfileId: string | undefined;
@@ -2013,6 +2155,7 @@ export interface DeleteProfileRequest {
2013
2155
  */
2014
2156
  export interface DeleteServerRequest {
2015
2157
  /**
2158
+ * @public
2016
2159
  * <p>A unique system-assigned identifier for a server instance.</p>
2017
2160
  */
2018
2161
  ServerId: string | undefined;
@@ -2022,15 +2165,18 @@ export interface DeleteServerRequest {
2022
2165
  */
2023
2166
  export interface DeleteSshPublicKeyRequest {
2024
2167
  /**
2168
+ * @public
2025
2169
  * <p>A system-assigned unique identifier for a file transfer protocol-enabled server instance
2026
2170
  * that has the user assigned to it.</p>
2027
2171
  */
2028
2172
  ServerId: string | undefined;
2029
2173
  /**
2174
+ * @public
2030
2175
  * <p>A unique identifier used to reference your user's specific SSH key.</p>
2031
2176
  */
2032
2177
  SshPublicKeyId: string | undefined;
2033
2178
  /**
2179
+ * @public
2034
2180
  * <p>A unique string that identifies a user whose public key is being deleted.</p>
2035
2181
  */
2036
2182
  UserName: string | undefined;
@@ -2040,11 +2186,13 @@ export interface DeleteSshPublicKeyRequest {
2040
2186
  */
2041
2187
  export interface DeleteUserRequest {
2042
2188
  /**
2189
+ * @public
2043
2190
  * <p>A system-assigned unique identifier for a server instance that has the user assigned to
2044
2191
  * it.</p>
2045
2192
  */
2046
2193
  ServerId: string | undefined;
2047
2194
  /**
2195
+ * @public
2048
2196
  * <p>A unique string that identifies a user that is being deleted from a server.</p>
2049
2197
  */
2050
2198
  UserName: string | undefined;
@@ -2054,6 +2202,7 @@ export interface DeleteUserRequest {
2054
2202
  */
2055
2203
  export interface DeleteWorkflowRequest {
2056
2204
  /**
2205
+ * @public
2057
2206
  * <p>A unique identifier for the workflow.</p>
2058
2207
  */
2059
2208
  WorkflowId: string | undefined;
@@ -2063,10 +2212,12 @@ export interface DeleteWorkflowRequest {
2063
2212
  */
2064
2213
  export interface DescribeAccessRequest {
2065
2214
  /**
2215
+ * @public
2066
2216
  * <p>A system-assigned unique identifier for a server that has this access assigned.</p>
2067
2217
  */
2068
2218
  ServerId: string | undefined;
2069
2219
  /**
2220
+ * @public
2070
2221
  * <p>A unique identifier that is required to identify specific groups within your directory.
2071
2222
  * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
2072
2223
  * resources over the enabled protocols using Transfer Family. If you know the group name,
@@ -2086,11 +2237,13 @@ export interface DescribeAccessRequest {
2086
2237
  */
2087
2238
  export interface DescribedAccess {
2088
2239
  /**
2240
+ * @public
2089
2241
  * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
2090
2242
  * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
2091
2243
  */
2092
2244
  HomeDirectory?: string;
2093
2245
  /**
2246
+ * @public
2094
2247
  * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
2095
2248
  * be visible to your user and how you want to make them visible. You must specify the
2096
2249
  * <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
@@ -2106,6 +2259,7 @@ export interface DescribedAccess {
2106
2259
  */
2107
2260
  HomeDirectoryMappings?: HomeDirectoryMapEntry[];
2108
2261
  /**
2262
+ * @public
2109
2263
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
2110
2264
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer
2111
2265
  * protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
@@ -2113,12 +2267,14 @@ export interface DescribedAccess {
2113
2267
  */
2114
2268
  HomeDirectoryType?: HomeDirectoryType | string;
2115
2269
  /**
2270
+ * @public
2116
2271
  * <p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's
2117
2272
  * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>$\{Transfer:UserName\}</code>,
2118
2273
  * <code>$\{Transfer:HomeDirectory\}</code>, and <code>$\{Transfer:HomeBucket\}</code>.</p>
2119
2274
  */
2120
2275
  Policy?: string;
2121
2276
  /**
2277
+ * @public
2122
2278
  * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
2123
2279
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
2124
2280
  * your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
@@ -2127,6 +2283,7 @@ export interface DescribedAccess {
2127
2283
  */
2128
2284
  PosixProfile?: PosixProfile;
2129
2285
  /**
2286
+ * @public
2130
2287
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
2131
2288
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
2132
2289
  * when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
@@ -2134,6 +2291,7 @@ export interface DescribedAccess {
2134
2291
  */
2135
2292
  Role?: string;
2136
2293
  /**
2294
+ * @public
2137
2295
  * <p>A unique identifier that is required to identify specific groups within your directory.
2138
2296
  * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
2139
2297
  * resources over the enabled protocols using Transfer Family. If you know the group name,
@@ -2152,10 +2310,12 @@ export interface DescribedAccess {
2152
2310
  */
2153
2311
  export interface DescribeAccessResponse {
2154
2312
  /**
2313
+ * @public
2155
2314
  * <p>A system-assigned unique identifier for a server that has this access assigned.</p>
2156
2315
  */
2157
2316
  ServerId: string | undefined;
2158
2317
  /**
2318
+ * @public
2159
2319
  * <p>The external identifier of the server that the access is attached to.</p>
2160
2320
  */
2161
2321
  Access: DescribedAccess | undefined;
@@ -2165,10 +2325,12 @@ export interface DescribeAccessResponse {
2165
2325
  */
2166
2326
  export interface DescribeAgreementRequest {
2167
2327
  /**
2328
+ * @public
2168
2329
  * <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
2169
2330
  */
2170
2331
  AgreementId: string | undefined;
2171
2332
  /**
2333
+ * @public
2172
2334
  * <p>The server identifier that's associated with the agreement.</p>
2173
2335
  */
2174
2336
  ServerId: string | undefined;
@@ -2179,41 +2341,50 @@ export interface DescribeAgreementRequest {
2179
2341
  */
2180
2342
  export interface DescribedAgreement {
2181
2343
  /**
2344
+ * @public
2182
2345
  * <p>The unique Amazon Resource Name (ARN) for the agreement.</p>
2183
2346
  */
2184
2347
  Arn: string | undefined;
2185
2348
  /**
2349
+ * @public
2186
2350
  * <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
2187
2351
  */
2188
2352
  AgreementId?: string;
2189
2353
  /**
2354
+ * @public
2190
2355
  * <p>The name or short description that's used to identify the agreement.</p>
2191
2356
  */
2192
2357
  Description?: string;
2193
2358
  /**
2359
+ * @public
2194
2360
  * <p>The current status of the agreement, either <code>ACTIVE</code> or
2195
2361
  * <code>INACTIVE</code>.</p>
2196
2362
  */
2197
2363
  Status?: AgreementStatusType | string;
2198
2364
  /**
2365
+ * @public
2199
2366
  * <p>A system-assigned unique identifier for a server instance. This identifier indicates the
2200
2367
  * specific server that the agreement uses.</p>
2201
2368
  */
2202
2369
  ServerId?: string;
2203
2370
  /**
2371
+ * @public
2204
2372
  * <p>A unique identifier for the AS2 local profile.</p>
2205
2373
  */
2206
2374
  LocalProfileId?: string;
2207
2375
  /**
2376
+ * @public
2208
2377
  * <p>A unique identifier for the partner profile used in the agreement.</p>
2209
2378
  */
2210
2379
  PartnerProfileId?: string;
2211
2380
  /**
2381
+ * @public
2212
2382
  * <p>The landing directory (folder) for files that are transferred by using the AS2
2213
2383
  * protocol.</p>
2214
2384
  */
2215
2385
  BaseDirectory?: string;
2216
2386
  /**
2387
+ * @public
2217
2388
  * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
2218
2389
  * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
2219
2390
  * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
@@ -2231,6 +2402,7 @@ export interface DescribedAgreement {
2231
2402
  */
2232
2403
  AccessRole?: string;
2233
2404
  /**
2405
+ * @public
2234
2406
  * <p>Key-value pairs that can be used to group and search for agreements.</p>
2235
2407
  */
2236
2408
  Tags?: Tag[];
@@ -2240,6 +2412,7 @@ export interface DescribedAgreement {
2240
2412
  */
2241
2413
  export interface DescribeAgreementResponse {
2242
2414
  /**
2415
+ * @public
2243
2416
  * <p>The details for the specified agreement, returned as a <code>DescribedAgreement</code>
2244
2417
  * object.</p>
2245
2418
  */
@@ -2250,6 +2423,7 @@ export interface DescribeAgreementResponse {
2250
2423
  */
2251
2424
  export interface DescribeCertificateRequest {
2252
2425
  /**
2426
+ * @public
2253
2427
  * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
2254
2428
  */
2255
2429
  CertificateId: string | undefined;
@@ -2260,61 +2434,75 @@ export interface DescribeCertificateRequest {
2260
2434
  */
2261
2435
  export interface DescribedCertificate {
2262
2436
  /**
2437
+ * @public
2263
2438
  * <p>The unique Amazon Resource Name (ARN) for the certificate.</p>
2264
2439
  */
2265
2440
  Arn: string | undefined;
2266
2441
  /**
2442
+ * @public
2267
2443
  * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
2268
2444
  */
2269
2445
  CertificateId?: string;
2270
2446
  /**
2447
+ * @public
2271
2448
  * <p>Specifies whether this certificate is used for signing or encryption.</p>
2272
2449
  */
2273
2450
  Usage?: CertificateUsageType | string;
2274
2451
  /**
2452
+ * @public
2275
2453
  * <p>The certificate can be either <code>ACTIVE</code>, <code>PENDING_ROTATION</code>, or
2276
2454
  * <code>INACTIVE</code>. <code>PENDING_ROTATION</code> means that this certificate will
2277
2455
  * replace the current certificate when it expires.</p>
2278
2456
  */
2279
2457
  Status?: CertificateStatusType | string;
2280
2458
  /**
2459
+ * @public
2281
2460
  * <p>The file name for the certificate.</p>
2282
2461
  */
2283
2462
  Certificate?: string;
2284
2463
  /**
2464
+ * @public
2285
2465
  * <p>The list of certificates that make up the chain for the certificate.</p>
2286
2466
  */
2287
2467
  CertificateChain?: string;
2288
2468
  /**
2469
+ * @public
2289
2470
  * <p>An optional date that specifies when the certificate becomes active.</p>
2290
2471
  */
2291
2472
  ActiveDate?: Date;
2292
2473
  /**
2474
+ * @public
2293
2475
  * <p>An optional date that specifies when the certificate becomes inactive.</p>
2294
2476
  */
2295
2477
  InactiveDate?: Date;
2296
2478
  /**
2479
+ * @public
2297
2480
  * <p>The serial number for the certificate.</p>
2298
2481
  */
2299
2482
  Serial?: string;
2300
2483
  /**
2484
+ * @public
2301
2485
  * <p>The earliest date that the certificate is valid.</p>
2302
2486
  */
2303
2487
  NotBeforeDate?: Date;
2304
2488
  /**
2489
+ * @public
2305
2490
  * <p>The final date that the certificate is
2306
2491
  * valid.</p>
2307
2492
  */
2308
2493
  NotAfterDate?: Date;
2309
2494
  /**
2495
+ * @public
2310
2496
  * <p>If a private key has been specified for the certificate, its type is <code>CERTIFICATE_WITH_PRIVATE_KEY</code>. If there is no private key, the type is <code>CERTIFICATE</code>.</p>
2311
2497
  */
2312
2498
  Type?: CertificateType | string;
2313
2499
  /**
2500
+ * @public
2314
2501
  * <p>The name or description that's used to identity the certificate. </p>
2315
2502
  */
2316
2503
  Description?: string;
2317
2504
  /**
2505
+ * @public
2318
2506
  * <p>Key-value pairs that can be used to group and search for certificates.</p>
2319
2507
  */
2320
2508
  Tags?: Tag[];
@@ -2324,6 +2512,7 @@ export interface DescribedCertificate {
2324
2512
  */
2325
2513
  export interface DescribeCertificateResponse {
2326
2514
  /**
2515
+ * @public
2327
2516
  * <p>The details for the specified certificate, returned as an object.</p>
2328
2517
  */
2329
2518
  Certificate: DescribedCertificate | undefined;
@@ -2333,6 +2522,7 @@ export interface DescribeCertificateResponse {
2333
2522
  */
2334
2523
  export interface DescribeConnectorRequest {
2335
2524
  /**
2525
+ * @public
2336
2526
  * <p>The unique identifier for the connector.</p>
2337
2527
  */
2338
2528
  ConnectorId: string | undefined;
@@ -2344,22 +2534,27 @@ export interface DescribeConnectorRequest {
2344
2534
  */
2345
2535
  export interface DescribedConnector {
2346
2536
  /**
2537
+ * @public
2347
2538
  * <p>The unique Amazon Resource Name (ARN) for the connector.</p>
2348
2539
  */
2349
2540
  Arn: string | undefined;
2350
2541
  /**
2542
+ * @public
2351
2543
  * <p>The unique identifier for the connector.</p>
2352
2544
  */
2353
2545
  ConnectorId?: string;
2354
2546
  /**
2547
+ * @public
2355
2548
  * <p>The URL of the partner's AS2 or SFTP endpoint.</p>
2356
2549
  */
2357
2550
  Url?: string;
2358
2551
  /**
2552
+ * @public
2359
2553
  * <p>A structure that contains the parameters for an AS2 connector object.</p>
2360
2554
  */
2361
2555
  As2Config?: As2ConnectorConfig;
2362
2556
  /**
2557
+ * @public
2363
2558
  * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
2364
2559
  * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
2365
2560
  * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
@@ -2377,16 +2572,19 @@ export interface DescribedConnector {
2377
2572
  */
2378
2573
  AccessRole?: string;
2379
2574
  /**
2575
+ * @public
2380
2576
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn
2381
2577
  * on CloudWatch logging for Amazon S3 events. When set, you can view connector
2382
2578
  * activity in your CloudWatch logs.</p>
2383
2579
  */
2384
2580
  LoggingRole?: string;
2385
2581
  /**
2582
+ * @public
2386
2583
  * <p>Key-value pairs that can be used to group and search for connectors.</p>
2387
2584
  */
2388
2585
  Tags?: Tag[];
2389
2586
  /**
2587
+ * @public
2390
2588
  * <p>A structure that contains the parameters for an SFTP connector object.</p>
2391
2589
  */
2392
2590
  SftpConfig?: SftpConnectorConfig;
@@ -2396,6 +2594,7 @@ export interface DescribedConnector {
2396
2594
  */
2397
2595
  export interface DescribeConnectorResponse {
2398
2596
  /**
2597
+ * @public
2399
2598
  * <p>The structure that contains the details of the connector.</p>
2400
2599
  */
2401
2600
  Connector: DescribedConnector | undefined;
@@ -2406,18 +2605,22 @@ export interface DescribeConnectorResponse {
2406
2605
  */
2407
2606
  export interface S3FileLocation {
2408
2607
  /**
2608
+ * @public
2409
2609
  * <p>Specifies the S3 bucket that contains the file being used.</p>
2410
2610
  */
2411
2611
  Bucket?: string;
2412
2612
  /**
2613
+ * @public
2413
2614
  * <p>The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.</p>
2414
2615
  */
2415
2616
  Key?: string;
2416
2617
  /**
2618
+ * @public
2417
2619
  * <p>Specifies the file version.</p>
2418
2620
  */
2419
2621
  VersionId?: string;
2420
2622
  /**
2623
+ * @public
2421
2624
  * <p>The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.</p>
2422
2625
  */
2423
2626
  Etag?: string;
@@ -2428,11 +2631,13 @@ export interface S3FileLocation {
2428
2631
  */
2429
2632
  export interface FileLocation {
2430
2633
  /**
2634
+ * @public
2431
2635
  * <p>Specifies the S3 details for the file being used, such as bucket, ETag, and so
2432
2636
  * forth.</p>
2433
2637
  */
2434
2638
  S3FileLocation?: S3FileLocation;
2435
2639
  /**
2640
+ * @public
2436
2641
  * <p>Specifies the Amazon EFS identifier and the path for the file being used.</p>
2437
2642
  */
2438
2643
  EfsFileLocation?: EfsFileLocation;
@@ -2443,12 +2648,14 @@ export interface FileLocation {
2443
2648
  */
2444
2649
  export interface LoggingConfiguration {
2445
2650
  /**
2651
+ * @public
2446
2652
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
2447
2653
  * on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
2448
2654
  * your CloudWatch logs.</p>
2449
2655
  */
2450
2656
  LoggingRole?: string;
2451
2657
  /**
2658
+ * @public
2452
2659
  * <p>The name of the CloudWatch logging group for the Transfer Family server to which this workflow belongs.</p>
2453
2660
  */
2454
2661
  LogGroupName?: string;
@@ -2477,6 +2684,7 @@ export type ExecutionErrorType = (typeof ExecutionErrorType)[keyof typeof Execut
2477
2684
  */
2478
2685
  export interface ExecutionError {
2479
2686
  /**
2687
+ * @public
2480
2688
  * <p>Specifies the error type.</p>
2481
2689
  * <ul>
2482
2690
  * <li>
@@ -2523,6 +2731,7 @@ export interface ExecutionError {
2523
2731
  */
2524
2732
  Type: ExecutionErrorType | string | undefined;
2525
2733
  /**
2734
+ * @public
2526
2735
  * <p>Specifies the descriptive message that corresponds to the <code>ErrorType</code>.</p>
2527
2736
  */
2528
2737
  Message: string | undefined;
@@ -2533,6 +2742,7 @@ export interface ExecutionError {
2533
2742
  */
2534
2743
  export interface ExecutionStepResult {
2535
2744
  /**
2745
+ * @public
2536
2746
  * <p>One of the available step types.</p>
2537
2747
  * <ul>
2538
2748
  * <li>
@@ -2569,10 +2779,12 @@ export interface ExecutionStepResult {
2569
2779
  */
2570
2780
  StepType?: WorkflowStepType | string;
2571
2781
  /**
2782
+ * @public
2572
2783
  * <p>The values for the key/value pair applied as a tag to the file. Only applicable if the step type is <code>TAG</code>.</p>
2573
2784
  */
2574
2785
  Outputs?: string;
2575
2786
  /**
2787
+ * @public
2576
2788
  * <p>Specifies the details for an error, if it occurred during execution of the specified
2577
2789
  * workflow step.</p>
2578
2790
  */
@@ -2584,10 +2796,12 @@ export interface ExecutionStepResult {
2584
2796
  */
2585
2797
  export interface ExecutionResults {
2586
2798
  /**
2799
+ * @public
2587
2800
  * <p>Specifies the details for the steps that are in the specified workflow.</p>
2588
2801
  */
2589
2802
  Steps?: ExecutionStepResult[];
2590
2803
  /**
2804
+ * @public
2591
2805
  * <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p>
2592
2806
  */
2593
2807
  OnExceptionSteps?: ExecutionStepResult[];
@@ -2598,14 +2812,17 @@ export interface ExecutionResults {
2598
2812
  */
2599
2813
  export interface UserDetails {
2600
2814
  /**
2815
+ * @public
2601
2816
  * <p>A unique string that identifies a Transfer Family user associated with a server.</p>
2602
2817
  */
2603
2818
  UserName: string | undefined;
2604
2819
  /**
2820
+ * @public
2605
2821
  * <p>The system-assigned unique identifier for a Transfer server instance. </p>
2606
2822
  */
2607
2823
  ServerId: string | undefined;
2608
2824
  /**
2825
+ * @public
2609
2826
  * <p>The system-assigned unique identifier for a session that corresponds to the workflow.</p>
2610
2827
  */
2611
2828
  SessionId?: string;
@@ -2616,6 +2833,7 @@ export interface UserDetails {
2616
2833
  */
2617
2834
  export interface ServiceMetadata {
2618
2835
  /**
2836
+ * @public
2619
2837
  * <p>The Server ID (<code>ServerId</code>), Session ID (<code>SessionId</code>) and user (<code>UserName</code>) make up the <code>UserDetails</code>.</p>
2620
2838
  */
2621
2839
  UserDetails: UserDetails | undefined;
@@ -2640,28 +2858,34 @@ export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionSta
2640
2858
  */
2641
2859
  export interface DescribedExecution {
2642
2860
  /**
2861
+ * @public
2643
2862
  * <p>A unique identifier for the execution of a workflow.</p>
2644
2863
  */
2645
2864
  ExecutionId?: string;
2646
2865
  /**
2866
+ * @public
2647
2867
  * <p>A structure that describes the Amazon S3 or EFS file location.
2648
2868
  * This is the file location when the execution begins: if the file is being copied,
2649
2869
  * this is the initial (as opposed to destination) file location.</p>
2650
2870
  */
2651
2871
  InitialFileLocation?: FileLocation;
2652
2872
  /**
2873
+ * @public
2653
2874
  * <p>A container object for the session details that are associated with a workflow.</p>
2654
2875
  */
2655
2876
  ServiceMetadata?: ServiceMetadata;
2656
2877
  /**
2878
+ * @public
2657
2879
  * <p>The IAM role associated with the execution.</p>
2658
2880
  */
2659
2881
  ExecutionRole?: string;
2660
2882
  /**
2883
+ * @public
2661
2884
  * <p>The IAM logging role associated with the execution.</p>
2662
2885
  */
2663
2886
  LoggingConfiguration?: LoggingConfiguration;
2664
2887
  /**
2888
+ * @public
2665
2889
  * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
2666
2890
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
2667
2891
  * your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
@@ -2670,11 +2894,13 @@ export interface DescribedExecution {
2670
2894
  */
2671
2895
  PosixProfile?: PosixProfile;
2672
2896
  /**
2897
+ * @public
2673
2898
  * <p>The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
2674
2899
  * </p>
2675
2900
  */
2676
2901
  Status?: ExecutionStatus | string;
2677
2902
  /**
2903
+ * @public
2678
2904
  * <p>A structure that describes the execution results. This includes a list of the steps along with the details of each step,
2679
2905
  * error type and message (if any), and the <code>OnExceptionSteps</code> structure.</p>
2680
2906
  */
@@ -2686,22 +2912,27 @@ export interface DescribedExecution {
2686
2912
  */
2687
2913
  export interface DescribedHostKey {
2688
2914
  /**
2915
+ * @public
2689
2916
  * <p>The unique Amazon Resource Name (ARN) for the host key.</p>
2690
2917
  */
2691
2918
  Arn: string | undefined;
2692
2919
  /**
2920
+ * @public
2693
2921
  * <p>A unique identifier for the host key.</p>
2694
2922
  */
2695
2923
  HostKeyId?: string;
2696
2924
  /**
2925
+ * @public
2697
2926
  * <p>The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.</p>
2698
2927
  */
2699
2928
  HostKeyFingerprint?: string;
2700
2929
  /**
2930
+ * @public
2701
2931
  * <p>The text description for this host key.</p>
2702
2932
  */
2703
2933
  Description?: string;
2704
2934
  /**
2935
+ * @public
2705
2936
  * <p>The encryption algorithm that is used for the host key. The <code>Type</code> parameter is specified by using one of the
2706
2937
  * following values:</p>
2707
2938
  * <ul>
@@ -2734,10 +2965,12 @@ export interface DescribedHostKey {
2734
2965
  */
2735
2966
  Type?: string;
2736
2967
  /**
2968
+ * @public
2737
2969
  * <p>The date on which the host key was added to the server.</p>
2738
2970
  */
2739
2971
  DateImported?: Date;
2740
2972
  /**
2973
+ * @public
2741
2974
  * <p>Key-value pairs that can be used to group and search for host keys.</p>
2742
2975
  */
2743
2976
  Tags?: Tag[];
@@ -2748,19 +2981,23 @@ export interface DescribedHostKey {
2748
2981
  */
2749
2982
  export interface DescribedProfile {
2750
2983
  /**
2984
+ * @public
2751
2985
  * <p>The unique Amazon Resource Name (ARN) for the profile.</p>
2752
2986
  */
2753
2987
  Arn: string | undefined;
2754
2988
  /**
2989
+ * @public
2755
2990
  * <p>A unique identifier for the local or partner AS2 profile.</p>
2756
2991
  */
2757
2992
  ProfileId?: string;
2758
2993
  /**
2994
+ * @public
2759
2995
  * <p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles.
2760
2996
  * If not supplied in the request, the command lists all types of profiles.</p>
2761
2997
  */
2762
2998
  ProfileType?: ProfileType | string;
2763
2999
  /**
3000
+ * @public
2764
3001
  * <p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the
2765
3002
  * <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages
2766
3003
  * sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the
@@ -2768,10 +3005,12 @@ export interface DescribedProfile {
2768
3005
  */
2769
3006
  As2Id?: string;
2770
3007
  /**
3008
+ * @public
2771
3009
  * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
2772
3010
  */
2773
3011
  CertificateIds?: string[];
2774
3012
  /**
3013
+ * @public
2775
3014
  * <p>Key-value pairs that can be used to group and search for profiles.</p>
2776
3015
  */
2777
3016
  Tags?: Tag[];
@@ -2784,30 +3023,36 @@ export interface DescribedProfile {
2784
3023
  */
2785
3024
  export interface DescribedSecurityPolicy {
2786
3025
  /**
3026
+ * @public
2787
3027
  * <p>Specifies whether this policy enables Federal Information Processing Standards
2788
3028
  * (FIPS).</p>
2789
3029
  */
2790
3030
  Fips?: boolean;
2791
3031
  /**
3032
+ * @public
2792
3033
  * <p>Specifies the name of the security policy that is attached to the server.</p>
2793
3034
  */
2794
3035
  SecurityPolicyName: string | undefined;
2795
3036
  /**
3037
+ * @public
2796
3038
  * <p>Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security
2797
3039
  * policy that is attached to the server.</p>
2798
3040
  */
2799
3041
  SshCiphers?: string[];
2800
3042
  /**
3043
+ * @public
2801
3044
  * <p>Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy
2802
3045
  * that is attached to the server.</p>
2803
3046
  */
2804
3047
  SshKexs?: string[];
2805
3048
  /**
3049
+ * @public
2806
3050
  * <p>Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the
2807
3051
  * security policy that is attached to the server.</p>
2808
3052
  */
2809
3053
  SshMacs?: string[];
2810
3054
  /**
3055
+ * @public
2811
3056
  * <p>Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the
2812
3057
  * security policy that is attached to the server.</p>
2813
3058
  */
@@ -2836,15 +3081,18 @@ export type State = (typeof State)[keyof typeof State];
2836
3081
  */
2837
3082
  export interface DescribedServer {
2838
3083
  /**
3084
+ * @public
2839
3085
  * <p>Specifies the unique Amazon Resource Name (ARN) of the server.</p>
2840
3086
  */
2841
3087
  Arn: string | undefined;
2842
3088
  /**
3089
+ * @public
2843
3090
  * <p>Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
2844
3091
  * <code>Protocols</code> is set to <code>FTPS</code>.</p>
2845
3092
  */
2846
3093
  Certificate?: string;
2847
3094
  /**
3095
+ * @public
2848
3096
  * <p>The protocol settings that are configured for your server.</p>
2849
3097
  * <ul>
2850
3098
  * <li>
@@ -2873,10 +3121,12 @@ export interface DescribedServer {
2873
3121
  */
2874
3122
  ProtocolDetails?: ProtocolDetails;
2875
3123
  /**
3124
+ * @public
2876
3125
  * <p>Specifies the domain of the storage system that is used for file transfers.</p>
2877
3126
  */
2878
3127
  Domain?: Domain | string;
2879
3128
  /**
3129
+ * @public
2880
3130
  * <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
2881
3131
  * When you host your endpoint within your VPC, you can make your endpoint accessible only to resources
2882
3132
  * within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over
@@ -2885,23 +3135,27 @@ export interface DescribedServer {
2885
3135
  */
2886
3136
  EndpointDetails?: EndpointDetails;
2887
3137
  /**
3138
+ * @public
2888
3139
  * <p>Defines the type of endpoint that your server is connected to. If your server is connected
2889
3140
  * to a VPC endpoint, your server isn't accessible over the public internet.</p>
2890
3141
  */
2891
3142
  EndpointType?: EndpointType | string;
2892
3143
  /**
3144
+ * @public
2893
3145
  * <p>Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value
2894
3146
  * is equivalent to the output of the <code>ssh-keygen -l -f my-new-server-key</code>
2895
3147
  * command.</p>
2896
3148
  */
2897
3149
  HostKeyFingerprint?: string;
2898
3150
  /**
3151
+ * @public
2899
3152
  * <p>Specifies information to call a customer-supplied authentication API. This field is not
2900
3153
  * populated when the <code>IdentityProviderType</code> of a server is
2901
3154
  * <code>AWS_DIRECTORY_SERVICE</code> or <code>SERVICE_MANAGED</code>.</p>
2902
3155
  */
2903
3156
  IdentityProviderDetails?: IdentityProviderDetails;
2904
3157
  /**
3158
+ * @public
2905
3159
  * <p>The mode of authentication for a server. The default value is
2906
3160
  * <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
2907
3161
  * the Transfer Family service.</p>
@@ -2918,12 +3172,14 @@ export interface DescribedServer {
2918
3172
  */
2919
3173
  IdentityProviderType?: IdentityProviderType | string;
2920
3174
  /**
3175
+ * @public
2921
3176
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
2922
3177
  * on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
2923
3178
  * your CloudWatch logs.</p>
2924
3179
  */
2925
3180
  LoggingRole?: string;
2926
3181
  /**
3182
+ * @public
2927
3183
  * <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p>
2928
3184
  * <note>
2929
3185
  * <p>The SFTP protocol does not support post-authentication display banners.</p>
@@ -2931,6 +3187,7 @@ export interface DescribedServer {
2931
3187
  */
2932
3188
  PostAuthenticationLoginBanner?: string;
2933
3189
  /**
3190
+ * @public
2934
3191
  * <p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.
2935
3192
  * For example, the following banner displays details about using the system:</p>
2936
3193
  * <p>
@@ -2941,6 +3198,7 @@ export interface DescribedServer {
2941
3198
  */
2942
3199
  PreAuthenticationLoginBanner?: string;
2943
3200
  /**
3201
+ * @public
2944
3202
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
2945
3203
  * client can connect to your server's endpoint. The available protocols are:</p>
2946
3204
  * <ul>
@@ -2993,14 +3251,17 @@ export interface DescribedServer {
2993
3251
  */
2994
3252
  Protocols?: (Protocol | string)[];
2995
3253
  /**
3254
+ * @public
2996
3255
  * <p>Specifies the name of the security policy that is attached to the server.</p>
2997
3256
  */
2998
3257
  SecurityPolicyName?: string;
2999
3258
  /**
3259
+ * @public
3000
3260
  * <p>Specifies the unique system-assigned identifier for a server that you instantiate.</p>
3001
3261
  */
3002
3262
  ServerId?: string;
3003
3263
  /**
3264
+ * @public
3004
3265
  * <p>The condition of the server that was described. A value of
3005
3266
  * <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A
3006
3267
  * <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file
@@ -3012,16 +3273,19 @@ export interface DescribedServer {
3012
3273
  */
3013
3274
  State?: State | string;
3014
3275
  /**
3276
+ * @public
3015
3277
  * <p>Specifies the key-value pairs that you can use to search for and group servers that were
3016
3278
  * assigned to the server that was described.</p>
3017
3279
  */
3018
3280
  Tags?: Tag[];
3019
3281
  /**
3282
+ * @public
3020
3283
  * <p>Specifies the number of users that are assigned to a server you specified with the
3021
3284
  * <code>ServerId</code>.</p>
3022
3285
  */
3023
3286
  UserCount?: number;
3024
3287
  /**
3288
+ * @public
3025
3289
  * <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
3026
3290
  * <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> can also contain a
3027
3291
  * workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects
@@ -3029,6 +3293,7 @@ export interface DescribedServer {
3029
3293
  */
3030
3294
  WorkflowDetails?: WorkflowDetails;
3031
3295
  /**
3296
+ * @public
3032
3297
  * <p>Specifies the log groups to which your server logs are sent.</p>
3033
3298
  * <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p>
3034
3299
  * <p>
@@ -3054,16 +3319,19 @@ export interface DescribedServer {
3054
3319
  */
3055
3320
  export interface SshPublicKey {
3056
3321
  /**
3322
+ * @public
3057
3323
  * <p>Specifies the date that the public key was added to the Transfer Family user.</p>
3058
3324
  */
3059
3325
  DateImported: Date | undefined;
3060
3326
  /**
3327
+ * @public
3061
3328
  * <p>Specifies the content of the SSH public key as specified by the
3062
3329
  * <code>PublicKeyId</code>.</p>
3063
3330
  * <p>Transfer Family accepts RSA, ECDSA, and ED25519 keys.</p>
3064
3331
  */
3065
3332
  SshPublicKeyBody: string | undefined;
3066
3333
  /**
3334
+ * @public
3067
3335
  * <p>Specifies the <code>SshPublicKeyId</code> parameter contains the identifier of the public
3068
3336
  * key.</p>
3069
3337
  */
@@ -3075,16 +3343,19 @@ export interface SshPublicKey {
3075
3343
  */
3076
3344
  export interface DescribedUser {
3077
3345
  /**
3346
+ * @public
3078
3347
  * <p>Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be
3079
3348
  * described.</p>
3080
3349
  */
3081
3350
  Arn: string | undefined;
3082
3351
  /**
3352
+ * @public
3083
3353
  * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
3084
3354
  * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
3085
3355
  */
3086
3356
  HomeDirectory?: string;
3087
3357
  /**
3358
+ * @public
3088
3359
  * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
3089
3360
  * be visible to your user and how you want to make them visible. You must specify the
3090
3361
  * <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
@@ -3100,6 +3371,7 @@ export interface DescribedUser {
3100
3371
  */
3101
3372
  HomeDirectoryMappings?: HomeDirectoryMapEntry[];
3102
3373
  /**
3374
+ * @public
3103
3375
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
3104
3376
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer
3105
3377
  * protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
@@ -3107,12 +3379,14 @@ export interface DescribedUser {
3107
3379
  */
3108
3380
  HomeDirectoryType?: HomeDirectoryType | string;
3109
3381
  /**
3382
+ * @public
3110
3383
  * <p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's
3111
3384
  * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>$\{Transfer:UserName\}</code>,
3112
3385
  * <code>$\{Transfer:HomeDirectory\}</code>, and <code>$\{Transfer:HomeBucket\}</code>.</p>
3113
3386
  */
3114
3387
  Policy?: string;
3115
3388
  /**
3389
+ * @public
3116
3390
  * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID
3117
3391
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
3118
3392
  * your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX
@@ -3122,6 +3396,7 @@ export interface DescribedUser {
3122
3396
  */
3123
3397
  PosixProfile?: PosixProfile;
3124
3398
  /**
3399
+ * @public
3125
3400
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
3126
3401
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
3127
3402
  * when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
@@ -3129,16 +3404,19 @@ export interface DescribedUser {
3129
3404
  */
3130
3405
  Role?: string;
3131
3406
  /**
3407
+ * @public
3132
3408
  * <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for the described
3133
3409
  * user.</p>
3134
3410
  */
3135
3411
  SshPublicKeys?: SshPublicKey[];
3136
3412
  /**
3413
+ * @public
3137
3414
  * <p>Specifies the key-value pairs for the user requested. Tag can be used to search for and
3138
3415
  * group users for a variety of purposes.</p>
3139
3416
  */
3140
3417
  Tags?: Tag[];
3141
3418
  /**
3419
+ * @public
3142
3420
  * <p>Specifies the name of the user that was requested to be described. User names are used for
3143
3421
  * authentication purposes. This is the string that will be used by your user when they log in to
3144
3422
  * your server.</p>
@@ -3151,26 +3429,32 @@ export interface DescribedUser {
3151
3429
  */
3152
3430
  export interface DescribedWorkflow {
3153
3431
  /**
3432
+ * @public
3154
3433
  * <p>Specifies the unique Amazon Resource Name (ARN) for the workflow.</p>
3155
3434
  */
3156
3435
  Arn: string | undefined;
3157
3436
  /**
3437
+ * @public
3158
3438
  * <p>Specifies the text description for the workflow.</p>
3159
3439
  */
3160
3440
  Description?: string;
3161
3441
  /**
3442
+ * @public
3162
3443
  * <p>Specifies the details for the steps that are in the specified workflow.</p>
3163
3444
  */
3164
3445
  Steps?: WorkflowStep[];
3165
3446
  /**
3447
+ * @public
3166
3448
  * <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p>
3167
3449
  */
3168
3450
  OnExceptionSteps?: WorkflowStep[];
3169
3451
  /**
3452
+ * @public
3170
3453
  * <p>A unique identifier for the workflow.</p>
3171
3454
  */
3172
3455
  WorkflowId?: string;
3173
3456
  /**
3457
+ * @public
3174
3458
  * <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</p>
3175
3459
  */
3176
3460
  Tags?: Tag[];
@@ -3180,10 +3464,12 @@ export interface DescribedWorkflow {
3180
3464
  */
3181
3465
  export interface DescribeExecutionRequest {
3182
3466
  /**
3467
+ * @public
3183
3468
  * <p>A unique identifier for the execution of a workflow.</p>
3184
3469
  */
3185
3470
  ExecutionId: string | undefined;
3186
3471
  /**
3472
+ * @public
3187
3473
  * <p>A unique identifier for the workflow.</p>
3188
3474
  */
3189
3475
  WorkflowId: string | undefined;
@@ -3193,10 +3479,12 @@ export interface DescribeExecutionRequest {
3193
3479
  */
3194
3480
  export interface DescribeExecutionResponse {
3195
3481
  /**
3482
+ * @public
3196
3483
  * <p>A unique identifier for the workflow.</p>
3197
3484
  */
3198
3485
  WorkflowId: string | undefined;
3199
3486
  /**
3487
+ * @public
3200
3488
  * <p>The structure that contains the details of the workflow' execution.</p>
3201
3489
  */
3202
3490
  Execution: DescribedExecution | undefined;
@@ -3206,10 +3494,12 @@ export interface DescribeExecutionResponse {
3206
3494
  */
3207
3495
  export interface DescribeHostKeyRequest {
3208
3496
  /**
3497
+ * @public
3209
3498
  * <p>The identifier of the server that contains the host key that you want described.</p>
3210
3499
  */
3211
3500
  ServerId: string | undefined;
3212
3501
  /**
3502
+ * @public
3213
3503
  * <p>The identifier of the host key that you want described.</p>
3214
3504
  */
3215
3505
  HostKeyId: string | undefined;
@@ -3219,6 +3509,7 @@ export interface DescribeHostKeyRequest {
3219
3509
  */
3220
3510
  export interface DescribeHostKeyResponse {
3221
3511
  /**
3512
+ * @public
3222
3513
  * <p>Returns the details for the specified host key.</p>
3223
3514
  */
3224
3515
  HostKey: DescribedHostKey | undefined;
@@ -3228,6 +3519,7 @@ export interface DescribeHostKeyResponse {
3228
3519
  */
3229
3520
  export interface DescribeProfileRequest {
3230
3521
  /**
3522
+ * @public
3231
3523
  * <p>The identifier of the profile that you want described.</p>
3232
3524
  */
3233
3525
  ProfileId: string | undefined;
@@ -3237,6 +3529,7 @@ export interface DescribeProfileRequest {
3237
3529
  */
3238
3530
  export interface DescribeProfileResponse {
3239
3531
  /**
3532
+ * @public
3240
3533
  * <p>The details of the specified profile, returned as an object.</p>
3241
3534
  */
3242
3535
  Profile: DescribedProfile | undefined;
@@ -3246,6 +3539,7 @@ export interface DescribeProfileResponse {
3246
3539
  */
3247
3540
  export interface DescribeSecurityPolicyRequest {
3248
3541
  /**
3542
+ * @public
3249
3543
  * <p>Specifies the name of the security policy that is attached to the server.</p>
3250
3544
  */
3251
3545
  SecurityPolicyName: string | undefined;
@@ -3255,6 +3549,7 @@ export interface DescribeSecurityPolicyRequest {
3255
3549
  */
3256
3550
  export interface DescribeSecurityPolicyResponse {
3257
3551
  /**
3552
+ * @public
3258
3553
  * <p>An array containing the properties of the security policy.</p>
3259
3554
  */
3260
3555
  SecurityPolicy: DescribedSecurityPolicy | undefined;
@@ -3264,6 +3559,7 @@ export interface DescribeSecurityPolicyResponse {
3264
3559
  */
3265
3560
  export interface DescribeServerRequest {
3266
3561
  /**
3562
+ * @public
3267
3563
  * <p>A system-assigned unique identifier for a server.</p>
3268
3564
  */
3269
3565
  ServerId: string | undefined;
@@ -3273,6 +3569,7 @@ export interface DescribeServerRequest {
3273
3569
  */
3274
3570
  export interface DescribeServerResponse {
3275
3571
  /**
3572
+ * @public
3276
3573
  * <p>An array containing the properties of a server with the <code>ServerID</code> you
3277
3574
  * specified.</p>
3278
3575
  */
@@ -3283,10 +3580,12 @@ export interface DescribeServerResponse {
3283
3580
  */
3284
3581
  export interface DescribeUserRequest {
3285
3582
  /**
3583
+ * @public
3286
3584
  * <p>A system-assigned unique identifier for a server that has this user assigned.</p>
3287
3585
  */
3288
3586
  ServerId: string | undefined;
3289
3587
  /**
3588
+ * @public
3290
3589
  * <p>The name of the user assigned to one or more servers. User names are part of the sign-in
3291
3590
  * credentials to use the Transfer Family service and perform file transfer tasks.</p>
3292
3591
  */
@@ -3297,10 +3596,12 @@ export interface DescribeUserRequest {
3297
3596
  */
3298
3597
  export interface DescribeUserResponse {
3299
3598
  /**
3599
+ * @public
3300
3600
  * <p>A system-assigned unique identifier for a server that has this user assigned.</p>
3301
3601
  */
3302
3602
  ServerId: string | undefined;
3303
3603
  /**
3604
+ * @public
3304
3605
  * <p>An array containing the properties of the Transfer Family user for the <code>ServerID</code> value
3305
3606
  * that you specified.</p>
3306
3607
  */
@@ -3311,6 +3612,7 @@ export interface DescribeUserResponse {
3311
3612
  */
3312
3613
  export interface DescribeWorkflowRequest {
3313
3614
  /**
3615
+ * @public
3314
3616
  * <p>A unique identifier for the workflow.</p>
3315
3617
  */
3316
3618
  WorkflowId: string | undefined;
@@ -3320,6 +3622,7 @@ export interface DescribeWorkflowRequest {
3320
3622
  */
3321
3623
  export interface DescribeWorkflowResponse {
3322
3624
  /**
3625
+ * @public
3323
3626
  * <p>The structure that contains the details of the workflow.</p>
3324
3627
  */
3325
3628
  Workflow: DescribedWorkflow | undefined;
@@ -3329,10 +3632,12 @@ export interface DescribeWorkflowResponse {
3329
3632
  */
3330
3633
  export interface ImportCertificateRequest {
3331
3634
  /**
3635
+ * @public
3332
3636
  * <p>Specifies whether this certificate is used for signing or encryption.</p>
3333
3637
  */
3334
3638
  Usage: CertificateUsageType | string | undefined;
3335
3639
  /**
3640
+ * @public
3336
3641
  * <ul>
3337
3642
  * <li>
3338
3643
  * <p>For the CLI, provide a file path for a certificate in URI format. For example, <code>--certificate file://encryption-cert.pem</code>.
@@ -3345,11 +3650,13 @@ export interface ImportCertificateRequest {
3345
3650
  */
3346
3651
  Certificate: string | undefined;
3347
3652
  /**
3653
+ * @public
3348
3654
  * <p>An optional list of certificates that make up the chain for the certificate that's being
3349
3655
  * imported.</p>
3350
3656
  */
3351
3657
  CertificateChain?: string;
3352
3658
  /**
3659
+ * @public
3353
3660
  * <ul>
3354
3661
  * <li>
3355
3662
  * <p>For the CLI, provide a file path for a private key in URI format.For example, <code>--private-key file://encryption-key.pem</code>.
@@ -3363,18 +3670,22 @@ export interface ImportCertificateRequest {
3363
3670
  */
3364
3671
  PrivateKey?: string;
3365
3672
  /**
3673
+ * @public
3366
3674
  * <p>An optional date that specifies when the certificate becomes active.</p>
3367
3675
  */
3368
3676
  ActiveDate?: Date;
3369
3677
  /**
3678
+ * @public
3370
3679
  * <p>An optional date that specifies when the certificate becomes inactive.</p>
3371
3680
  */
3372
3681
  InactiveDate?: Date;
3373
3682
  /**
3683
+ * @public
3374
3684
  * <p>A short description that helps identify the certificate. </p>
3375
3685
  */
3376
3686
  Description?: string;
3377
3687
  /**
3688
+ * @public
3378
3689
  * <p>Key-value pairs that can be used to group and search for certificates.</p>
3379
3690
  */
3380
3691
  Tags?: Tag[];
@@ -3384,6 +3695,7 @@ export interface ImportCertificateRequest {
3384
3695
  */
3385
3696
  export interface ImportCertificateResponse {
3386
3697
  /**
3698
+ * @public
3387
3699
  * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
3388
3700
  */
3389
3701
  CertificateId: string | undefined;
@@ -3393,19 +3705,23 @@ export interface ImportCertificateResponse {
3393
3705
  */
3394
3706
  export interface ImportHostKeyRequest {
3395
3707
  /**
3708
+ * @public
3396
3709
  * <p>The identifier of the server that contains the host key that you are importing.</p>
3397
3710
  */
3398
3711
  ServerId: string | undefined;
3399
3712
  /**
3713
+ * @public
3400
3714
  * <p>The private key portion of an SSH key pair.</p>
3401
3715
  * <p>Transfer Family accepts RSA, ECDSA, and ED25519 keys.</p>
3402
3716
  */
3403
3717
  HostKeyBody: string | undefined;
3404
3718
  /**
3719
+ * @public
3405
3720
  * <p>The text description that identifies this host key.</p>
3406
3721
  */
3407
3722
  Description?: string;
3408
3723
  /**
3724
+ * @public
3409
3725
  * <p>Key-value pairs that can be used to group and search for host keys.</p>
3410
3726
  */
3411
3727
  Tags?: Tag[];
@@ -3415,10 +3731,12 @@ export interface ImportHostKeyRequest {
3415
3731
  */
3416
3732
  export interface ImportHostKeyResponse {
3417
3733
  /**
3734
+ * @public
3418
3735
  * <p>Returns the server identifier that contains the imported key.</p>
3419
3736
  */
3420
3737
  ServerId: string | undefined;
3421
3738
  /**
3739
+ * @public
3422
3740
  * <p>Returns the host key identifier for the imported key.</p>
3423
3741
  */
3424
3742
  HostKeyId: string | undefined;
@@ -3428,15 +3746,18 @@ export interface ImportHostKeyResponse {
3428
3746
  */
3429
3747
  export interface ImportSshPublicKeyRequest {
3430
3748
  /**
3749
+ * @public
3431
3750
  * <p>A system-assigned unique identifier for a server.</p>
3432
3751
  */
3433
3752
  ServerId: string | undefined;
3434
3753
  /**
3754
+ * @public
3435
3755
  * <p>The public key portion of an SSH key pair.</p>
3436
3756
  * <p>Transfer Family accepts RSA, ECDSA, and ED25519 keys.</p>
3437
3757
  */
3438
3758
  SshPublicKeyBody: string | undefined;
3439
3759
  /**
3760
+ * @public
3440
3761
  * <p>The name of the Transfer Family user that is assigned to one or more servers.</p>
3441
3762
  */
3442
3763
  UserName: string | undefined;
@@ -3449,14 +3770,17 @@ export interface ImportSshPublicKeyRequest {
3449
3770
  */
3450
3771
  export interface ImportSshPublicKeyResponse {
3451
3772
  /**
3773
+ * @public
3452
3774
  * <p>A system-assigned unique identifier for a server.</p>
3453
3775
  */
3454
3776
  ServerId: string | undefined;
3455
3777
  /**
3778
+ * @public
3456
3779
  * <p>The name given to a public key by the system that was imported.</p>
3457
3780
  */
3458
3781
  SshPublicKeyId: string | undefined;
3459
3782
  /**
3783
+ * @public
3460
3784
  * <p>A user name assigned to the <code>ServerID</code> value that you specified.</p>
3461
3785
  */
3462
3786
  UserName: string | undefined;
@@ -3479,10 +3803,12 @@ export declare class InvalidNextTokenException extends __BaseException {
3479
3803
  */
3480
3804
  export interface ListAccessesRequest {
3481
3805
  /**
3806
+ * @public
3482
3807
  * <p>Specifies the maximum number of access SIDs to return.</p>
3483
3808
  */
3484
3809
  MaxResults?: number;
3485
3810
  /**
3811
+ * @public
3486
3812
  * <p>When you can get additional results from the <code>ListAccesses</code> call, a
3487
3813
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
3488
3814
  * subsequent command to the <code>NextToken</code> parameter to continue listing additional
@@ -3490,6 +3816,7 @@ export interface ListAccessesRequest {
3490
3816
  */
3491
3817
  NextToken?: string;
3492
3818
  /**
3819
+ * @public
3493
3820
  * <p>A system-assigned unique identifier for a server that has users assigned to it.</p>
3494
3821
  */
3495
3822
  ServerId: string | undefined;
@@ -3500,11 +3827,13 @@ export interface ListAccessesRequest {
3500
3827
  */
3501
3828
  export interface ListedAccess {
3502
3829
  /**
3830
+ * @public
3503
3831
  * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
3504
3832
  * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
3505
3833
  */
3506
3834
  HomeDirectory?: string;
3507
3835
  /**
3836
+ * @public
3508
3837
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
3509
3838
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer
3510
3839
  * protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
@@ -3512,6 +3841,7 @@ export interface ListedAccess {
3512
3841
  */
3513
3842
  HomeDirectoryType?: HomeDirectoryType | string;
3514
3843
  /**
3844
+ * @public
3515
3845
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
3516
3846
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
3517
3847
  * when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
@@ -3519,6 +3849,7 @@ export interface ListedAccess {
3519
3849
  */
3520
3850
  Role?: string;
3521
3851
  /**
3852
+ * @public
3522
3853
  * <p>A unique identifier that is required to identify specific groups within your directory.
3523
3854
  * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
3524
3855
  * resources over the enabled protocols using Transfer Family. If you know the group name,
@@ -3537,6 +3868,7 @@ export interface ListedAccess {
3537
3868
  */
3538
3869
  export interface ListAccessesResponse {
3539
3870
  /**
3871
+ * @public
3540
3872
  * <p>When you can get additional results from the <code>ListAccesses</code> call, a
3541
3873
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
3542
3874
  * subsequent command to the <code>NextToken</code> parameter to continue listing additional
@@ -3544,10 +3876,12 @@ export interface ListAccessesResponse {
3544
3876
  */
3545
3877
  NextToken?: string;
3546
3878
  /**
3879
+ * @public
3547
3880
  * <p>A system-assigned unique identifier for a server that has users assigned to it.</p>
3548
3881
  */
3549
3882
  ServerId: string | undefined;
3550
3883
  /**
3884
+ * @public
3551
3885
  * <p>Returns the accesses and their properties for the <code>ServerId</code> value that you
3552
3886
  * specify.</p>
3553
3887
  */
@@ -3558,10 +3892,12 @@ export interface ListAccessesResponse {
3558
3892
  */
3559
3893
  export interface ListAgreementsRequest {
3560
3894
  /**
3895
+ * @public
3561
3896
  * <p>The maximum number of agreements to return.</p>
3562
3897
  */
3563
3898
  MaxResults?: number;
3564
3899
  /**
3900
+ * @public
3565
3901
  * <p>When you can get additional results from the <code>ListAgreements</code> call, a
3566
3902
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
3567
3903
  * subsequent command to the <code>NextToken</code> parameter to continue listing additional
@@ -3569,6 +3905,7 @@ export interface ListAgreementsRequest {
3569
3905
  */
3570
3906
  NextToken?: string;
3571
3907
  /**
3908
+ * @public
3572
3909
  * <p>The identifier of the server for which you want a list of agreements.</p>
3573
3910
  */
3574
3911
  ServerId: string | undefined;
@@ -3579,31 +3916,38 @@ export interface ListAgreementsRequest {
3579
3916
  */
3580
3917
  export interface ListedAgreement {
3581
3918
  /**
3919
+ * @public
3582
3920
  * <p>The Amazon Resource Name (ARN) of the specified agreement.</p>
3583
3921
  */
3584
3922
  Arn?: string;
3585
3923
  /**
3924
+ * @public
3586
3925
  * <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
3587
3926
  */
3588
3927
  AgreementId?: string;
3589
3928
  /**
3929
+ * @public
3590
3930
  * <p>The current description for the agreement. You can change it by calling the
3591
3931
  * <code>UpdateAgreement</code> operation and providing a new description. </p>
3592
3932
  */
3593
3933
  Description?: string;
3594
3934
  /**
3935
+ * @public
3595
3936
  * <p>The agreement can be either <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
3596
3937
  */
3597
3938
  Status?: AgreementStatusType | string;
3598
3939
  /**
3940
+ * @public
3599
3941
  * <p>The unique identifier for the agreement.</p>
3600
3942
  */
3601
3943
  ServerId?: string;
3602
3944
  /**
3945
+ * @public
3603
3946
  * <p>A unique identifier for the AS2 local profile.</p>
3604
3947
  */
3605
3948
  LocalProfileId?: string;
3606
3949
  /**
3950
+ * @public
3607
3951
  * <p>A unique identifier for the partner profile.</p>
3608
3952
  */
3609
3953
  PartnerProfileId?: string;
@@ -3613,11 +3957,13 @@ export interface ListedAgreement {
3613
3957
  */
3614
3958
  export interface ListAgreementsResponse {
3615
3959
  /**
3960
+ * @public
3616
3961
  * <p>Returns a token that you can use to call <code>ListAgreements</code> again and receive
3617
3962
  * additional results, if there are any.</p>
3618
3963
  */
3619
3964
  NextToken?: string;
3620
3965
  /**
3966
+ * @public
3621
3967
  * <p>Returns an array, where each item contains the details of an agreement.</p>
3622
3968
  */
3623
3969
  Agreements: ListedAgreement[] | undefined;
@@ -3627,10 +3973,12 @@ export interface ListAgreementsResponse {
3627
3973
  */
3628
3974
  export interface ListCertificatesRequest {
3629
3975
  /**
3976
+ * @public
3630
3977
  * <p>The maximum number of certificates to return.</p>
3631
3978
  */
3632
3979
  MaxResults?: number;
3633
3980
  /**
3981
+ * @public
3634
3982
  * <p>When you can get additional results from the <code>ListCertificates</code> call, a
3635
3983
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
3636
3984
  * subsequent command to the <code>NextToken</code> parameter to continue listing additional
@@ -3644,38 +3992,46 @@ export interface ListCertificatesRequest {
3644
3992
  */
3645
3993
  export interface ListedCertificate {
3646
3994
  /**
3995
+ * @public
3647
3996
  * <p>The Amazon Resource Name (ARN) of the specified certificate.</p>
3648
3997
  */
3649
3998
  Arn?: string;
3650
3999
  /**
4000
+ * @public
3651
4001
  * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
3652
4002
  */
3653
4003
  CertificateId?: string;
3654
4004
  /**
4005
+ * @public
3655
4006
  * <p>Specifies whether this certificate is used for signing or encryption.</p>
3656
4007
  */
3657
4008
  Usage?: CertificateUsageType | string;
3658
4009
  /**
4010
+ * @public
3659
4011
  * <p>The certificate can be either <code>ACTIVE</code>, <code>PENDING_ROTATION</code>, or
3660
4012
  * <code>INACTIVE</code>. <code>PENDING_ROTATION</code> means that this certificate will
3661
4013
  * replace the current certificate when it expires.</p>
3662
4014
  */
3663
4015
  Status?: CertificateStatusType | string;
3664
4016
  /**
4017
+ * @public
3665
4018
  * <p>An optional date that specifies when the certificate becomes active.</p>
3666
4019
  */
3667
4020
  ActiveDate?: Date;
3668
4021
  /**
4022
+ * @public
3669
4023
  * <p>An optional date that specifies when the certificate becomes inactive.</p>
3670
4024
  */
3671
4025
  InactiveDate?: Date;
3672
4026
  /**
4027
+ * @public
3673
4028
  * <p>The type for the certificate. If a private key has been specified for the certificate, its
3674
4029
  * type is <code>CERTIFICATE_WITH_PRIVATE_KEY</code>. If there is no private key, the type is
3675
4030
  * <code>CERTIFICATE</code>.</p>
3676
4031
  */
3677
4032
  Type?: CertificateType | string;
3678
4033
  /**
4034
+ * @public
3679
4035
  * <p>The name or short description that's used to identify the certificate.</p>
3680
4036
  */
3681
4037
  Description?: string;
@@ -3685,10 +4041,12 @@ export interface ListedCertificate {
3685
4041
  */
3686
4042
  export interface ListCertificatesResponse {
3687
4043
  /**
4044
+ * @public
3688
4045
  * <p>Returns the next token, which you can use to list the next certificate.</p>
3689
4046
  */
3690
4047
  NextToken?: string;
3691
4048
  /**
4049
+ * @public
3692
4050
  * <p>Returns an array of the certificates that are specified in the
3693
4051
  * <code>ListCertificates</code> call.</p>
3694
4052
  */
@@ -3699,10 +4057,12 @@ export interface ListCertificatesResponse {
3699
4057
  */
3700
4058
  export interface ListConnectorsRequest {
3701
4059
  /**
4060
+ * @public
3702
4061
  * <p>The maximum number of connectors to return.</p>
3703
4062
  */
3704
4063
  MaxResults?: number;
3705
4064
  /**
4065
+ * @public
3706
4066
  * <p>When you can get additional results from the <code>ListConnectors</code> call, a
3707
4067
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
3708
4068
  * subsequent command to the <code>NextToken</code> parameter to continue listing additional
@@ -3716,14 +4076,17 @@ export interface ListConnectorsRequest {
3716
4076
  */
3717
4077
  export interface ListedConnector {
3718
4078
  /**
4079
+ * @public
3719
4080
  * <p>The Amazon Resource Name (ARN) of the specified connector.</p>
3720
4081
  */
3721
4082
  Arn?: string;
3722
4083
  /**
4084
+ * @public
3723
4085
  * <p>The unique identifier for the connector.</p>
3724
4086
  */
3725
4087
  ConnectorId?: string;
3726
4088
  /**
4089
+ * @public
3727
4090
  * <p>The URL of the partner's AS2 or SFTP endpoint.</p>
3728
4091
  */
3729
4092
  Url?: string;
@@ -3733,11 +4096,13 @@ export interface ListedConnector {
3733
4096
  */
3734
4097
  export interface ListConnectorsResponse {
3735
4098
  /**
4099
+ * @public
3736
4100
  * <p>Returns a token that you can use to call <code>ListConnectors</code> again and receive
3737
4101
  * additional results, if there are any.</p>
3738
4102
  */
3739
4103
  NextToken?: string;
3740
4104
  /**
4105
+ * @public
3741
4106
  * <p>Returns an array, where each item contains the details of a connector.</p>
3742
4107
  */
3743
4108
  Connectors: ListedConnector[] | undefined;
@@ -3748,20 +4113,24 @@ export interface ListConnectorsResponse {
3748
4113
  */
3749
4114
  export interface ListedExecution {
3750
4115
  /**
4116
+ * @public
3751
4117
  * <p>A unique identifier for the execution of a workflow.</p>
3752
4118
  */
3753
4119
  ExecutionId?: string;
3754
4120
  /**
4121
+ * @public
3755
4122
  * <p>A structure that describes the Amazon S3 or EFS file location.
3756
4123
  * This is the file location when the execution begins: if the file is being copied,
3757
4124
  * this is the initial (as opposed to destination) file location.</p>
3758
4125
  */
3759
4126
  InitialFileLocation?: FileLocation;
3760
4127
  /**
4128
+ * @public
3761
4129
  * <p>A container object for the session details that are associated with a workflow.</p>
3762
4130
  */
3763
4131
  ServiceMetadata?: ServiceMetadata;
3764
4132
  /**
4133
+ * @public
3765
4134
  * <p>The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.</p>
3766
4135
  */
3767
4136
  Status?: ExecutionStatus | string;
@@ -3772,22 +4141,27 @@ export interface ListedExecution {
3772
4141
  */
3773
4142
  export interface ListedHostKey {
3774
4143
  /**
4144
+ * @public
3775
4145
  * <p>The unique Amazon Resource Name (ARN) of the host key.</p>
3776
4146
  */
3777
4147
  Arn: string | undefined;
3778
4148
  /**
4149
+ * @public
3779
4150
  * <p>A unique identifier for the host key.</p>
3780
4151
  */
3781
4152
  HostKeyId?: string;
3782
4153
  /**
4154
+ * @public
3783
4155
  * <p>The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.</p>
3784
4156
  */
3785
4157
  Fingerprint?: string;
3786
4158
  /**
4159
+ * @public
3787
4160
  * <p>The current description for the host key. You can change it by calling the <code>UpdateHostKey</code> operation and providing a new description.</p>
3788
4161
  */
3789
4162
  Description?: string;
3790
4163
  /**
4164
+ * @public
3791
4165
  * <p>The encryption algorithm that is used for the host key. The <code>Type</code> parameter is specified by using one of the
3792
4166
  * following values:</p>
3793
4167
  * <ul>
@@ -3820,6 +4194,7 @@ export interface ListedHostKey {
3820
4194
  */
3821
4195
  Type?: string;
3822
4196
  /**
4197
+ * @public
3823
4198
  * <p>The date on which the host key was added to the server.</p>
3824
4199
  */
3825
4200
  DateImported?: Date;
@@ -3830,14 +4205,17 @@ export interface ListedHostKey {
3830
4205
  */
3831
4206
  export interface ListedProfile {
3832
4207
  /**
4208
+ * @public
3833
4209
  * <p>The Amazon Resource Name (ARN) of the specified profile.</p>
3834
4210
  */
3835
4211
  Arn?: string;
3836
4212
  /**
4213
+ * @public
3837
4214
  * <p>A unique identifier for the local or partner AS2 profile.</p>
3838
4215
  */
3839
4216
  ProfileId?: string;
3840
4217
  /**
4218
+ * @public
3841
4219
  * <p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the
3842
4220
  * <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages
3843
4221
  * sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the
@@ -3845,6 +4223,7 @@ export interface ListedProfile {
3845
4223
  */
3846
4224
  As2Id?: string;
3847
4225
  /**
4226
+ * @public
3848
4227
  * <p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles.
3849
4228
  * If not supplied in the request, the command lists all types of profiles.</p>
3850
4229
  */
@@ -3856,14 +4235,17 @@ export interface ListedProfile {
3856
4235
  */
3857
4236
  export interface ListedServer {
3858
4237
  /**
4238
+ * @public
3859
4239
  * <p>Specifies the unique Amazon Resource Name (ARN) for a server to be listed.</p>
3860
4240
  */
3861
4241
  Arn: string | undefined;
3862
4242
  /**
4243
+ * @public
3863
4244
  * <p>Specifies the domain of the storage system that is used for file transfers.</p>
3864
4245
  */
3865
4246
  Domain?: Domain | string;
3866
4247
  /**
4248
+ * @public
3867
4249
  * <p>The mode of authentication for a server. The default value is
3868
4250
  * <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
3869
4251
  * the Transfer Family service.</p>
@@ -3880,21 +4262,25 @@ export interface ListedServer {
3880
4262
  */
3881
4263
  IdentityProviderType?: IdentityProviderType | string;
3882
4264
  /**
4265
+ * @public
3883
4266
  * <p>Specifies the type of VPC endpoint that your server is connected to. If your server is
3884
4267
  * connected to a VPC endpoint, your server isn't accessible over the public internet.</p>
3885
4268
  */
3886
4269
  EndpointType?: EndpointType | string;
3887
4270
  /**
4271
+ * @public
3888
4272
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
3889
4273
  * on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
3890
4274
  * your CloudWatch logs.</p>
3891
4275
  */
3892
4276
  LoggingRole?: string;
3893
4277
  /**
4278
+ * @public
3894
4279
  * <p>Specifies the unique system assigned identifier for the servers that were listed.</p>
3895
4280
  */
3896
4281
  ServerId?: string;
3897
4282
  /**
4283
+ * @public
3898
4284
  * <p>The condition of the server that was described. A value of
3899
4285
  * <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A
3900
4286
  * <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file
@@ -3906,6 +4292,7 @@ export interface ListedServer {
3906
4292
  */
3907
4293
  State?: State | string;
3908
4294
  /**
4295
+ * @public
3909
4296
  * <p>Specifies the number of users that are assigned to a server you specified with the
3910
4297
  * <code>ServerId</code>.</p>
3911
4298
  */
@@ -3917,16 +4304,19 @@ export interface ListedServer {
3917
4304
  */
3918
4305
  export interface ListedUser {
3919
4306
  /**
4307
+ * @public
3920
4308
  * <p>Provides the unique Amazon Resource Name (ARN) for the user that you want to learn
3921
4309
  * about.</p>
3922
4310
  */
3923
4311
  Arn: string | undefined;
3924
4312
  /**
4313
+ * @public
3925
4314
  * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
3926
4315
  * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
3927
4316
  */
3928
4317
  HomeDirectory?: string;
3929
4318
  /**
4319
+ * @public
3930
4320
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
3931
4321
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer
3932
4322
  * protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
@@ -3934,6 +4324,7 @@ export interface ListedUser {
3934
4324
  */
3935
4325
  HomeDirectoryType?: HomeDirectoryType | string;
3936
4326
  /**
4327
+ * @public
3937
4328
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
3938
4329
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
3939
4330
  * when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
@@ -3947,10 +4338,12 @@ export interface ListedUser {
3947
4338
  */
3948
4339
  Role?: string;
3949
4340
  /**
4341
+ * @public
3950
4342
  * <p>Specifies the number of SSH public keys stored for the user you specified.</p>
3951
4343
  */
3952
4344
  SshPublicKeyCount?: number;
3953
4345
  /**
4346
+ * @public
3954
4347
  * <p>Specifies the name of the user whose ARN was specified. User names are used for
3955
4348
  * authentication purposes.</p>
3956
4349
  */
@@ -3963,14 +4356,17 @@ export interface ListedUser {
3963
4356
  */
3964
4357
  export interface ListedWorkflow {
3965
4358
  /**
4359
+ * @public
3966
4360
  * <p>A unique identifier for the workflow.</p>
3967
4361
  */
3968
4362
  WorkflowId?: string;
3969
4363
  /**
4364
+ * @public
3970
4365
  * <p>Specifies the text description for the workflow.</p>
3971
4366
  */
3972
4367
  Description?: string;
3973
4368
  /**
4369
+ * @public
3974
4370
  * <p>Specifies the unique Amazon Resource Name (ARN) for the workflow.</p>
3975
4371
  */
3976
4372
  Arn?: string;
@@ -3980,10 +4376,12 @@ export interface ListedWorkflow {
3980
4376
  */
3981
4377
  export interface ListExecutionsRequest {
3982
4378
  /**
4379
+ * @public
3983
4380
  * <p>Specifies the maximum number of executions to return.</p>
3984
4381
  */
3985
4382
  MaxResults?: number;
3986
4383
  /**
4384
+ * @public
3987
4385
  * <p>
3988
4386
  * <code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output.
3989
4387
  * You can then pass the <code>NextToken</code> parameter in a subsequent command to
@@ -4009,6 +4407,7 @@ export interface ListExecutionsRequest {
4009
4407
  */
4010
4408
  NextToken?: string;
4011
4409
  /**
4410
+ * @public
4012
4411
  * <p>A unique identifier for the workflow.</p>
4013
4412
  */
4014
4413
  WorkflowId: string | undefined;
@@ -4018,6 +4417,7 @@ export interface ListExecutionsRequest {
4018
4417
  */
4019
4418
  export interface ListExecutionsResponse {
4020
4419
  /**
4420
+ * @public
4021
4421
  * <p>
4022
4422
  * <code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output.
4023
4423
  * You can then pass the <code>NextToken</code> parameter in a subsequent command to
@@ -4025,10 +4425,12 @@ export interface ListExecutionsResponse {
4025
4425
  */
4026
4426
  NextToken?: string;
4027
4427
  /**
4428
+ * @public
4028
4429
  * <p>A unique identifier for the workflow.</p>
4029
4430
  */
4030
4431
  WorkflowId: string | undefined;
4031
4432
  /**
4433
+ * @public
4032
4434
  * <p>Returns the details for each execution, in a <code>ListedExecution</code> array.</p>
4033
4435
  */
4034
4436
  Executions: ListedExecution[] | undefined;
@@ -4038,16 +4440,19 @@ export interface ListExecutionsResponse {
4038
4440
  */
4039
4441
  export interface ListHostKeysRequest {
4040
4442
  /**
4443
+ * @public
4041
4444
  * <p>The maximum number of host keys to return.</p>
4042
4445
  */
4043
4446
  MaxResults?: number;
4044
4447
  /**
4448
+ * @public
4045
4449
  * <p>When there are additional results that were not returned, a <code>NextToken</code>
4046
4450
  * parameter is returned. You can use that value for a subsequent call to
4047
4451
  * <code>ListHostKeys</code> to continue listing results.</p>
4048
4452
  */
4049
4453
  NextToken?: string;
4050
4454
  /**
4455
+ * @public
4051
4456
  * <p>The identifier of the server that contains the host keys that you want to view.</p>
4052
4457
  */
4053
4458
  ServerId: string | undefined;
@@ -4057,15 +4462,18 @@ export interface ListHostKeysRequest {
4057
4462
  */
4058
4463
  export interface ListHostKeysResponse {
4059
4464
  /**
4465
+ * @public
4060
4466
  * <p>Returns a token that you can use to call <code>ListHostKeys</code> again and receive
4061
4467
  * additional results, if there are any.</p>
4062
4468
  */
4063
4469
  NextToken?: string;
4064
4470
  /**
4471
+ * @public
4065
4472
  * <p>Returns the server identifier that contains the listed host keys.</p>
4066
4473
  */
4067
4474
  ServerId: string | undefined;
4068
4475
  /**
4476
+ * @public
4069
4477
  * <p>Returns an array, where each item contains the details of a host key.</p>
4070
4478
  */
4071
4479
  HostKeys: ListedHostKey[] | undefined;
@@ -4075,16 +4483,19 @@ export interface ListHostKeysResponse {
4075
4483
  */
4076
4484
  export interface ListProfilesRequest {
4077
4485
  /**
4486
+ * @public
4078
4487
  * <p>The maximum number of profiles to return.</p>
4079
4488
  */
4080
4489
  MaxResults?: number;
4081
4490
  /**
4491
+ * @public
4082
4492
  * <p>When there are additional results that were not returned, a <code>NextToken</code>
4083
4493
  * parameter is returned. You can use that value for a subsequent call to
4084
4494
  * <code>ListProfiles</code> to continue listing results.</p>
4085
4495
  */
4086
4496
  NextToken?: string;
4087
4497
  /**
4498
+ * @public
4088
4499
  * <p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles.
4089
4500
  * If not supplied in the request, the command lists all types of profiles.</p>
4090
4501
  */
@@ -4095,11 +4506,13 @@ export interface ListProfilesRequest {
4095
4506
  */
4096
4507
  export interface ListProfilesResponse {
4097
4508
  /**
4509
+ * @public
4098
4510
  * <p>Returns a token that you can use to call <code>ListProfiles</code> again and receive
4099
4511
  * additional results, if there are any.</p>
4100
4512
  */
4101
4513
  NextToken?: string;
4102
4514
  /**
4515
+ * @public
4103
4516
  * <p>Returns an array, where each item contains the details of a profile.</p>
4104
4517
  */
4105
4518
  Profiles: ListedProfile[] | undefined;
@@ -4109,11 +4522,13 @@ export interface ListProfilesResponse {
4109
4522
  */
4110
4523
  export interface ListSecurityPoliciesRequest {
4111
4524
  /**
4525
+ * @public
4112
4526
  * <p>Specifies the number of security policies to return as a response to the
4113
4527
  * <code>ListSecurityPolicies</code> query.</p>
4114
4528
  */
4115
4529
  MaxResults?: number;
4116
4530
  /**
4531
+ * @public
4117
4532
  * <p>When additional results are obtained from the <code>ListSecurityPolicies</code> command, a
4118
4533
  * <code>NextToken</code> parameter is returned in the output. You can then pass the
4119
4534
  * <code>NextToken</code> parameter in a subsequent command to continue listing additional
@@ -4126,12 +4541,14 @@ export interface ListSecurityPoliciesRequest {
4126
4541
  */
4127
4542
  export interface ListSecurityPoliciesResponse {
4128
4543
  /**
4544
+ * @public
4129
4545
  * <p>When you can get additional results from the <code>ListSecurityPolicies</code> operation,
4130
4546
  * a <code>NextToken</code> parameter is returned in the output. In a following command, you can
4131
4547
  * pass in the <code>NextToken</code> parameter to continue listing security policies.</p>
4132
4548
  */
4133
4549
  NextToken?: string;
4134
4550
  /**
4551
+ * @public
4135
4552
  * <p>An array of security policies that were listed.</p>
4136
4553
  */
4137
4554
  SecurityPolicyNames: string[] | undefined;
@@ -4141,11 +4558,13 @@ export interface ListSecurityPoliciesResponse {
4141
4558
  */
4142
4559
  export interface ListServersRequest {
4143
4560
  /**
4561
+ * @public
4144
4562
  * <p>Specifies the number of servers to return as a response to the <code>ListServers</code>
4145
4563
  * query.</p>
4146
4564
  */
4147
4565
  MaxResults?: number;
4148
4566
  /**
4567
+ * @public
4149
4568
  * <p>When additional results are obtained from the <code>ListServers</code> command, a
4150
4569
  * <code>NextToken</code> parameter is returned in the output. You can then pass the
4151
4570
  * <code>NextToken</code> parameter in a subsequent command to continue listing additional
@@ -4158,12 +4577,14 @@ export interface ListServersRequest {
4158
4577
  */
4159
4578
  export interface ListServersResponse {
4160
4579
  /**
4580
+ * @public
4161
4581
  * <p>When you can get additional results from the <code>ListServers</code> operation, a
4162
4582
  * <code>NextToken</code> parameter is returned in the output. In a following command, you can
4163
4583
  * pass in the <code>NextToken</code> parameter to continue listing additional servers.</p>
4164
4584
  */
4165
4585
  NextToken?: string;
4166
4586
  /**
4587
+ * @public
4167
4588
  * <p>An array of servers that were listed.</p>
4168
4589
  */
4169
4590
  Servers: ListedServer[] | undefined;
@@ -4173,16 +4594,19 @@ export interface ListServersResponse {
4173
4594
  */
4174
4595
  export interface ListTagsForResourceRequest {
4175
4596
  /**
4597
+ * @public
4176
4598
  * <p>Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an
4177
4599
  * identifier for a specific Amazon Web Services resource, such as a server, user, or role.</p>
4178
4600
  */
4179
4601
  Arn: string | undefined;
4180
4602
  /**
4603
+ * @public
4181
4604
  * <p>Specifies the number of tags to return as a response to the
4182
4605
  * <code>ListTagsForResource</code> request.</p>
4183
4606
  */
4184
4607
  MaxResults?: number;
4185
4608
  /**
4609
+ * @public
4186
4610
  * <p>When you request additional results from the <code>ListTagsForResource</code> operation, a
4187
4611
  * <code>NextToken</code> parameter is returned in the input. You can then pass in a subsequent
4188
4612
  * command to the <code>NextToken</code> parameter to continue listing additional tags.</p>
@@ -4194,10 +4618,12 @@ export interface ListTagsForResourceRequest {
4194
4618
  */
4195
4619
  export interface ListTagsForResourceResponse {
4196
4620
  /**
4621
+ * @public
4197
4622
  * <p>The ARN you specified to list the tags of.</p>
4198
4623
  */
4199
4624
  Arn?: string;
4200
4625
  /**
4626
+ * @public
4201
4627
  * <p>When you can get additional results from the <code>ListTagsForResource</code> call, a
4202
4628
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
4203
4629
  * subsequent command to the <code>NextToken</code> parameter to continue listing additional
@@ -4205,6 +4631,7 @@ export interface ListTagsForResourceResponse {
4205
4631
  */
4206
4632
  NextToken?: string;
4207
4633
  /**
4634
+ * @public
4208
4635
  * <p>Key-value pairs that are assigned to a resource, usually for the purpose of grouping and
4209
4636
  * searching for items. Tags are metadata that you define.</p>
4210
4637
  */
@@ -4215,11 +4642,13 @@ export interface ListTagsForResourceResponse {
4215
4642
  */
4216
4643
  export interface ListUsersRequest {
4217
4644
  /**
4645
+ * @public
4218
4646
  * <p>Specifies the number of users to return as a response to the <code>ListUsers</code>
4219
4647
  * request.</p>
4220
4648
  */
4221
4649
  MaxResults?: number;
4222
4650
  /**
4651
+ * @public
4223
4652
  * <p>When you can get additional results from the <code>ListUsers</code> call, a
4224
4653
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
4225
4654
  * subsequent command to the <code>NextToken</code> parameter to continue listing additional
@@ -4227,6 +4656,7 @@ export interface ListUsersRequest {
4227
4656
  */
4228
4657
  NextToken?: string;
4229
4658
  /**
4659
+ * @public
4230
4660
  * <p>A system-assigned unique identifier for a server that has users assigned to it.</p>
4231
4661
  */
4232
4662
  ServerId: string | undefined;
@@ -4236,6 +4666,7 @@ export interface ListUsersRequest {
4236
4666
  */
4237
4667
  export interface ListUsersResponse {
4238
4668
  /**
4669
+ * @public
4239
4670
  * <p>When you can get additional results from the <code>ListUsers</code> call, a
4240
4671
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
4241
4672
  * subsequent command to the <code>NextToken</code> parameter to continue listing additional
@@ -4243,10 +4674,12 @@ export interface ListUsersResponse {
4243
4674
  */
4244
4675
  NextToken?: string;
4245
4676
  /**
4677
+ * @public
4246
4678
  * <p>A system-assigned unique identifier for a server that the users are assigned to.</p>
4247
4679
  */
4248
4680
  ServerId: string | undefined;
4249
4681
  /**
4682
+ * @public
4250
4683
  * <p>Returns the Transfer Family users and their properties for the <code>ServerId</code> value that
4251
4684
  * you specify.</p>
4252
4685
  */
@@ -4257,10 +4690,12 @@ export interface ListUsersResponse {
4257
4690
  */
4258
4691
  export interface ListWorkflowsRequest {
4259
4692
  /**
4693
+ * @public
4260
4694
  * <p>Specifies the maximum number of workflows to return.</p>
4261
4695
  */
4262
4696
  MaxResults?: number;
4263
4697
  /**
4698
+ * @public
4264
4699
  * <p>
4265
4700
  * <code>ListWorkflows</code> returns the <code>NextToken</code> parameter in the output.
4266
4701
  * You can then pass the <code>NextToken</code> parameter in a subsequent command to
@@ -4273,6 +4708,7 @@ export interface ListWorkflowsRequest {
4273
4708
  */
4274
4709
  export interface ListWorkflowsResponse {
4275
4710
  /**
4711
+ * @public
4276
4712
  * <p>
4277
4713
  * <code>ListWorkflows</code> returns the <code>NextToken</code> parameter in the output.
4278
4714
  * You can then pass the <code>NextToken</code> parameter in a subsequent command to
@@ -4280,6 +4716,7 @@ export interface ListWorkflowsResponse {
4280
4716
  */
4281
4717
  NextToken?: string;
4282
4718
  /**
4719
+ * @public
4283
4720
  * <p>Returns the <code>Arn</code>, <code>WorkflowId</code>, and <code>Description</code> for each workflow.</p>
4284
4721
  */
4285
4722
  Workflows: ListedWorkflow[] | undefined;
@@ -4289,18 +4726,22 @@ export interface ListWorkflowsResponse {
4289
4726
  */
4290
4727
  export interface SendWorkflowStepStateRequest {
4291
4728
  /**
4729
+ * @public
4292
4730
  * <p>A unique identifier for the workflow.</p>
4293
4731
  */
4294
4732
  WorkflowId: string | undefined;
4295
4733
  /**
4734
+ * @public
4296
4735
  * <p>A unique identifier for the execution of a workflow.</p>
4297
4736
  */
4298
4737
  ExecutionId: string | undefined;
4299
4738
  /**
4739
+ * @public
4300
4740
  * <p>Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.</p>
4301
4741
  */
4302
4742
  Token: string | undefined;
4303
4743
  /**
4744
+ * @public
4304
4745
  * <p>Indicates whether the specified step succeeded or failed.</p>
4305
4746
  */
4306
4747
  Status: CustomStepStatus | string | undefined;
@@ -4315,10 +4756,12 @@ export interface SendWorkflowStepStateResponse {
4315
4756
  */
4316
4757
  export interface StartFileTransferRequest {
4317
4758
  /**
4759
+ * @public
4318
4760
  * <p>The unique identifier for the connector.</p>
4319
4761
  */
4320
4762
  ConnectorId: string | undefined;
4321
4763
  /**
4764
+ * @public
4322
4765
  * <p>One or more source paths for the Transfer Family server. Each string represents a source file path for one outbound file transfer. For example,
4323
4766
  * <code>
4324
4767
  * <i>DOC-EXAMPLE-BUCKET</i>/<i>myfile.txt</i>
@@ -4326,15 +4769,18 @@ export interface StartFileTransferRequest {
4326
4769
  */
4327
4770
  SendFilePaths?: string[];
4328
4771
  /**
4772
+ * @public
4329
4773
  * <p>One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.</p>
4330
4774
  */
4331
4775
  RetrieveFilePaths?: string[];
4332
4776
  /**
4777
+ * @public
4333
4778
  * <p>For an inbound transfer, the <code>LocaDirectoryPath</code> specifies the destination for one or more files
4334
4779
  * that are transferred from the partner's SFTP server.</p>
4335
4780
  */
4336
4781
  LocalDirectoryPath?: string;
4337
4782
  /**
4783
+ * @public
4338
4784
  * <p>For an outbound transfer, the <code>RemoteDirectoryPath</code> specifies the destination
4339
4785
  * for one or more files that are transferred to the partner's SFTP server. If you don't specify
4340
4786
  * a <code>RemoteDirectoryPath</code>, the destination for transferred files is the SFTP user's
@@ -4347,6 +4793,7 @@ export interface StartFileTransferRequest {
4347
4793
  */
4348
4794
  export interface StartFileTransferResponse {
4349
4795
  /**
4796
+ * @public
4350
4797
  * <p>Returns the unique identifier for the file transfer.</p>
4351
4798
  */
4352
4799
  TransferId: string | undefined;
@@ -4356,6 +4803,7 @@ export interface StartFileTransferResponse {
4356
4803
  */
4357
4804
  export interface StartServerRequest {
4358
4805
  /**
4806
+ * @public
4359
4807
  * <p>A system-assigned unique identifier for a server that you start.</p>
4360
4808
  */
4361
4809
  ServerId: string | undefined;
@@ -4365,6 +4813,7 @@ export interface StartServerRequest {
4365
4813
  */
4366
4814
  export interface StopServerRequest {
4367
4815
  /**
4816
+ * @public
4368
4817
  * <p>A system-assigned unique identifier for a server that you stopped.</p>
4369
4818
  */
4370
4819
  ServerId: string | undefined;
@@ -4374,11 +4823,13 @@ export interface StopServerRequest {
4374
4823
  */
4375
4824
  export interface TagResourceRequest {
4376
4825
  /**
4826
+ * @public
4377
4827
  * <p>An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or
4378
4828
  * role.</p>
4379
4829
  */
4380
4830
  Arn: string | undefined;
4381
4831
  /**
4832
+ * @public
4382
4833
  * <p>Key-value pairs assigned to ARNs that you can use to group and search for resources by
4383
4834
  * type. You can attach this metadata to resources (servers, users, workflows, and so on) for any purpose.</p>
4384
4835
  */
@@ -4389,6 +4840,7 @@ export interface TagResourceRequest {
4389
4840
  */
4390
4841
  export interface TestConnectionRequest {
4391
4842
  /**
4843
+ * @public
4392
4844
  * <p>The unique identifier for the connector.</p>
4393
4845
  */
4394
4846
  ConnectorId: string | undefined;
@@ -4398,14 +4850,17 @@ export interface TestConnectionRequest {
4398
4850
  */
4399
4851
  export interface TestConnectionResponse {
4400
4852
  /**
4853
+ * @public
4401
4854
  * <p>Returns the identifier of the connector object that you are testing.</p>
4402
4855
  */
4403
4856
  ConnectorId?: string;
4404
4857
  /**
4858
+ * @public
4405
4859
  * <p>Returns <code>OK</code> for successful test, or <code>ERROR</code> if the test fails.</p>
4406
4860
  */
4407
4861
  Status?: string;
4408
4862
  /**
4863
+ * @public
4409
4864
  * <p>Returns <code>Connection succeeded</code> if the test is successful. Or, returns a descriptive error message
4410
4865
  * if the test fails. The following list provides the details for some error messages and troubleshooting steps for each.</p>
4411
4866
  * <ul>
@@ -4438,11 +4893,13 @@ export interface TestConnectionResponse {
4438
4893
  */
4439
4894
  export interface TestIdentityProviderRequest {
4440
4895
  /**
4896
+ * @public
4441
4897
  * <p>A system-assigned identifier for a specific server. That server's user authentication
4442
4898
  * method is tested with a user name and password.</p>
4443
4899
  */
4444
4900
  ServerId: string | undefined;
4445
4901
  /**
4902
+ * @public
4446
4903
  * <p>The type of file transfer protocol to be tested.</p>
4447
4904
  * <p>The available protocols are:</p>
4448
4905
  * <ul>
@@ -4462,14 +4919,17 @@ export interface TestIdentityProviderRequest {
4462
4919
  */
4463
4920
  ServerProtocol?: Protocol | string;
4464
4921
  /**
4922
+ * @public
4465
4923
  * <p>The source IP address of the account to be tested.</p>
4466
4924
  */
4467
4925
  SourceIp?: string;
4468
4926
  /**
4927
+ * @public
4469
4928
  * <p>The name of the account to be tested.</p>
4470
4929
  */
4471
4930
  UserName: string | undefined;
4472
4931
  /**
4932
+ * @public
4473
4933
  * <p>The password of the account to be tested.</p>
4474
4934
  */
4475
4935
  UserPassword?: string;
@@ -4479,14 +4939,17 @@ export interface TestIdentityProviderRequest {
4479
4939
  */
4480
4940
  export interface TestIdentityProviderResponse {
4481
4941
  /**
4942
+ * @public
4482
4943
  * <p>The response that is returned from your API Gateway or your Lambda function.</p>
4483
4944
  */
4484
4945
  Response?: string;
4485
4946
  /**
4947
+ * @public
4486
4948
  * <p>The HTTP status code that is the response from your API Gateway or your Lambda function.</p>
4487
4949
  */
4488
4950
  StatusCode: number | undefined;
4489
4951
  /**
4952
+ * @public
4490
4953
  * <p>A message that indicates whether the test was successful or not.</p>
4491
4954
  * <note>
4492
4955
  * <p>If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.</p>
@@ -4494,6 +4957,7 @@ export interface TestIdentityProviderResponse {
4494
4957
  */
4495
4958
  Message?: string;
4496
4959
  /**
4960
+ * @public
4497
4961
  * <p>The endpoint of the service used to authenticate a user.</p>
4498
4962
  */
4499
4963
  Url: string | undefined;
@@ -4503,11 +4967,13 @@ export interface TestIdentityProviderResponse {
4503
4967
  */
4504
4968
  export interface UntagResourceRequest {
4505
4969
  /**
4970
+ * @public
4506
4971
  * <p>The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is
4507
4972
  * an identifier for a specific Amazon Web Services resource, such as a server, user, or role.</p>
4508
4973
  */
4509
4974
  Arn: string | undefined;
4510
4975
  /**
4976
+ * @public
4511
4977
  * <p>TagKeys are key-value pairs assigned to ARNs that can be used to group and search for
4512
4978
  * resources by type. This metadata can be attached to resources for any purpose.</p>
4513
4979
  */
@@ -4518,11 +4984,13 @@ export interface UntagResourceRequest {
4518
4984
  */
4519
4985
  export interface UpdateAccessRequest {
4520
4986
  /**
4987
+ * @public
4521
4988
  * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
4522
4989
  * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
4523
4990
  */
4524
4991
  HomeDirectory?: string;
4525
4992
  /**
4993
+ * @public
4526
4994
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
4527
4995
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer
4528
4996
  * protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
@@ -4530,6 +4998,7 @@ export interface UpdateAccessRequest {
4530
4998
  */
4531
4999
  HomeDirectoryType?: HomeDirectoryType | string;
4532
5000
  /**
5001
+ * @public
4533
5002
  * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
4534
5003
  * be visible to your user and how you want to make them visible. You must specify the
4535
5004
  * <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
@@ -4553,6 +5022,7 @@ export interface UpdateAccessRequest {
4553
5022
  */
4554
5023
  HomeDirectoryMappings?: HomeDirectoryMapEntry[];
4555
5024
  /**
5025
+ * @public
4556
5026
  * <p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's
4557
5027
  * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>$\{Transfer:UserName\}</code>,
4558
5028
  * <code>$\{Transfer:HomeDirectory\}</code>, and <code>$\{Transfer:HomeBucket\}</code>.</p>
@@ -4569,6 +5039,7 @@ export interface UpdateAccessRequest {
4569
5039
  */
4570
5040
  Policy?: string;
4571
5041
  /**
5042
+ * @public
4572
5043
  * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
4573
5044
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
4574
5045
  * your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
@@ -4577,6 +5048,7 @@ export interface UpdateAccessRequest {
4577
5048
  */
4578
5049
  PosixProfile?: PosixProfile;
4579
5050
  /**
5051
+ * @public
4580
5052
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
4581
5053
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
4582
5054
  * when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
@@ -4584,10 +5056,12 @@ export interface UpdateAccessRequest {
4584
5056
  */
4585
5057
  Role?: string;
4586
5058
  /**
5059
+ * @public
4587
5060
  * <p>A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.</p>
4588
5061
  */
4589
5062
  ServerId: string | undefined;
4590
5063
  /**
5064
+ * @public
4591
5065
  * <p>A unique identifier that is required to identify specific groups within your directory.
4592
5066
  * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
4593
5067
  * resources over the enabled protocols using Transfer Family. If you know the group name,
@@ -4606,10 +5080,12 @@ export interface UpdateAccessRequest {
4606
5080
  */
4607
5081
  export interface UpdateAccessResponse {
4608
5082
  /**
5083
+ * @public
4609
5084
  * <p>The identifier of the server that the user is attached to.</p>
4610
5085
  */
4611
5086
  ServerId: string | undefined;
4612
5087
  /**
5088
+ * @public
4613
5089
  * <p>The external identifier of the group whose users have access to your Amazon S3 or Amazon
4614
5090
  * EFS resources over the enabled protocols using Amazon Web ServicesTransfer Family.</p>
4615
5091
  */
@@ -4620,34 +5096,41 @@ export interface UpdateAccessResponse {
4620
5096
  */
4621
5097
  export interface UpdateAgreementRequest {
4622
5098
  /**
5099
+ * @public
4623
5100
  * <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
4624
5101
  */
4625
5102
  AgreementId: string | undefined;
4626
5103
  /**
5104
+ * @public
4627
5105
  * <p>A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.</p>
4628
5106
  */
4629
5107
  ServerId: string | undefined;
4630
5108
  /**
5109
+ * @public
4631
5110
  * <p>To replace the existing description, provide a short description for the agreement. </p>
4632
5111
  */
4633
5112
  Description?: string;
4634
5113
  /**
5114
+ * @public
4635
5115
  * <p>You can update the status for the agreement, either activating an inactive agreement or
4636
5116
  * the reverse.</p>
4637
5117
  */
4638
5118
  Status?: AgreementStatusType | string;
4639
5119
  /**
5120
+ * @public
4640
5121
  * <p>A unique identifier for the AS2 local profile.</p>
4641
5122
  * <p>To change the local profile identifier, provide a new value
4642
5123
  * here.</p>
4643
5124
  */
4644
5125
  LocalProfileId?: string;
4645
5126
  /**
5127
+ * @public
4646
5128
  * <p>A unique identifier for the partner profile.
4647
5129
  * To change the partner profile identifier, provide a new value here.</p>
4648
5130
  */
4649
5131
  PartnerProfileId?: string;
4650
5132
  /**
5133
+ * @public
4651
5134
  * <p>To change the landing directory (folder) for files that are transferred, provide the
4652
5135
  * bucket folder that you want to use; for example,
4653
5136
  * <code>/<i>DOC-EXAMPLE-BUCKET</i>/<i>home</i>/<i>mydirectory</i>
@@ -4655,6 +5138,7 @@ export interface UpdateAgreementRequest {
4655
5138
  */
4656
5139
  BaseDirectory?: string;
4657
5140
  /**
5141
+ * @public
4658
5142
  * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
4659
5143
  * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
4660
5144
  * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
@@ -4677,6 +5161,7 @@ export interface UpdateAgreementRequest {
4677
5161
  */
4678
5162
  export interface UpdateAgreementResponse {
4679
5163
  /**
5164
+ * @public
4680
5165
  * <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
4681
5166
  */
4682
5167
  AgreementId: string | undefined;
@@ -4686,18 +5171,22 @@ export interface UpdateAgreementResponse {
4686
5171
  */
4687
5172
  export interface UpdateCertificateRequest {
4688
5173
  /**
5174
+ * @public
4689
5175
  * <p>The identifier of the certificate object that you are updating.</p>
4690
5176
  */
4691
5177
  CertificateId: string | undefined;
4692
5178
  /**
5179
+ * @public
4693
5180
  * <p>An optional date that specifies when the certificate becomes active.</p>
4694
5181
  */
4695
5182
  ActiveDate?: Date;
4696
5183
  /**
5184
+ * @public
4697
5185
  * <p>An optional date that specifies when the certificate becomes inactive.</p>
4698
5186
  */
4699
5187
  InactiveDate?: Date;
4700
5188
  /**
5189
+ * @public
4701
5190
  * <p>A short description to help identify the certificate.</p>
4702
5191
  */
4703
5192
  Description?: string;
@@ -4707,6 +5196,7 @@ export interface UpdateCertificateRequest {
4707
5196
  */
4708
5197
  export interface UpdateCertificateResponse {
4709
5198
  /**
5199
+ * @public
4710
5200
  * <p>Returns the identifier of the certificate object that you are updating.</p>
4711
5201
  */
4712
5202
  CertificateId: string | undefined;
@@ -4716,18 +5206,22 @@ export interface UpdateCertificateResponse {
4716
5206
  */
4717
5207
  export interface UpdateConnectorRequest {
4718
5208
  /**
5209
+ * @public
4719
5210
  * <p>The unique identifier for the connector.</p>
4720
5211
  */
4721
5212
  ConnectorId: string | undefined;
4722
5213
  /**
5214
+ * @public
4723
5215
  * <p>The URL of the partner's AS2 or SFTP endpoint.</p>
4724
5216
  */
4725
5217
  Url?: string;
4726
5218
  /**
5219
+ * @public
4727
5220
  * <p>A structure that contains the parameters for an AS2 connector object.</p>
4728
5221
  */
4729
5222
  As2Config?: As2ConnectorConfig;
4730
5223
  /**
5224
+ * @public
4731
5225
  * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
4732
5226
  * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
4733
5227
  * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
@@ -4745,12 +5239,14 @@ export interface UpdateConnectorRequest {
4745
5239
  */
4746
5240
  AccessRole?: string;
4747
5241
  /**
5242
+ * @public
4748
5243
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn
4749
5244
  * on CloudWatch logging for Amazon S3 events. When set, you can view connector
4750
5245
  * activity in your CloudWatch logs.</p>
4751
5246
  */
4752
5247
  LoggingRole?: string;
4753
5248
  /**
5249
+ * @public
4754
5250
  * <p>A structure that contains the parameters for an SFTP connector object.</p>
4755
5251
  */
4756
5252
  SftpConfig?: SftpConnectorConfig;
@@ -4760,6 +5256,7 @@ export interface UpdateConnectorRequest {
4760
5256
  */
4761
5257
  export interface UpdateConnectorResponse {
4762
5258
  /**
5259
+ * @public
4763
5260
  * <p>Returns the identifier of the connector object that you are updating.</p>
4764
5261
  */
4765
5262
  ConnectorId: string | undefined;
@@ -4769,14 +5266,17 @@ export interface UpdateConnectorResponse {
4769
5266
  */
4770
5267
  export interface UpdateHostKeyRequest {
4771
5268
  /**
5269
+ * @public
4772
5270
  * <p>The identifier of the server that contains the host key that you are updating.</p>
4773
5271
  */
4774
5272
  ServerId: string | undefined;
4775
5273
  /**
5274
+ * @public
4776
5275
  * <p>The identifier of the host key that you are updating.</p>
4777
5276
  */
4778
5277
  HostKeyId: string | undefined;
4779
5278
  /**
5279
+ * @public
4780
5280
  * <p>An updated description for the host key.</p>
4781
5281
  */
4782
5282
  Description: string | undefined;
@@ -4786,10 +5286,12 @@ export interface UpdateHostKeyRequest {
4786
5286
  */
4787
5287
  export interface UpdateHostKeyResponse {
4788
5288
  /**
5289
+ * @public
4789
5290
  * <p>Returns the server identifier for the server that contains the updated host key.</p>
4790
5291
  */
4791
5292
  ServerId: string | undefined;
4792
5293
  /**
5294
+ * @public
4793
5295
  * <p>Returns the host key identifier for the updated host key.</p>
4794
5296
  */
4795
5297
  HostKeyId: string | undefined;
@@ -4799,10 +5301,12 @@ export interface UpdateHostKeyResponse {
4799
5301
  */
4800
5302
  export interface UpdateProfileRequest {
4801
5303
  /**
5304
+ * @public
4802
5305
  * <p>The identifier of the profile object that you are updating.</p>
4803
5306
  */
4804
5307
  ProfileId: string | undefined;
4805
5308
  /**
5309
+ * @public
4806
5310
  * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
4807
5311
  */
4808
5312
  CertificateIds?: string[];
@@ -4812,6 +5316,7 @@ export interface UpdateProfileRequest {
4812
5316
  */
4813
5317
  export interface UpdateProfileResponse {
4814
5318
  /**
5319
+ * @public
4815
5320
  * <p>Returns the identifier for the profile that's being updated.</p>
4816
5321
  */
4817
5322
  ProfileId: string | undefined;
@@ -4821,6 +5326,7 @@ export interface UpdateProfileResponse {
4821
5326
  */
4822
5327
  export interface UpdateServerRequest {
4823
5328
  /**
5329
+ * @public
4824
5330
  * <p>The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required
4825
5331
  * when <code>Protocols</code> is set to <code>FTPS</code>.</p>
4826
5332
  * <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a>
@@ -4856,6 +5362,7 @@ export interface UpdateServerRequest {
4856
5362
  */
4857
5363
  Certificate?: string;
4858
5364
  /**
5365
+ * @public
4859
5366
  * <p>The protocol settings that are configured for your server.</p>
4860
5367
  * <ul>
4861
5368
  * <li>
@@ -4884,6 +5391,7 @@ export interface UpdateServerRequest {
4884
5391
  */
4885
5392
  ProtocolDetails?: ProtocolDetails;
4886
5393
  /**
5394
+ * @public
4887
5395
  * <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
4888
5396
  * When you host your endpoint within your VPC, you can make your endpoint accessible only to resources
4889
5397
  * within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over
@@ -4892,6 +5400,7 @@ export interface UpdateServerRequest {
4892
5400
  */
4893
5401
  EndpointDetails?: EndpointDetails;
4894
5402
  /**
5403
+ * @public
4895
5404
  * <p>The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)
4896
5405
  * or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and
4897
5406
  * resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.</p>
@@ -4913,6 +5422,7 @@ export interface UpdateServerRequest {
4913
5422
  */
4914
5423
  EndpointType?: EndpointType | string;
4915
5424
  /**
5425
+ * @public
4916
5426
  * <p>The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want
4917
5427
  * to rotate keys, or have a set of active keys that use different algorithms.</p>
4918
5428
  * <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
@@ -4936,17 +5446,20 @@ export interface UpdateServerRequest {
4936
5446
  */
4937
5447
  HostKey?: string;
4938
5448
  /**
5449
+ * @public
4939
5450
  * <p>An array containing all of the information required to call a customer's
4940
5451
  * authentication API method.</p>
4941
5452
  */
4942
5453
  IdentityProviderDetails?: IdentityProviderDetails;
4943
5454
  /**
5455
+ * @public
4944
5456
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
4945
5457
  * on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
4946
5458
  * your CloudWatch logs.</p>
4947
5459
  */
4948
5460
  LoggingRole?: string;
4949
5461
  /**
5462
+ * @public
4950
5463
  * <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p>
4951
5464
  * <note>
4952
5465
  * <p>The SFTP protocol does not support post-authentication display banners.</p>
@@ -4954,6 +5467,7 @@ export interface UpdateServerRequest {
4954
5467
  */
4955
5468
  PostAuthenticationLoginBanner?: string;
4956
5469
  /**
5470
+ * @public
4957
5471
  * <p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.
4958
5472
  * For example, the following banner displays details about using the system:</p>
4959
5473
  * <p>
@@ -4964,6 +5478,7 @@ export interface UpdateServerRequest {
4964
5478
  */
4965
5479
  PreAuthenticationLoginBanner?: string;
4966
5480
  /**
5481
+ * @public
4967
5482
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
4968
5483
  * client can connect to your server's endpoint. The available protocols are:</p>
4969
5484
  * <ul>
@@ -5016,15 +5531,18 @@ export interface UpdateServerRequest {
5016
5531
  */
5017
5532
  Protocols?: (Protocol | string)[];
5018
5533
  /**
5534
+ * @public
5019
5535
  * <p>Specifies the name of the security policy that is attached to the server.</p>
5020
5536
  */
5021
5537
  SecurityPolicyName?: string;
5022
5538
  /**
5539
+ * @public
5023
5540
  * <p>A system-assigned unique identifier for a server instance that the Transfer Family user is
5024
5541
  * assigned to.</p>
5025
5542
  */
5026
5543
  ServerId: string | undefined;
5027
5544
  /**
5545
+ * @public
5028
5546
  * <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
5029
5547
  * <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> can also contain a
5030
5548
  * workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects
@@ -5036,6 +5554,7 @@ export interface UpdateServerRequest {
5036
5554
  */
5037
5555
  WorkflowDetails?: WorkflowDetails;
5038
5556
  /**
5557
+ * @public
5039
5558
  * <p>Specifies the log groups to which your server logs are sent.</p>
5040
5559
  * <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p>
5041
5560
  * <p>
@@ -5056,6 +5575,7 @@ export interface UpdateServerRequest {
5056
5575
  */
5057
5576
  export interface UpdateServerResponse {
5058
5577
  /**
5578
+ * @public
5059
5579
  * <p>A system-assigned unique identifier for a server that the Transfer Family user is assigned
5060
5580
  * to.</p>
5061
5581
  */
@@ -5066,11 +5586,13 @@ export interface UpdateServerResponse {
5066
5586
  */
5067
5587
  export interface UpdateUserRequest {
5068
5588
  /**
5589
+ * @public
5069
5590
  * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
5070
5591
  * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
5071
5592
  */
5072
5593
  HomeDirectory?: string;
5073
5594
  /**
5595
+ * @public
5074
5596
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
5075
5597
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer
5076
5598
  * protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for
@@ -5078,6 +5600,7 @@ export interface UpdateUserRequest {
5078
5600
  */
5079
5601
  HomeDirectoryType?: HomeDirectoryType | string;
5080
5602
  /**
5603
+ * @public
5081
5604
  * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
5082
5605
  * be visible to your user and how you want to make them visible. You must specify the
5083
5606
  * <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
@@ -5101,6 +5624,7 @@ export interface UpdateUserRequest {
5101
5624
  */
5102
5625
  HomeDirectoryMappings?: HomeDirectoryMapEntry[];
5103
5626
  /**
5627
+ * @public
5104
5628
  * <p>A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's
5105
5629
  * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>$\{Transfer:UserName\}</code>,
5106
5630
  * <code>$\{Transfer:HomeDirectory\}</code>, and <code>$\{Transfer:HomeBucket\}</code>.</p>
@@ -5117,6 +5641,7 @@ export interface UpdateUserRequest {
5117
5641
  */
5118
5642
  Policy?: string;
5119
5643
  /**
5644
+ * @public
5120
5645
  * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID
5121
5646
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
5122
5647
  * your users' access to your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions
@@ -5125,6 +5650,7 @@ export interface UpdateUserRequest {
5125
5650
  */
5126
5651
  PosixProfile?: PosixProfile;
5127
5652
  /**
5653
+ * @public
5128
5654
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
5129
5655
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
5130
5656
  * when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
@@ -5132,11 +5658,13 @@ export interface UpdateUserRequest {
5132
5658
  */
5133
5659
  Role?: string;
5134
5660
  /**
5661
+ * @public
5135
5662
  * <p>A system-assigned unique identifier for a Transfer Family server instance that the user is
5136
5663
  * assigned to.</p>
5137
5664
  */
5138
5665
  ServerId: string | undefined;
5139
5666
  /**
5667
+ * @public
5140
5668
  * <p>A unique string that identifies a user and is associated with a server as specified by the
5141
5669
  * <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 100 characters
5142
5670
  * long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen
@@ -5153,11 +5681,13 @@ export interface UpdateUserRequest {
5153
5681
  */
5154
5682
  export interface UpdateUserResponse {
5155
5683
  /**
5684
+ * @public
5156
5685
  * <p>A system-assigned unique identifier for a Transfer Family server instance that the account is
5157
5686
  * assigned to.</p>
5158
5687
  */
5159
5688
  ServerId: string | undefined;
5160
5689
  /**
5690
+ * @public
5161
5691
  * <p>The unique identifier for a user that is assigned to a server instance that was specified
5162
5692
  * in the request.</p>
5163
5693
  */