@aws-sdk/client-transfer 3.686.0 → 3.691.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.
@@ -7,7 +7,7 @@ import { TransferServiceException as __BaseException } from "./TransferServiceEx
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
9
9
  readonly $fault: "client";
10
- Message?: string;
10
+ Message?: string | undefined;
11
11
  /**
12
12
  * @internal
13
13
  */
@@ -53,7 +53,7 @@ export interface CreateAgreementRequest {
53
53
  * <p>A name or short description to identify the agreement. </p>
54
54
  * @public
55
55
  */
56
- Description?: string;
56
+ Description?: string | undefined;
57
57
  /**
58
58
  * <p>A system-assigned unique identifier for a server instance. This is the specific server
59
59
  * that the agreement uses.</p>
@@ -113,12 +113,12 @@ export interface CreateAgreementRequest {
113
113
  * <code>INACTIVE</code>.</p>
114
114
  * @public
115
115
  */
116
- Status?: AgreementStatusType;
116
+ Status?: AgreementStatusType | undefined;
117
117
  /**
118
118
  * <p>Key-value pairs that can be used to group and search for agreements.</p>
119
119
  * @public
120
120
  */
121
- Tags?: Tag[];
121
+ Tags?: Tag[] | undefined;
122
122
  }
123
123
  /**
124
124
  * @public
@@ -196,7 +196,7 @@ export declare class ResourceNotFoundException extends __BaseException {
196
196
  export declare class ServiceUnavailableException extends __BaseException {
197
197
  readonly name: "ServiceUnavailableException";
198
198
  readonly $fault: "server";
199
- Message?: string;
199
+ Message?: string | undefined;
200
200
  /**
201
201
  * @internal
202
202
  */
@@ -209,7 +209,7 @@ export declare class ServiceUnavailableException extends __BaseException {
209
209
  export declare class ThrottlingException extends __BaseException {
210
210
  readonly name: "ThrottlingException";
211
211
  readonly $fault: "client";
212
- RetryAfterSeconds?: string;
212
+ RetryAfterSeconds?: string | undefined;
213
213
  /**
214
214
  * @internal
215
215
  */
@@ -259,40 +259,40 @@ export interface DescribedAgreement {
259
259
  * <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
260
260
  * @public
261
261
  */
262
- AgreementId?: string;
262
+ AgreementId?: string | undefined;
263
263
  /**
264
264
  * <p>The name or short description that's used to identify the agreement.</p>
265
265
  * @public
266
266
  */
267
- Description?: string;
267
+ Description?: string | undefined;
268
268
  /**
269
269
  * <p>The current status of the agreement, either <code>ACTIVE</code> or
270
270
  * <code>INACTIVE</code>.</p>
271
271
  * @public
272
272
  */
273
- Status?: AgreementStatusType;
273
+ Status?: AgreementStatusType | undefined;
274
274
  /**
275
275
  * <p>A system-assigned unique identifier for a server instance. This identifier indicates the
276
276
  * specific server that the agreement uses.</p>
277
277
  * @public
278
278
  */
279
- ServerId?: string;
279
+ ServerId?: string | undefined;
280
280
  /**
281
281
  * <p>A unique identifier for the AS2 local profile.</p>
282
282
  * @public
283
283
  */
284
- LocalProfileId?: string;
284
+ LocalProfileId?: string | undefined;
285
285
  /**
286
286
  * <p>A unique identifier for the partner profile used in the agreement.</p>
287
287
  * @public
288
288
  */
289
- PartnerProfileId?: string;
289
+ PartnerProfileId?: string | undefined;
290
290
  /**
291
291
  * <p>The landing directory (folder) for files that are transferred by using the AS2
292
292
  * protocol.</p>
293
293
  * @public
294
294
  */
295
- BaseDirectory?: string;
295
+ BaseDirectory?: string | undefined;
296
296
  /**
297
297
  * <p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,
298
298
  * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p>
@@ -323,12 +323,12 @@ export interface DescribedAgreement {
323
323
  * <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
324
324
  * @public
325
325
  */
326
- AccessRole?: string;
326
+ AccessRole?: string | undefined;
327
327
  /**
328
328
  * <p>Key-value pairs that can be used to group and search for agreements.</p>
329
329
  * @public
330
330
  */
331
- Tags?: Tag[];
331
+ Tags?: Tag[] | undefined;
332
332
  }
333
333
  /**
334
334
  * @public
@@ -362,7 +362,7 @@ export interface ListAgreementsRequest {
362
362
  * <p>The maximum number of agreements to return.</p>
363
363
  * @public
364
364
  */
365
- MaxResults?: number;
365
+ MaxResults?: number | undefined;
366
366
  /**
367
367
  * <p>When you can get additional results from the <code>ListAgreements</code> call, a
368
368
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
@@ -370,7 +370,7 @@ export interface ListAgreementsRequest {
370
370
  * agreements.</p>
371
371
  * @public
372
372
  */
373
- NextToken?: string;
373
+ NextToken?: string | undefined;
374
374
  /**
375
375
  * <p>The identifier of the server for which you want a list of agreements.</p>
376
376
  * @public
@@ -386,38 +386,38 @@ export interface ListedAgreement {
386
386
  * <p>The Amazon Resource Name (ARN) of the specified agreement.</p>
387
387
  * @public
388
388
  */
389
- Arn?: string;
389
+ Arn?: string | undefined;
390
390
  /**
391
391
  * <p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p>
392
392
  * @public
393
393
  */
394
- AgreementId?: string;
394
+ AgreementId?: string | undefined;
395
395
  /**
396
396
  * <p>The current description for the agreement. You can change it by calling the
397
397
  * <code>UpdateAgreement</code> operation and providing a new description. </p>
398
398
  * @public
399
399
  */
400
- Description?: string;
400
+ Description?: string | undefined;
401
401
  /**
402
402
  * <p>The agreement can be either <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
403
403
  * @public
404
404
  */
405
- Status?: AgreementStatusType;
405
+ Status?: AgreementStatusType | undefined;
406
406
  /**
407
407
  * <p>The unique identifier for the agreement.</p>
408
408
  * @public
409
409
  */
410
- ServerId?: string;
410
+ ServerId?: string | undefined;
411
411
  /**
412
412
  * <p>A unique identifier for the AS2 local profile.</p>
413
413
  * @public
414
414
  */
415
- LocalProfileId?: string;
415
+ LocalProfileId?: string | undefined;
416
416
  /**
417
417
  * <p>A unique identifier for the partner profile.</p>
418
418
  * @public
419
419
  */
420
- PartnerProfileId?: string;
420
+ PartnerProfileId?: string | undefined;
421
421
  }
422
422
  /**
423
423
  * @public
@@ -428,7 +428,7 @@ export interface ListAgreementsResponse {
428
428
  * additional results, if there are any.</p>
429
429
  * @public
430
430
  */
431
- NextToken?: string;
431
+ NextToken?: string | undefined;
432
432
  /**
433
433
  * <p>Returns an array, where each item contains the details of an agreement.</p>
434
434
  * @public
@@ -453,26 +453,26 @@ export interface UpdateAgreementRequest {
453
453
  * <p>To replace the existing description, provide a short description for the agreement. </p>
454
454
  * @public
455
455
  */
456
- Description?: string;
456
+ Description?: string | undefined;
457
457
  /**
458
458
  * <p>You can update the status for the agreement, either activating an inactive agreement or
459
459
  * the reverse.</p>
460
460
  * @public
461
461
  */
462
- Status?: AgreementStatusType;
462
+ Status?: AgreementStatusType | undefined;
463
463
  /**
464
464
  * <p>A unique identifier for the AS2 local profile.</p>
465
465
  * <p>To change the local profile identifier, provide a new value
466
466
  * here.</p>
467
467
  * @public
468
468
  */
469
- LocalProfileId?: string;
469
+ LocalProfileId?: string | undefined;
470
470
  /**
471
471
  * <p>A unique identifier for the partner profile.
472
472
  * To change the partner profile identifier, provide a new value here.</p>
473
473
  * @public
474
474
  */
475
- PartnerProfileId?: string;
475
+ PartnerProfileId?: string | undefined;
476
476
  /**
477
477
  * <p>To change the landing directory (folder) for files that are transferred, provide the
478
478
  * bucket folder that you want to use; for example,
@@ -480,7 +480,7 @@ export interface UpdateAgreementRequest {
480
480
  * </code>.</p>
481
481
  * @public
482
482
  */
483
- BaseDirectory?: string;
483
+ BaseDirectory?: string | undefined;
484
484
  /**
485
485
  * <p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,
486
486
  * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p>
@@ -511,7 +511,7 @@ export interface UpdateAgreementRequest {
511
511
  * <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
512
512
  * @public
513
513
  */
514
- AccessRole?: string;
514
+ AccessRole?: string | undefined;
515
515
  }
516
516
  /**
517
517
  * @public
@@ -603,22 +603,22 @@ export interface As2ConnectorConfig {
603
603
  * <p>A unique identifier for the AS2 local profile.</p>
604
604
  * @public
605
605
  */
606
- LocalProfileId?: string;
606
+ LocalProfileId?: string | undefined;
607
607
  /**
608
608
  * <p>A unique identifier for the partner profile for the connector.</p>
609
609
  * @public
610
610
  */
611
- PartnerProfileId?: string;
611
+ PartnerProfileId?: string | undefined;
612
612
  /**
613
613
  * <p>Used as the <code>Subject</code> HTTP header attribute in AS2 messages that are being sent with the connector.</p>
614
614
  * @public
615
615
  */
616
- MessageSubject?: string;
616
+ MessageSubject?: string | undefined;
617
617
  /**
618
618
  * <p>Specifies whether the AS2 file is compressed.</p>
619
619
  * @public
620
620
  */
621
- Compression?: CompressionEnum;
621
+ Compression?: CompressionEnum | undefined;
622
622
  /**
623
623
  * <p>The algorithm that is used to encrypt the file.</p>
624
624
  * <p>Note the following:</p>
@@ -633,12 +633,12 @@ export interface As2ConnectorConfig {
633
633
  * </ul>
634
634
  * @public
635
635
  */
636
- EncryptionAlgorithm?: EncryptionAlg;
636
+ EncryptionAlgorithm?: EncryptionAlg | undefined;
637
637
  /**
638
638
  * <p>The algorithm that is used to sign the AS2 messages sent with the connector.</p>
639
639
  * @public
640
640
  */
641
- SigningAlgorithm?: SigningAlg;
641
+ SigningAlgorithm?: SigningAlg | undefined;
642
642
  /**
643
643
  * <p>The signing algorithm for the MDN response.</p>
644
644
  * <note>
@@ -646,7 +646,7 @@ export interface As2ConnectorConfig {
646
646
  * </note>
647
647
  * @public
648
648
  */
649
- MdnSigningAlgorithm?: MdnSigningAlg;
649
+ MdnSigningAlgorithm?: MdnSigningAlg | undefined;
650
650
  /**
651
651
  * <p>Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether
652
652
  * the partner response for transfers is synchronous or asynchronous. Specify either of the following values:</p>
@@ -662,7 +662,7 @@ export interface As2ConnectorConfig {
662
662
  * </ul>
663
663
  * @public
664
664
  */
665
- MdnResponse?: MdnResponse;
665
+ MdnResponse?: MdnResponse | undefined;
666
666
  /**
667
667
  * <p>Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication,
668
668
  * you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.</p>
@@ -691,7 +691,7 @@ export interface As2ConnectorConfig {
691
691
  * </p>
692
692
  * @public
693
693
  */
694
- BasicAuthSecretId?: string;
694
+ BasicAuthSecretId?: string | undefined;
695
695
  }
696
696
  /**
697
697
  * @public
@@ -776,7 +776,7 @@ export interface DescribedCertificate {
776
776
  * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
777
777
  * @public
778
778
  */
779
- CertificateId?: string;
779
+ CertificateId?: string | undefined;
780
780
  /**
781
781
  * <p>Specifies how this certificate is used. It can be used in the following ways:</p>
782
782
  * <ul>
@@ -795,65 +795,65 @@ export interface DescribedCertificate {
795
795
  * </ul>
796
796
  * @public
797
797
  */
798
- Usage?: CertificateUsageType;
798
+ Usage?: CertificateUsageType | undefined;
799
799
  /**
800
800
  * <p>The certificate can be either <code>ACTIVE</code>, <code>PENDING_ROTATION</code>, or
801
801
  * <code>INACTIVE</code>. <code>PENDING_ROTATION</code> means that this certificate will
802
802
  * replace the current certificate when it expires.</p>
803
803
  * @public
804
804
  */
805
- Status?: CertificateStatusType;
805
+ Status?: CertificateStatusType | undefined;
806
806
  /**
807
807
  * <p>The file name for the certificate.</p>
808
808
  * @public
809
809
  */
810
- Certificate?: string;
810
+ Certificate?: string | undefined;
811
811
  /**
812
812
  * <p>The list of certificates that make up the chain for the certificate.</p>
813
813
  * @public
814
814
  */
815
- CertificateChain?: string;
815
+ CertificateChain?: string | undefined;
816
816
  /**
817
817
  * <p>An optional date that specifies when the certificate becomes active.</p>
818
818
  * @public
819
819
  */
820
- ActiveDate?: Date;
820
+ ActiveDate?: Date | undefined;
821
821
  /**
822
822
  * <p>An optional date that specifies when the certificate becomes inactive.</p>
823
823
  * @public
824
824
  */
825
- InactiveDate?: Date;
825
+ InactiveDate?: Date | undefined;
826
826
  /**
827
827
  * <p>The serial number for the certificate.</p>
828
828
  * @public
829
829
  */
830
- Serial?: string;
830
+ Serial?: string | undefined;
831
831
  /**
832
832
  * <p>The earliest date that the certificate is valid.</p>
833
833
  * @public
834
834
  */
835
- NotBeforeDate?: Date;
835
+ NotBeforeDate?: Date | undefined;
836
836
  /**
837
837
  * <p>The final date that the certificate is
838
838
  * valid.</p>
839
839
  * @public
840
840
  */
841
- NotAfterDate?: Date;
841
+ NotAfterDate?: Date | undefined;
842
842
  /**
843
843
  * <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>
844
844
  * @public
845
845
  */
846
- Type?: CertificateType;
846
+ Type?: CertificateType | undefined;
847
847
  /**
848
848
  * <p>The name or description that's used to identity the certificate. </p>
849
849
  * @public
850
850
  */
851
- Description?: string;
851
+ Description?: string | undefined;
852
852
  /**
853
853
  * <p>Key-value pairs that can be used to group and search for certificates.</p>
854
854
  * @public
855
855
  */
856
- Tags?: Tag[];
856
+ Tags?: Tag[] | undefined;
857
857
  }
858
858
  /**
859
859
  * @public
@@ -906,7 +906,7 @@ export interface ImportCertificateRequest {
906
906
  * imported.</p>
907
907
  * @public
908
908
  */
909
- CertificateChain?: string;
909
+ CertificateChain?: string | undefined;
910
910
  /**
911
911
  * <ul>
912
912
  * <li>
@@ -920,27 +920,27 @@ export interface ImportCertificateRequest {
920
920
  * </ul>
921
921
  * @public
922
922
  */
923
- PrivateKey?: string;
923
+ PrivateKey?: string | undefined;
924
924
  /**
925
925
  * <p>An optional date that specifies when the certificate becomes active.</p>
926
926
  * @public
927
927
  */
928
- ActiveDate?: Date;
928
+ ActiveDate?: Date | undefined;
929
929
  /**
930
930
  * <p>An optional date that specifies when the certificate becomes inactive.</p>
931
931
  * @public
932
932
  */
933
- InactiveDate?: Date;
933
+ InactiveDate?: Date | undefined;
934
934
  /**
935
935
  * <p>A short description that helps identify the certificate. </p>
936
936
  * @public
937
937
  */
938
- Description?: string;
938
+ Description?: string | undefined;
939
939
  /**
940
940
  * <p>Key-value pairs that can be used to group and search for certificates.</p>
941
941
  * @public
942
942
  */
943
- Tags?: Tag[];
943
+ Tags?: Tag[] | undefined;
944
944
  }
945
945
  /**
946
946
  * @public
@@ -960,7 +960,7 @@ export interface ListCertificatesRequest {
960
960
  * <p>The maximum number of certificates to return.</p>
961
961
  * @public
962
962
  */
963
- MaxResults?: number;
963
+ MaxResults?: number | undefined;
964
964
  /**
965
965
  * <p>When you can get additional results from the <code>ListCertificates</code> call, a
966
966
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
@@ -968,7 +968,7 @@ export interface ListCertificatesRequest {
968
968
  * certificates.</p>
969
969
  * @public
970
970
  */
971
- NextToken?: string;
971
+ NextToken?: string | undefined;
972
972
  }
973
973
  /**
974
974
  * <p>Describes the properties of a certificate.</p>
@@ -979,12 +979,12 @@ export interface ListedCertificate {
979
979
  * <p>The Amazon Resource Name (ARN) of the specified certificate.</p>
980
980
  * @public
981
981
  */
982
- Arn?: string;
982
+ Arn?: string | undefined;
983
983
  /**
984
984
  * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
985
985
  * @public
986
986
  */
987
- CertificateId?: string;
987
+ CertificateId?: string | undefined;
988
988
  /**
989
989
  * <p>Specifies how this certificate is used. It can be used in the following ways:</p>
990
990
  * <ul>
@@ -1003,36 +1003,36 @@ export interface ListedCertificate {
1003
1003
  * </ul>
1004
1004
  * @public
1005
1005
  */
1006
- Usage?: CertificateUsageType;
1006
+ Usage?: CertificateUsageType | undefined;
1007
1007
  /**
1008
1008
  * <p>The certificate can be either <code>ACTIVE</code>, <code>PENDING_ROTATION</code>, or
1009
1009
  * <code>INACTIVE</code>. <code>PENDING_ROTATION</code> means that this certificate will
1010
1010
  * replace the current certificate when it expires.</p>
1011
1011
  * @public
1012
1012
  */
1013
- Status?: CertificateStatusType;
1013
+ Status?: CertificateStatusType | undefined;
1014
1014
  /**
1015
1015
  * <p>An optional date that specifies when the certificate becomes active.</p>
1016
1016
  * @public
1017
1017
  */
1018
- ActiveDate?: Date;
1018
+ ActiveDate?: Date | undefined;
1019
1019
  /**
1020
1020
  * <p>An optional date that specifies when the certificate becomes inactive.</p>
1021
1021
  * @public
1022
1022
  */
1023
- InactiveDate?: Date;
1023
+ InactiveDate?: Date | undefined;
1024
1024
  /**
1025
1025
  * <p>The type for the certificate. If a private key has been specified for the certificate, its
1026
1026
  * type is <code>CERTIFICATE_WITH_PRIVATE_KEY</code>. If there is no private key, the type is
1027
1027
  * <code>CERTIFICATE</code>.</p>
1028
1028
  * @public
1029
1029
  */
1030
- Type?: CertificateType;
1030
+ Type?: CertificateType | undefined;
1031
1031
  /**
1032
1032
  * <p>The name or short description that's used to identify the certificate.</p>
1033
1033
  * @public
1034
1034
  */
1035
- Description?: string;
1035
+ Description?: string | undefined;
1036
1036
  }
1037
1037
  /**
1038
1038
  * @public
@@ -1042,7 +1042,7 @@ export interface ListCertificatesResponse {
1042
1042
  * <p>Returns the next token, which you can use to list the next certificate.</p>
1043
1043
  * @public
1044
1044
  */
1045
- NextToken?: string;
1045
+ NextToken?: string | undefined;
1046
1046
  /**
1047
1047
  * <p>Returns an array of the certificates that are specified in the
1048
1048
  * <code>ListCertificates</code> call.</p>
@@ -1063,17 +1063,17 @@ export interface UpdateCertificateRequest {
1063
1063
  * <p>An optional date that specifies when the certificate becomes active.</p>
1064
1064
  * @public
1065
1065
  */
1066
- ActiveDate?: Date;
1066
+ ActiveDate?: Date | undefined;
1067
1067
  /**
1068
1068
  * <p>An optional date that specifies when the certificate becomes inactive.</p>
1069
1069
  * @public
1070
1070
  */
1071
- InactiveDate?: Date;
1071
+ InactiveDate?: Date | undefined;
1072
1072
  /**
1073
1073
  * <p>A short description to help identify the certificate.</p>
1074
1074
  * @public
1075
1075
  */
1076
- Description?: string;
1076
+ Description?: string | undefined;
1077
1077
  }
1078
1078
  /**
1079
1079
  * @public
@@ -1134,12 +1134,12 @@ export interface ConnectorFileTransferResult {
1134
1134
  * </p>
1135
1135
  * @public
1136
1136
  */
1137
- FailureCode?: string;
1137
+ FailureCode?: string | undefined;
1138
1138
  /**
1139
1139
  * <p>For transfers that fail, this parameter describes the reason for the failure.</p>
1140
1140
  * @public
1141
1141
  */
1142
- FailureMessage?: string;
1142
+ FailureMessage?: string | undefined;
1143
1143
  }
1144
1144
  /**
1145
1145
  * <p>Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a
@@ -1156,7 +1156,7 @@ export interface SftpConnectorConfig {
1156
1156
  * <p>The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.</p>
1157
1157
  * @public
1158
1158
  */
1159
- UserSecretId?: string;
1159
+ UserSecretId?: string | undefined;
1160
1160
  /**
1161
1161
  * <p>The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.
1162
1162
  * You can use the <code>ssh-keyscan</code> command against the SFTP server to retrieve the necessary key.</p>
@@ -1186,7 +1186,7 @@ export interface SftpConnectorConfig {
1186
1186
  * <p>Copy and paste this string into the <code>TrustedHostKeys</code> field for the <code>create-connector</code> command or into the <b>Trusted host keys</b> field in the console.</p>
1187
1187
  * @public
1188
1188
  */
1189
- TrustedHostKeys?: string[];
1189
+ TrustedHostKeys?: string[] | undefined;
1190
1190
  }
1191
1191
  /**
1192
1192
  * @public
@@ -1201,7 +1201,7 @@ export interface CreateConnectorRequest {
1201
1201
  * <p>A structure that contains the parameters for an AS2 connector object.</p>
1202
1202
  * @public
1203
1203
  */
1204
- As2Config?: As2ConnectorConfig;
1204
+ As2Config?: As2ConnectorConfig | undefined;
1205
1205
  /**
1206
1206
  * <p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,
1207
1207
  * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p>
@@ -1239,22 +1239,22 @@ export interface CreateConnectorRequest {
1239
1239
  * activity in your CloudWatch logs.</p>
1240
1240
  * @public
1241
1241
  */
1242
- LoggingRole?: string;
1242
+ LoggingRole?: string | undefined;
1243
1243
  /**
1244
1244
  * <p>Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.</p>
1245
1245
  * @public
1246
1246
  */
1247
- Tags?: Tag[];
1247
+ Tags?: Tag[] | undefined;
1248
1248
  /**
1249
1249
  * <p>A structure that contains the parameters for an SFTP connector object.</p>
1250
1250
  * @public
1251
1251
  */
1252
- SftpConfig?: SftpConnectorConfig;
1252
+ SftpConfig?: SftpConnectorConfig | undefined;
1253
1253
  /**
1254
1254
  * <p>Specifies the name of the security policy for the connector.</p>
1255
1255
  * @public
1256
1256
  */
1257
- SecurityPolicyName?: string;
1257
+ SecurityPolicyName?: string | undefined;
1258
1258
  }
1259
1259
  /**
1260
1260
  * @public
@@ -1301,17 +1301,17 @@ export interface DescribedConnector {
1301
1301
  * <p>The unique identifier for the connector.</p>
1302
1302
  * @public
1303
1303
  */
1304
- ConnectorId?: string;
1304
+ ConnectorId?: string | undefined;
1305
1305
  /**
1306
1306
  * <p>The URL of the partner's AS2 or SFTP endpoint.</p>
1307
1307
  * @public
1308
1308
  */
1309
- Url?: string;
1309
+ Url?: string | undefined;
1310
1310
  /**
1311
1311
  * <p>A structure that contains the parameters for an AS2 connector object.</p>
1312
1312
  * @public
1313
1313
  */
1314
- As2Config?: As2ConnectorConfig;
1314
+ As2Config?: As2ConnectorConfig | undefined;
1315
1315
  /**
1316
1316
  * <p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,
1317
1317
  * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p>
@@ -1342,34 +1342,34 @@ export interface DescribedConnector {
1342
1342
  * <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
1343
1343
  * @public
1344
1344
  */
1345
- AccessRole?: string;
1345
+ AccessRole?: string | undefined;
1346
1346
  /**
1347
1347
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn
1348
1348
  * on CloudWatch logging for Amazon S3 events. When set, you can view connector
1349
1349
  * activity in your CloudWatch logs.</p>
1350
1350
  * @public
1351
1351
  */
1352
- LoggingRole?: string;
1352
+ LoggingRole?: string | undefined;
1353
1353
  /**
1354
1354
  * <p>Key-value pairs that can be used to group and search for connectors.</p>
1355
1355
  * @public
1356
1356
  */
1357
- Tags?: Tag[];
1357
+ Tags?: Tag[] | undefined;
1358
1358
  /**
1359
1359
  * <p>A structure that contains the parameters for an SFTP connector object.</p>
1360
1360
  * @public
1361
1361
  */
1362
- SftpConfig?: SftpConnectorConfig;
1362
+ SftpConfig?: SftpConnectorConfig | undefined;
1363
1363
  /**
1364
1364
  * <p>The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.</p>
1365
1365
  * @public
1366
1366
  */
1367
- ServiceManagedEgressIpAddresses?: string[];
1367
+ ServiceManagedEgressIpAddresses?: string[] | undefined;
1368
1368
  /**
1369
1369
  * <p>The text name of the security policy for the specified connector.</p>
1370
1370
  * @public
1371
1371
  */
1372
- SecurityPolicyName?: string;
1372
+ SecurityPolicyName?: string | undefined;
1373
1373
  }
1374
1374
  /**
1375
1375
  * @public
@@ -1389,7 +1389,7 @@ export interface ListConnectorsRequest {
1389
1389
  * <p>The maximum number of connectors to return.</p>
1390
1390
  * @public
1391
1391
  */
1392
- MaxResults?: number;
1392
+ MaxResults?: number | undefined;
1393
1393
  /**
1394
1394
  * <p>When you can get additional results from the <code>ListConnectors</code> call, a
1395
1395
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
@@ -1397,7 +1397,7 @@ export interface ListConnectorsRequest {
1397
1397
  * connectors.</p>
1398
1398
  * @public
1399
1399
  */
1400
- NextToken?: string;
1400
+ NextToken?: string | undefined;
1401
1401
  }
1402
1402
  /**
1403
1403
  * <p>Returns details of the connector that is specified.</p>
@@ -1408,17 +1408,17 @@ export interface ListedConnector {
1408
1408
  * <p>The Amazon Resource Name (ARN) of the specified connector.</p>
1409
1409
  * @public
1410
1410
  */
1411
- Arn?: string;
1411
+ Arn?: string | undefined;
1412
1412
  /**
1413
1413
  * <p>The unique identifier for the connector.</p>
1414
1414
  * @public
1415
1415
  */
1416
- ConnectorId?: string;
1416
+ ConnectorId?: string | undefined;
1417
1417
  /**
1418
1418
  * <p>The URL of the partner's AS2 or SFTP endpoint.</p>
1419
1419
  * @public
1420
1420
  */
1421
- Url?: string;
1421
+ Url?: string | undefined;
1422
1422
  }
1423
1423
  /**
1424
1424
  * @public
@@ -1429,7 +1429,7 @@ export interface ListConnectorsResponse {
1429
1429
  * additional results, if there are any.</p>
1430
1430
  * @public
1431
1431
  */
1432
- NextToken?: string;
1432
+ NextToken?: string | undefined;
1433
1433
  /**
1434
1434
  * <p>Returns an array, where each item contains the details of a connector.</p>
1435
1435
  * @public
@@ -1449,12 +1449,12 @@ export interface UpdateConnectorRequest {
1449
1449
  * <p>The URL of the partner's AS2 or SFTP endpoint.</p>
1450
1450
  * @public
1451
1451
  */
1452
- Url?: string;
1452
+ Url?: string | undefined;
1453
1453
  /**
1454
1454
  * <p>A structure that contains the parameters for an AS2 connector object.</p>
1455
1455
  * @public
1456
1456
  */
1457
- As2Config?: As2ConnectorConfig;
1457
+ As2Config?: As2ConnectorConfig | undefined;
1458
1458
  /**
1459
1459
  * <p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,
1460
1460
  * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p>
@@ -1485,24 +1485,24 @@ export interface UpdateConnectorRequest {
1485
1485
  * <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
1486
1486
  * @public
1487
1487
  */
1488
- AccessRole?: string;
1488
+ AccessRole?: string | undefined;
1489
1489
  /**
1490
1490
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn
1491
1491
  * on CloudWatch logging for Amazon S3 events. When set, you can view connector
1492
1492
  * activity in your CloudWatch logs.</p>
1493
1493
  * @public
1494
1494
  */
1495
- LoggingRole?: string;
1495
+ LoggingRole?: string | undefined;
1496
1496
  /**
1497
1497
  * <p>A structure that contains the parameters for an SFTP connector object.</p>
1498
1498
  * @public
1499
1499
  */
1500
- SftpConfig?: SftpConnectorConfig;
1500
+ SftpConfig?: SftpConnectorConfig | undefined;
1501
1501
  /**
1502
1502
  * <p>Specifies the name of the security policy for the connector.</p>
1503
1503
  * @public
1504
1504
  */
1505
- SecurityPolicyName?: string;
1505
+ SecurityPolicyName?: string | undefined;
1506
1506
  }
1507
1507
  /**
1508
1508
  * @public
@@ -1526,12 +1526,12 @@ export interface EfsFileLocation {
1526
1526
  * <p>The identifier of the file system, assigned by Amazon EFS.</p>
1527
1527
  * @public
1528
1528
  */
1529
- FileSystemId?: string;
1529
+ FileSystemId?: string | undefined;
1530
1530
  /**
1531
1531
  * <p>The pathname for the folder being used by a workflow.</p>
1532
1532
  * @public
1533
1533
  */
1534
- Path?: string;
1534
+ Path?: string | undefined;
1535
1535
  }
1536
1536
  /**
1537
1537
  * <p>Specifies the customer input Amazon S3 file location. If it is used inside <code>copyStepDetails.DestinationFileLocation</code>, it should be the S3 copy destination.</p>
@@ -1552,12 +1552,12 @@ export interface S3InputFileLocation {
1552
1552
  * <p>Specifies the S3 bucket for the customer input file.</p>
1553
1553
  * @public
1554
1554
  */
1555
- Bucket?: string;
1555
+ Bucket?: string | undefined;
1556
1556
  /**
1557
1557
  * <p>The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.</p>
1558
1558
  * @public
1559
1559
  */
1560
- Key?: string;
1560
+ Key?: string | undefined;
1561
1561
  }
1562
1562
  /**
1563
1563
  * <p>Specifies the location for the file that's being processed.</p>
@@ -1568,13 +1568,13 @@ export interface InputFileLocation {
1568
1568
  * <p>Specifies the details for the Amazon S3 file that's being copied or decrypted.</p>
1569
1569
  * @public
1570
1570
  */
1571
- S3FileLocation?: S3InputFileLocation;
1571
+ S3FileLocation?: S3InputFileLocation | undefined;
1572
1572
  /**
1573
1573
  * <p>Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being
1574
1574
  * decrypted.</p>
1575
1575
  * @public
1576
1576
  */
1577
- EfsFileLocation?: EfsFileLocation;
1577
+ EfsFileLocation?: EfsFileLocation | undefined;
1578
1578
  }
1579
1579
  /**
1580
1580
  * @public
@@ -1597,7 +1597,7 @@ export interface CopyStepDetails {
1597
1597
  * <p>The name of the step, used as an identifier.</p>
1598
1598
  * @public
1599
1599
  */
1600
- Name?: string;
1600
+ Name?: string | undefined;
1601
1601
  /**
1602
1602
  * <p>Specifies the location for the file being copied. Use <code>$\{Transfer:UserName\}</code> or
1603
1603
  * <code>$\{Transfer:UploadDate\}</code> in this field to parametrize the destination prefix by
@@ -1620,7 +1620,7 @@ export interface CopyStepDetails {
1620
1620
  * </ul>
1621
1621
  * @public
1622
1622
  */
1623
- DestinationFileLocation?: InputFileLocation;
1623
+ DestinationFileLocation?: InputFileLocation | undefined;
1624
1624
  /**
1625
1625
  * <p>A flag that indicates whether to overwrite an existing file of the same name.
1626
1626
  * The default is <code>FALSE</code>.</p>
@@ -1635,7 +1635,7 @@ export interface CopyStepDetails {
1635
1635
  * </ul>
1636
1636
  * @public
1637
1637
  */
1638
- OverwriteExisting?: OverwriteExisting;
1638
+ OverwriteExisting?: OverwriteExisting | undefined;
1639
1639
  /**
1640
1640
  * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
1641
1641
  * for the workflow.</p>
@@ -1651,7 +1651,7 @@ export interface CopyStepDetails {
1651
1651
  * </ul>
1652
1652
  * @public
1653
1653
  */
1654
- SourceFileLocation?: string;
1654
+ SourceFileLocation?: string | undefined;
1655
1655
  }
1656
1656
  /**
1657
1657
  * @public
@@ -1694,7 +1694,7 @@ export interface HomeDirectoryMapEntry {
1694
1694
  * </note>
1695
1695
  * @public
1696
1696
  */
1697
- Type?: MapType;
1697
+ Type?: MapType | undefined;
1698
1698
  }
1699
1699
  /**
1700
1700
  * @public
@@ -1731,7 +1731,7 @@ export interface PosixProfile {
1731
1731
  * <p>The secondary POSIX group IDs used for all EFS operations by this user.</p>
1732
1732
  * @public
1733
1733
  */
1734
- SecondaryGids?: number[];
1734
+ SecondaryGids?: number[] | undefined;
1735
1735
  }
1736
1736
  /**
1737
1737
  * @public
@@ -1745,7 +1745,7 @@ export interface CreateAccessRequest {
1745
1745
  * </note>
1746
1746
  * @public
1747
1747
  */
1748
- HomeDirectory?: string;
1748
+ HomeDirectory?: string | undefined;
1749
1749
  /**
1750
1750
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
1751
1751
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
@@ -1761,7 +1761,7 @@ export interface CreateAccessRequest {
1761
1761
  * </note>
1762
1762
  * @public
1763
1763
  */
1764
- HomeDirectoryType?: HomeDirectoryType;
1764
+ HomeDirectoryType?: HomeDirectoryType | undefined;
1765
1765
  /**
1766
1766
  * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
1767
1767
  * be visible to your user and how you want to make them visible. You must specify the
@@ -1785,7 +1785,7 @@ export interface CreateAccessRequest {
1785
1785
  * </p>
1786
1786
  * @public
1787
1787
  */
1788
- HomeDirectoryMappings?: HomeDirectoryMapEntry[];
1788
+ HomeDirectoryMappings?: HomeDirectoryMapEntry[] | undefined;
1789
1789
  /**
1790
1790
  * <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
1791
1791
  * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>$\{Transfer:UserName\}</code>,
@@ -1802,7 +1802,7 @@ export interface CreateAccessRequest {
1802
1802
  * </note>
1803
1803
  * @public
1804
1804
  */
1805
- Policy?: string;
1805
+ Policy?: string | undefined;
1806
1806
  /**
1807
1807
  * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
1808
1808
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
@@ -1811,7 +1811,7 @@ export interface CreateAccessRequest {
1811
1811
  * transferring files into and out of your Amazon EFS file systems.</p>
1812
1812
  * @public
1813
1813
  */
1814
- PosixProfile?: PosixProfile;
1814
+ PosixProfile?: PosixProfile | undefined;
1815
1815
  /**
1816
1816
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
1817
1817
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
@@ -1897,12 +1897,12 @@ export interface CreateProfileRequest {
1897
1897
  * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
1898
1898
  * @public
1899
1899
  */
1900
- CertificateIds?: string[];
1900
+ CertificateIds?: string[] | undefined;
1901
1901
  /**
1902
1902
  * <p>Key-value pairs that can be used to group and search for AS2 profiles.</p>
1903
1903
  * @public
1904
1904
  */
1905
- Tags?: Tag[];
1905
+ Tags?: Tag[] | undefined;
1906
1906
  }
1907
1907
  /**
1908
1908
  * @public
@@ -1989,7 +1989,7 @@ export interface EndpointDetails {
1989
1989
  * </note>
1990
1990
  * @public
1991
1991
  */
1992
- AddressAllocationIds?: string[];
1992
+ AddressAllocationIds?: string[] | undefined;
1993
1993
  /**
1994
1994
  * <p>A list of subnet IDs that are required to host your server endpoint in your VPC.</p>
1995
1995
  * <note>
@@ -1998,7 +1998,7 @@ export interface EndpointDetails {
1998
1998
  * </note>
1999
1999
  * @public
2000
2000
  */
2001
- SubnetIds?: string[];
2001
+ SubnetIds?: string[] | undefined;
2002
2002
  /**
2003
2003
  * <p>The identifier of the VPC endpoint.</p>
2004
2004
  * <note>
@@ -2009,7 +2009,7 @@ export interface EndpointDetails {
2009
2009
  * </note>
2010
2010
  * @public
2011
2011
  */
2012
- VpcEndpointId?: string;
2012
+ VpcEndpointId?: string | undefined;
2013
2013
  /**
2014
2014
  * <p>The VPC identifier of the VPC in which a server's endpoint will be hosted.</p>
2015
2015
  * <note>
@@ -2018,7 +2018,7 @@ export interface EndpointDetails {
2018
2018
  * </note>
2019
2019
  * @public
2020
2020
  */
2021
- VpcId?: string;
2021
+ VpcId?: string | undefined;
2022
2022
  /**
2023
2023
  * <p>A list of security groups IDs that are available to attach to your server's
2024
2024
  * endpoint.</p>
@@ -2032,7 +2032,7 @@ export interface EndpointDetails {
2032
2032
  * </note>
2033
2033
  * @public
2034
2034
  */
2035
- SecurityGroupIds?: string[];
2035
+ SecurityGroupIds?: string[] | undefined;
2036
2036
  }
2037
2037
  /**
2038
2038
  * @public
@@ -2072,23 +2072,23 @@ export interface IdentityProviderDetails {
2072
2072
  * <p>Provides the location of the service endpoint used to authenticate users.</p>
2073
2073
  * @public
2074
2074
  */
2075
- Url?: string;
2075
+ Url?: string | undefined;
2076
2076
  /**
2077
2077
  * <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
2078
2078
  * account.</p>
2079
2079
  * @public
2080
2080
  */
2081
- InvocationRole?: string;
2081
+ InvocationRole?: string | undefined;
2082
2082
  /**
2083
2083
  * <p>The identifier of the Directory Service directory that you want to use as your identity provider.</p>
2084
2084
  * @public
2085
2085
  */
2086
- DirectoryId?: string;
2086
+ DirectoryId?: string | undefined;
2087
2087
  /**
2088
2088
  * <p>The ARN for a Lambda function to use for the Identity provider.</p>
2089
2089
  * @public
2090
2090
  */
2091
- Function?: string;
2091
+ Function?: string | undefined;
2092
2092
  /**
2093
2093
  * <p>For SFTP-enabled servers, and for custom identity providers <i>only</i>, you
2094
2094
  * can specify whether to authenticate using a password, SSH key pair, or both.</p>
@@ -2114,7 +2114,7 @@ export interface IdentityProviderDetails {
2114
2114
  * </ul>
2115
2115
  * @public
2116
2116
  */
2117
- SftpAuthenticationMethods?: SftpAuthenticationMethods;
2117
+ SftpAuthenticationMethods?: SftpAuthenticationMethods | undefined;
2118
2118
  }
2119
2119
  /**
2120
2120
  * @public
@@ -2189,7 +2189,7 @@ export interface ProtocolDetails {
2189
2189
  * clients, check to see if your client supports the <code>PassiveIp=0.0.0.0</code> response.</p>
2190
2190
  * @public
2191
2191
  */
2192
- PassiveIp?: string;
2192
+ PassiveIp?: string | undefined;
2193
2193
  /**
2194
2194
  * <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
2195
2195
  * key between the control and data connection for an FTPS session. <code>TlsSessionResumptionMode</code> determines whether or not the server resumes recent,
@@ -2220,7 +2220,7 @@ export interface ProtocolDetails {
2220
2220
  * </ul>
2221
2221
  * @public
2222
2222
  */
2223
- TlsSessionResumptionMode?: TlsSessionResumptionMode;
2223
+ TlsSessionResumptionMode?: TlsSessionResumptionMode | undefined;
2224
2224
  /**
2225
2225
  * <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>
2226
2226
  * <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.
@@ -2234,12 +2234,12 @@ export interface ProtocolDetails {
2234
2234
  * </note>
2235
2235
  * @public
2236
2236
  */
2237
- SetStatOption?: SetStatOption;
2237
+ SetStatOption?: SetStatOption | undefined;
2238
2238
  /**
2239
2239
  * <p>Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p>
2240
2240
  * @public
2241
2241
  */
2242
- As2Transports?: As2Transport[];
2242
+ As2Transports?: As2Transport[] | undefined;
2243
2243
  }
2244
2244
  /**
2245
2245
  * @public
@@ -2278,7 +2278,7 @@ export interface S3StorageOptions {
2278
2278
  * <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
2279
2279
  * @public
2280
2280
  */
2281
- DirectoryListingOptimization?: DirectoryListingOptimization;
2281
+ DirectoryListingOptimization?: DirectoryListingOptimization | undefined;
2282
2282
  }
2283
2283
  /**
2284
2284
  * <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
@@ -2318,7 +2318,7 @@ export interface WorkflowDetails {
2318
2318
  * </note>
2319
2319
  * @public
2320
2320
  */
2321
- OnUpload?: WorkflowDetail[];
2321
+ OnUpload?: WorkflowDetail[] | undefined;
2322
2322
  /**
2323
2323
  * <p>A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server
2324
2324
  * that executes whenever there is a partial upload.</p>
@@ -2329,7 +2329,7 @@ export interface WorkflowDetails {
2329
2329
  * </note>
2330
2330
  * @public
2331
2331
  */
2332
- OnPartialUpload?: WorkflowDetail[];
2332
+ OnPartialUpload?: WorkflowDetail[] | undefined;
2333
2333
  }
2334
2334
  /**
2335
2335
  * @public
@@ -2370,7 +2370,7 @@ export interface CreateServerRequest {
2370
2370
  * </note>
2371
2371
  * @public
2372
2372
  */
2373
- Certificate?: string;
2373
+ Certificate?: string | undefined;
2374
2374
  /**
2375
2375
  * <p>The domain of the storage system that is used for file transfers. There are two domains
2376
2376
  * available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The
@@ -2380,7 +2380,7 @@ export interface CreateServerRequest {
2380
2380
  * </note>
2381
2381
  * @public
2382
2382
  */
2383
- Domain?: Domain;
2383
+ Domain?: Domain | undefined;
2384
2384
  /**
2385
2385
  * <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
2386
2386
  * When you host your endpoint within your VPC, you can make your endpoint accessible only to resources
@@ -2389,7 +2389,7 @@ export interface CreateServerRequest {
2389
2389
  * endpoint.</p>
2390
2390
  * @public
2391
2391
  */
2392
- EndpointDetails?: EndpointDetails;
2392
+ EndpointDetails?: EndpointDetails | undefined;
2393
2393
  /**
2394
2394
  * <p>The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)
2395
2395
  * or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and
@@ -2411,7 +2411,7 @@ export interface CreateServerRequest {
2411
2411
  * </note>
2412
2412
  * @public
2413
2413
  */
2414
- EndpointType?: EndpointType;
2414
+ EndpointType?: EndpointType | undefined;
2415
2415
  /**
2416
2416
  * <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
2417
2417
  * to rotate keys, or have a set of active keys that use different algorithms.</p>
@@ -2435,7 +2435,7 @@ export interface CreateServerRequest {
2435
2435
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Manage host keys for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>
2436
2436
  * @public
2437
2437
  */
2438
- HostKey?: string;
2438
+ HostKey?: string | undefined;
2439
2439
  /**
2440
2440
  * <p>Required when <code>IdentityProviderType</code> is set to
2441
2441
  * <code>AWS_DIRECTORY_SERVICE</code>, <code>Amazon Web Services_LAMBDA</code> or <code>API_GATEWAY</code>. Accepts an array containing
@@ -2444,7 +2444,7 @@ export interface CreateServerRequest {
2444
2444
  * when <code>IdentityProviderType</code> is set to <code>SERVICE_MANAGED</code>.</p>
2445
2445
  * @public
2446
2446
  */
2447
- IdentityProviderDetails?: IdentityProviderDetails;
2447
+ IdentityProviderDetails?: IdentityProviderDetails | undefined;
2448
2448
  /**
2449
2449
  * <p>The mode of authentication for a server. The default value is
2450
2450
  * <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
@@ -2461,14 +2461,14 @@ export interface CreateServerRequest {
2461
2461
  * for the <code>IdentityProviderDetails</code> data type.</p>
2462
2462
  * @public
2463
2463
  */
2464
- IdentityProviderType?: IdentityProviderType;
2464
+ IdentityProviderType?: IdentityProviderType | undefined;
2465
2465
  /**
2466
2466
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
2467
2467
  * on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
2468
2468
  * your CloudWatch logs.</p>
2469
2469
  * @public
2470
2470
  */
2471
- LoggingRole?: string;
2471
+ LoggingRole?: string | undefined;
2472
2472
  /**
2473
2473
  * <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p>
2474
2474
  * <note>
@@ -2476,7 +2476,7 @@ export interface CreateServerRequest {
2476
2476
  * </note>
2477
2477
  * @public
2478
2478
  */
2479
- PostAuthenticationLoginBanner?: string;
2479
+ PostAuthenticationLoginBanner?: string | undefined;
2480
2480
  /**
2481
2481
  * <p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.
2482
2482
  * For example, the following banner displays details about using the system:</p>
@@ -2487,7 +2487,7 @@ export interface CreateServerRequest {
2487
2487
  * </p>
2488
2488
  * @public
2489
2489
  */
2490
- PreAuthenticationLoginBanner?: string;
2490
+ PreAuthenticationLoginBanner?: string | undefined;
2491
2491
  /**
2492
2492
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
2493
2493
  * client can connect to your server's endpoint. The available protocols are:</p>
@@ -2540,7 +2540,7 @@ export interface CreateServerRequest {
2540
2540
  * </note>
2541
2541
  * @public
2542
2542
  */
2543
- Protocols?: Protocol[];
2543
+ Protocols?: Protocol[] | undefined;
2544
2544
  /**
2545
2545
  * <p>The protocol settings that are configured for your server.</p>
2546
2546
  * <ul>
@@ -2569,17 +2569,17 @@ export interface CreateServerRequest {
2569
2569
  * </ul>
2570
2570
  * @public
2571
2571
  */
2572
- ProtocolDetails?: ProtocolDetails;
2572
+ ProtocolDetails?: ProtocolDetails | undefined;
2573
2573
  /**
2574
2574
  * <p>Specifies the name of the security policy for the server.</p>
2575
2575
  * @public
2576
2576
  */
2577
- SecurityPolicyName?: string;
2577
+ SecurityPolicyName?: string | undefined;
2578
2578
  /**
2579
2579
  * <p>Key-value pairs that can be used to group and search for servers.</p>
2580
2580
  * @public
2581
2581
  */
2582
- Tags?: Tag[];
2582
+ Tags?: Tag[] | undefined;
2583
2583
  /**
2584
2584
  * <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
2585
2585
  * <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> can also contain a
@@ -2587,7 +2587,7 @@ export interface CreateServerRequest {
2587
2587
  * while the file is still being uploaded.</p>
2588
2588
  * @public
2589
2589
  */
2590
- WorkflowDetails?: WorkflowDetails;
2590
+ WorkflowDetails?: WorkflowDetails | undefined;
2591
2591
  /**
2592
2592
  * <p>Specifies the log groups to which your server logs are sent.</p>
2593
2593
  * <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>
@@ -2603,14 +2603,14 @@ export interface CreateServerRequest {
2603
2603
  * </p>
2604
2604
  * @public
2605
2605
  */
2606
- StructuredLogDestinations?: string[];
2606
+ StructuredLogDestinations?: string[] | undefined;
2607
2607
  /**
2608
2608
  * <p>Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.</p>
2609
2609
  * <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code>
2610
2610
  * <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
2611
2611
  * @public
2612
2612
  */
2613
- S3StorageOptions?: S3StorageOptions;
2613
+ S3StorageOptions?: S3StorageOptions | undefined;
2614
2614
  }
2615
2615
  /**
2616
2616
  * @public
@@ -2634,7 +2634,7 @@ export interface CreateUserRequest {
2634
2634
  * </note>
2635
2635
  * @public
2636
2636
  */
2637
- HomeDirectory?: string;
2637
+ HomeDirectory?: string | undefined;
2638
2638
  /**
2639
2639
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
2640
2640
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
@@ -2650,7 +2650,7 @@ export interface CreateUserRequest {
2650
2650
  * </note>
2651
2651
  * @public
2652
2652
  */
2653
- HomeDirectoryType?: HomeDirectoryType;
2653
+ HomeDirectoryType?: HomeDirectoryType | undefined;
2654
2654
  /**
2655
2655
  * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
2656
2656
  * be visible to your user and how you want to make them visible. You must specify the
@@ -2675,7 +2675,7 @@ export interface CreateUserRequest {
2675
2675
  * </p>
2676
2676
  * @public
2677
2677
  */
2678
- HomeDirectoryMappings?: HomeDirectoryMapEntry[];
2678
+ HomeDirectoryMappings?: HomeDirectoryMapEntry[] | undefined;
2679
2679
  /**
2680
2680
  * <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
2681
2681
  * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>$\{Transfer:UserName\}</code>,
@@ -2692,7 +2692,7 @@ export interface CreateUserRequest {
2692
2692
  * </note>
2693
2693
  * @public
2694
2694
  */
2695
- Policy?: string;
2695
+ Policy?: string | undefined;
2696
2696
  /**
2697
2697
  * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID
2698
2698
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
@@ -2701,7 +2701,7 @@ export interface CreateUserRequest {
2701
2701
  * transferring files into and out of your Amazon EFS file systems.</p>
2702
2702
  * @public
2703
2703
  */
2704
- PosixProfile?: PosixProfile;
2704
+ PosixProfile?: PosixProfile | undefined;
2705
2705
  /**
2706
2706
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
2707
2707
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
@@ -2738,13 +2738,13 @@ export interface CreateUserRequest {
2738
2738
  * </ul>
2739
2739
  * @public
2740
2740
  */
2741
- SshPublicKeyBody?: string;
2741
+ SshPublicKeyBody?: string | undefined;
2742
2742
  /**
2743
2743
  * <p>Key-value pairs that can be used to group and search for users. Tags are metadata attached
2744
2744
  * to users for any purpose.</p>
2745
2745
  * @public
2746
2746
  */
2747
- Tags?: Tag[];
2747
+ Tags?: Tag[] | undefined;
2748
2748
  /**
2749
2749
  * <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
2750
2750
  * long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen
@@ -2778,17 +2778,17 @@ export interface CustomStepDetails {
2778
2778
  * <p>The name of the step, used as an identifier.</p>
2779
2779
  * @public
2780
2780
  */
2781
- Name?: string;
2781
+ Name?: string | undefined;
2782
2782
  /**
2783
2783
  * <p>The ARN for the Lambda function that is being called.</p>
2784
2784
  * @public
2785
2785
  */
2786
- Target?: string;
2786
+ Target?: string | undefined;
2787
2787
  /**
2788
2788
  * <p>Timeout, in seconds, for the step.</p>
2789
2789
  * @public
2790
2790
  */
2791
- TimeoutSeconds?: number;
2791
+ TimeoutSeconds?: number | undefined;
2792
2792
  /**
2793
2793
  * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
2794
2794
  * for the workflow.</p>
@@ -2804,7 +2804,7 @@ export interface CustomStepDetails {
2804
2804
  * </ul>
2805
2805
  * @public
2806
2806
  */
2807
- SourceFileLocation?: string;
2807
+ SourceFileLocation?: string | undefined;
2808
2808
  }
2809
2809
  /**
2810
2810
  * @public
@@ -2826,7 +2826,7 @@ export interface DecryptStepDetails {
2826
2826
  * <p>The name of the step, used as an identifier.</p>
2827
2827
  * @public
2828
2828
  */
2829
- Name?: string;
2829
+ Name?: string | undefined;
2830
2830
  /**
2831
2831
  * <p>The type of encryption used. Currently, this value must be <code>PGP</code>.</p>
2832
2832
  * @public
@@ -2847,7 +2847,7 @@ export interface DecryptStepDetails {
2847
2847
  * </ul>
2848
2848
  * @public
2849
2849
  */
2850
- SourceFileLocation?: string;
2850
+ SourceFileLocation?: string | undefined;
2851
2851
  /**
2852
2852
  * <p>A flag that indicates whether to overwrite an existing file of the same name.
2853
2853
  * The default is <code>FALSE</code>.</p>
@@ -2862,7 +2862,7 @@ export interface DecryptStepDetails {
2862
2862
  * </ul>
2863
2863
  * @public
2864
2864
  */
2865
- OverwriteExisting?: OverwriteExisting;
2865
+ OverwriteExisting?: OverwriteExisting | undefined;
2866
2866
  /**
2867
2867
  * <p>Specifies the location for the file being decrypted. Use <code>$\{Transfer:UserName\}</code> or
2868
2868
  * <code>$\{Transfer:UploadDate\}</code> in this field to parametrize the destination prefix by
@@ -2896,7 +2896,7 @@ export interface DeleteStepDetails {
2896
2896
  * <p>The name of the step, used as an identifier.</p>
2897
2897
  * @public
2898
2898
  */
2899
- Name?: string;
2899
+ Name?: string | undefined;
2900
2900
  /**
2901
2901
  * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
2902
2902
  * for the workflow.</p>
@@ -2912,7 +2912,7 @@ export interface DeleteStepDetails {
2912
2912
  * </ul>
2913
2913
  * @public
2914
2914
  */
2915
- SourceFileLocation?: string;
2915
+ SourceFileLocation?: string | undefined;
2916
2916
  }
2917
2917
  /**
2918
2918
  * <p>Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.</p>
@@ -2940,12 +2940,12 @@ export interface TagStepDetails {
2940
2940
  * <p>The name of the step, used as an identifier.</p>
2941
2941
  * @public
2942
2942
  */
2943
- Name?: string;
2943
+ Name?: string | undefined;
2944
2944
  /**
2945
2945
  * <p>Array that contains from 1 to 10 key/value pairs.</p>
2946
2946
  * @public
2947
2947
  */
2948
- Tags?: S3Tag[];
2948
+ Tags?: S3Tag[] | undefined;
2949
2949
  /**
2950
2950
  * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
2951
2951
  * for the workflow.</p>
@@ -2961,7 +2961,7 @@ export interface TagStepDetails {
2961
2961
  * </ul>
2962
2962
  * @public
2963
2963
  */
2964
- SourceFileLocation?: string;
2964
+ SourceFileLocation?: string | undefined;
2965
2965
  }
2966
2966
  /**
2967
2967
  * @public
@@ -3021,7 +3021,7 @@ export interface WorkflowStep {
3021
3021
  * </ul>
3022
3022
  * @public
3023
3023
  */
3024
- Type?: WorkflowStepType;
3024
+ Type?: WorkflowStepType | undefined;
3025
3025
  /**
3026
3026
  * <p>Details for a step that performs a file copy.</p>
3027
3027
  * <p>
@@ -3041,24 +3041,24 @@ export interface WorkflowStep {
3041
3041
  * </ul>
3042
3042
  * @public
3043
3043
  */
3044
- CopyStepDetails?: CopyStepDetails;
3044
+ CopyStepDetails?: CopyStepDetails | undefined;
3045
3045
  /**
3046
3046
  * <p>Details for a step that invokes an Lambda function.</p>
3047
3047
  * <p>Consists of the Lambda function's name, target, and timeout (in seconds). </p>
3048
3048
  * @public
3049
3049
  */
3050
- CustomStepDetails?: CustomStepDetails;
3050
+ CustomStepDetails?: CustomStepDetails | undefined;
3051
3051
  /**
3052
3052
  * <p>Details for a step that deletes the file.</p>
3053
3053
  * @public
3054
3054
  */
3055
- DeleteStepDetails?: DeleteStepDetails;
3055
+ DeleteStepDetails?: DeleteStepDetails | undefined;
3056
3056
  /**
3057
3057
  * <p>Details for a step that creates one or more tags.</p>
3058
3058
  * <p>You specify one or more tags. Each tag contains a key-value pair.</p>
3059
3059
  * @public
3060
3060
  */
3061
- TagStepDetails?: TagStepDetails;
3061
+ TagStepDetails?: TagStepDetails | undefined;
3062
3062
  /**
3063
3063
  * <p>Details for a step that decrypts an encrypted file.</p>
3064
3064
  * <p>Consists of the following values:</p>
@@ -3083,7 +3083,7 @@ export interface WorkflowStep {
3083
3083
  * </ul>
3084
3084
  * @public
3085
3085
  */
3086
- DecryptStepDetails?: DecryptStepDetails;
3086
+ DecryptStepDetails?: DecryptStepDetails | undefined;
3087
3087
  }
3088
3088
  /**
3089
3089
  * @public
@@ -3093,7 +3093,7 @@ export interface CreateWorkflowRequest {
3093
3093
  * <p>A textual description for the workflow.</p>
3094
3094
  * @public
3095
3095
  */
3096
- Description?: string;
3096
+ Description?: string | undefined;
3097
3097
  /**
3098
3098
  * <p>Specifies the details for the steps that are in the specified workflow.</p>
3099
3099
  * <p>
@@ -3150,13 +3150,13 @@ export interface CreateWorkflowRequest {
3150
3150
  * </note>
3151
3151
  * @public
3152
3152
  */
3153
- OnExceptionSteps?: WorkflowStep[];
3153
+ OnExceptionSteps?: WorkflowStep[] | undefined;
3154
3154
  /**
3155
3155
  * <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached
3156
3156
  * to workflows for any purpose.</p>
3157
3157
  * @public
3158
3158
  */
3159
- Tags?: Tag[];
3159
+ Tags?: Tag[] | undefined;
3160
3160
  }
3161
3161
  /**
3162
3162
  * @public
@@ -3323,7 +3323,7 @@ export interface DescribedAccess {
3323
3323
  * </note>
3324
3324
  * @public
3325
3325
  */
3326
- HomeDirectory?: string;
3326
+ HomeDirectory?: string | undefined;
3327
3327
  /**
3328
3328
  * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
3329
3329
  * be visible to your user and how you want to make them visible. You must specify the
@@ -3339,7 +3339,7 @@ export interface DescribedAccess {
3339
3339
  * <code>HomeDirectory</code> parameter value.</p>
3340
3340
  * @public
3341
3341
  */
3342
- HomeDirectoryMappings?: HomeDirectoryMapEntry[];
3342
+ HomeDirectoryMappings?: HomeDirectoryMapEntry[] | undefined;
3343
3343
  /**
3344
3344
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
3345
3345
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
@@ -3355,14 +3355,14 @@ export interface DescribedAccess {
3355
3355
  * </note>
3356
3356
  * @public
3357
3357
  */
3358
- HomeDirectoryType?: HomeDirectoryType;
3358
+ HomeDirectoryType?: HomeDirectoryType | undefined;
3359
3359
  /**
3360
3360
  * <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
3361
3361
  * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>$\{Transfer:UserName\}</code>,
3362
3362
  * <code>$\{Transfer:HomeDirectory\}</code>, and <code>$\{Transfer:HomeBucket\}</code>.</p>
3363
3363
  * @public
3364
3364
  */
3365
- Policy?: string;
3365
+ Policy?: string | undefined;
3366
3366
  /**
3367
3367
  * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
3368
3368
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
@@ -3371,7 +3371,7 @@ export interface DescribedAccess {
3371
3371
  * transferring files into and out of your Amazon EFS file systems.</p>
3372
3372
  * @public
3373
3373
  */
3374
- PosixProfile?: PosixProfile;
3374
+ PosixProfile?: PosixProfile | undefined;
3375
3375
  /**
3376
3376
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
3377
3377
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
@@ -3379,7 +3379,7 @@ export interface DescribedAccess {
3379
3379
  * relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
3380
3380
  * @public
3381
3381
  */
3382
- Role?: string;
3382
+ Role?: string | undefined;
3383
3383
  /**
3384
3384
  * <p>A unique identifier that is required to identify specific groups within your directory.
3385
3385
  * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
@@ -3393,7 +3393,7 @@ export interface DescribedAccess {
3393
3393
  * You can also include underscores or any of the following characters: =,.@:/-</p>
3394
3394
  * @public
3395
3395
  */
3396
- ExternalId?: string;
3396
+ ExternalId?: string | undefined;
3397
3397
  }
3398
3398
  /**
3399
3399
  * @public
@@ -3419,22 +3419,22 @@ export interface S3FileLocation {
3419
3419
  * <p>Specifies the S3 bucket that contains the file being used.</p>
3420
3420
  * @public
3421
3421
  */
3422
- Bucket?: string;
3422
+ Bucket?: string | undefined;
3423
3423
  /**
3424
3424
  * <p>The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.</p>
3425
3425
  * @public
3426
3426
  */
3427
- Key?: string;
3427
+ Key?: string | undefined;
3428
3428
  /**
3429
3429
  * <p>Specifies the file version.</p>
3430
3430
  * @public
3431
3431
  */
3432
- VersionId?: string;
3432
+ VersionId?: string | undefined;
3433
3433
  /**
3434
3434
  * <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>
3435
3435
  * @public
3436
3436
  */
3437
- Etag?: string;
3437
+ Etag?: string | undefined;
3438
3438
  }
3439
3439
  /**
3440
3440
  * <p>Specifies the Amazon S3 or EFS file details to be used in the step.</p>
@@ -3446,12 +3446,12 @@ export interface FileLocation {
3446
3446
  * forth.</p>
3447
3447
  * @public
3448
3448
  */
3449
- S3FileLocation?: S3FileLocation;
3449
+ S3FileLocation?: S3FileLocation | undefined;
3450
3450
  /**
3451
3451
  * <p>Specifies the Amazon EFS identifier and the path for the file being used.</p>
3452
3452
  * @public
3453
3453
  */
3454
- EfsFileLocation?: EfsFileLocation;
3454
+ EfsFileLocation?: EfsFileLocation | undefined;
3455
3455
  }
3456
3456
  /**
3457
3457
  * <p>Consists of the logging role and the log group name.</p>
@@ -3464,12 +3464,12 @@ export interface LoggingConfiguration {
3464
3464
  * your CloudWatch logs.</p>
3465
3465
  * @public
3466
3466
  */
3467
- LoggingRole?: string;
3467
+ LoggingRole?: string | undefined;
3468
3468
  /**
3469
3469
  * <p>The name of the CloudWatch logging group for the Transfer Family server to which this workflow belongs.</p>
3470
3470
  * @public
3471
3471
  */
3472
- LogGroupName?: string;
3472
+ LogGroupName?: string | undefined;
3473
3473
  }
3474
3474
  /**
3475
3475
  * @public
@@ -3588,18 +3588,18 @@ export interface ExecutionStepResult {
3588
3588
  * </ul>
3589
3589
  * @public
3590
3590
  */
3591
- StepType?: WorkflowStepType;
3591
+ StepType?: WorkflowStepType | undefined;
3592
3592
  /**
3593
3593
  * <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>
3594
3594
  * @public
3595
3595
  */
3596
- Outputs?: string;
3596
+ Outputs?: string | undefined;
3597
3597
  /**
3598
3598
  * <p>Specifies the details for an error, if it occurred during execution of the specified
3599
3599
  * workflow step.</p>
3600
3600
  * @public
3601
3601
  */
3602
- Error?: ExecutionError;
3602
+ Error?: ExecutionError | undefined;
3603
3603
  }
3604
3604
  /**
3605
3605
  * <p>Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.</p>
@@ -3610,12 +3610,12 @@ export interface ExecutionResults {
3610
3610
  * <p>Specifies the details for the steps that are in the specified workflow.</p>
3611
3611
  * @public
3612
3612
  */
3613
- Steps?: ExecutionStepResult[];
3613
+ Steps?: ExecutionStepResult[] | undefined;
3614
3614
  /**
3615
3615
  * <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p>
3616
3616
  * @public
3617
3617
  */
3618
- OnExceptionSteps?: ExecutionStepResult[];
3618
+ OnExceptionSteps?: ExecutionStepResult[] | undefined;
3619
3619
  }
3620
3620
  /**
3621
3621
  * <p>Specifies the user name, server ID, and session ID for a workflow.</p>
@@ -3636,7 +3636,7 @@ export interface UserDetails {
3636
3636
  * <p>The system-assigned unique identifier for a session that corresponds to the workflow.</p>
3637
3637
  * @public
3638
3638
  */
3639
- SessionId?: string;
3639
+ SessionId?: string | undefined;
3640
3640
  }
3641
3641
  /**
3642
3642
  * <p>A container object for the session details that are associated with a workflow.</p>
@@ -3672,29 +3672,29 @@ export interface DescribedExecution {
3672
3672
  * <p>A unique identifier for the execution of a workflow.</p>
3673
3673
  * @public
3674
3674
  */
3675
- ExecutionId?: string;
3675
+ ExecutionId?: string | undefined;
3676
3676
  /**
3677
3677
  * <p>A structure that describes the Amazon S3 or EFS file location.
3678
3678
  * This is the file location when the execution begins: if the file is being copied,
3679
3679
  * this is the initial (as opposed to destination) file location.</p>
3680
3680
  * @public
3681
3681
  */
3682
- InitialFileLocation?: FileLocation;
3682
+ InitialFileLocation?: FileLocation | undefined;
3683
3683
  /**
3684
3684
  * <p>A container object for the session details that are associated with a workflow.</p>
3685
3685
  * @public
3686
3686
  */
3687
- ServiceMetadata?: ServiceMetadata;
3687
+ ServiceMetadata?: ServiceMetadata | undefined;
3688
3688
  /**
3689
3689
  * <p>The IAM role associated with the execution.</p>
3690
3690
  * @public
3691
3691
  */
3692
- ExecutionRole?: string;
3692
+ ExecutionRole?: string | undefined;
3693
3693
  /**
3694
3694
  * <p>The IAM logging role associated with the execution.</p>
3695
3695
  * @public
3696
3696
  */
3697
- LoggingConfiguration?: LoggingConfiguration;
3697
+ LoggingConfiguration?: LoggingConfiguration | undefined;
3698
3698
  /**
3699
3699
  * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
3700
3700
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
@@ -3703,19 +3703,19 @@ export interface DescribedExecution {
3703
3703
  * transferring files into and out of your Amazon EFS file systems.</p>
3704
3704
  * @public
3705
3705
  */
3706
- PosixProfile?: PosixProfile;
3706
+ PosixProfile?: PosixProfile | undefined;
3707
3707
  /**
3708
3708
  * <p>The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
3709
3709
  * </p>
3710
3710
  * @public
3711
3711
  */
3712
- Status?: ExecutionStatus;
3712
+ Status?: ExecutionStatus | undefined;
3713
3713
  /**
3714
3714
  * <p>A structure that describes the execution results. This includes a list of the steps along with the details of each step,
3715
3715
  * error type and message (if any), and the <code>OnExceptionSteps</code> structure.</p>
3716
3716
  * @public
3717
3717
  */
3718
- Results?: ExecutionResults;
3718
+ Results?: ExecutionResults | undefined;
3719
3719
  }
3720
3720
  /**
3721
3721
  * <p>The details for a server host key.</p>
@@ -3731,17 +3731,17 @@ export interface DescribedHostKey {
3731
3731
  * <p>A unique identifier for the host key.</p>
3732
3732
  * @public
3733
3733
  */
3734
- HostKeyId?: string;
3734
+ HostKeyId?: string | undefined;
3735
3735
  /**
3736
3736
  * <p>The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.</p>
3737
3737
  * @public
3738
3738
  */
3739
- HostKeyFingerprint?: string;
3739
+ HostKeyFingerprint?: string | undefined;
3740
3740
  /**
3741
3741
  * <p>The text description for this host key.</p>
3742
3742
  * @public
3743
3743
  */
3744
- Description?: string;
3744
+ Description?: string | undefined;
3745
3745
  /**
3746
3746
  * <p>The encryption algorithm that is used for the host key. The <code>Type</code> parameter is specified by using one of the
3747
3747
  * following values:</p>
@@ -3774,17 +3774,17 @@ export interface DescribedHostKey {
3774
3774
  * </ul>
3775
3775
  * @public
3776
3776
  */
3777
- Type?: string;
3777
+ Type?: string | undefined;
3778
3778
  /**
3779
3779
  * <p>The date on which the host key was added to the server.</p>
3780
3780
  * @public
3781
3781
  */
3782
- DateImported?: Date;
3782
+ DateImported?: Date | undefined;
3783
3783
  /**
3784
3784
  * <p>Key-value pairs that can be used to group and search for host keys.</p>
3785
3785
  * @public
3786
3786
  */
3787
- Tags?: Tag[];
3787
+ Tags?: Tag[] | undefined;
3788
3788
  }
3789
3789
  /**
3790
3790
  * <p>The details for a local or partner AS2 profile. </p>
@@ -3800,13 +3800,13 @@ export interface DescribedProfile {
3800
3800
  * <p>A unique identifier for the local or partner AS2 profile.</p>
3801
3801
  * @public
3802
3802
  */
3803
- ProfileId?: string;
3803
+ ProfileId?: string | undefined;
3804
3804
  /**
3805
3805
  * <p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles.
3806
3806
  * If not supplied in the request, the command lists all types of profiles.</p>
3807
3807
  * @public
3808
3808
  */
3809
- ProfileType?: ProfileType;
3809
+ ProfileType?: ProfileType | undefined;
3810
3810
  /**
3811
3811
  * <p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the
3812
3812
  * <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
@@ -3814,17 +3814,17 @@ export interface DescribedProfile {
3814
3814
  * AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.</p>
3815
3815
  * @public
3816
3816
  */
3817
- As2Id?: string;
3817
+ As2Id?: string | undefined;
3818
3818
  /**
3819
3819
  * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
3820
3820
  * @public
3821
3821
  */
3822
- CertificateIds?: string[];
3822
+ CertificateIds?: string[] | undefined;
3823
3823
  /**
3824
3824
  * <p>Key-value pairs that can be used to group and search for profiles.</p>
3825
3825
  * @public
3826
3826
  */
3827
- Tags?: Tag[];
3827
+ Tags?: Tag[] | undefined;
3828
3828
  }
3829
3829
  /**
3830
3830
  * @public
@@ -3863,7 +3863,7 @@ export interface DescribedSecurityPolicy {
3863
3863
  * This parameter applies to both server and connector security policies.</p>
3864
3864
  * @public
3865
3865
  */
3866
- Fips?: boolean;
3866
+ Fips?: boolean | undefined;
3867
3867
  /**
3868
3868
  * <p>The text name of the specified security policy.</p>
3869
3869
  * @public
@@ -3875,21 +3875,21 @@ export interface DescribedSecurityPolicy {
3875
3875
  * connector security policies.</p>
3876
3876
  * @public
3877
3877
  */
3878
- SshCiphers?: string[];
3878
+ SshCiphers?: string[] | undefined;
3879
3879
  /**
3880
3880
  * <p>Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that
3881
3881
  * is attached to the server or connector. This parameter applies to both server and connector
3882
3882
  * security policies.</p>
3883
3883
  * @public
3884
3884
  */
3885
- SshKexs?: string[];
3885
+ SshKexs?: string[] | undefined;
3886
3886
  /**
3887
3887
  * <p>Lists the enabled SSH message authentication code (MAC) encryption algorithms in the
3888
3888
  * security policy that is attached to the server or connector. This parameter applies to both
3889
3889
  * server and connector security policies.</p>
3890
3890
  * @public
3891
3891
  */
3892
- SshMacs?: string[];
3892
+ SshMacs?: string[] | undefined;
3893
3893
  /**
3894
3894
  * <p>Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the
3895
3895
  * security policy that is attached to the server.</p>
@@ -3898,7 +3898,7 @@ export interface DescribedSecurityPolicy {
3898
3898
  * </note>
3899
3899
  * @public
3900
3900
  */
3901
- TlsCiphers?: string[];
3901
+ TlsCiphers?: string[] | undefined;
3902
3902
  /**
3903
3903
  * <p>Lists the host key algorithms for the security policy.</p>
3904
3904
  * <note>
@@ -3906,17 +3906,17 @@ export interface DescribedSecurityPolicy {
3906
3906
  * </note>
3907
3907
  * @public
3908
3908
  */
3909
- SshHostKeyAlgorithms?: string[];
3909
+ SshHostKeyAlgorithms?: string[] | undefined;
3910
3910
  /**
3911
3911
  * <p>The resource type to which the security policy applies, either server or connector.</p>
3912
3912
  * @public
3913
3913
  */
3914
- Type?: SecurityPolicyResourceType;
3914
+ Type?: SecurityPolicyResourceType | undefined;
3915
3915
  /**
3916
3916
  * <p>Lists the file transfer protocols that the security policy applies to.</p>
3917
3917
  * @public
3918
3918
  */
3919
- Protocols?: SecurityPolicyProtocol[];
3919
+ Protocols?: SecurityPolicyProtocol[] | undefined;
3920
3920
  }
3921
3921
  /**
3922
3922
  * @public
@@ -3950,7 +3950,7 @@ export interface DescribedServer {
3950
3950
  * <code>Protocols</code> is set to <code>FTPS</code>.</p>
3951
3951
  * @public
3952
3952
  */
3953
- Certificate?: string;
3953
+ Certificate?: string | undefined;
3954
3954
  /**
3955
3955
  * <p>The protocol settings that are configured for your server.</p>
3956
3956
  * <ul>
@@ -3979,14 +3979,14 @@ export interface DescribedServer {
3979
3979
  * </ul>
3980
3980
  * @public
3981
3981
  */
3982
- ProtocolDetails?: ProtocolDetails;
3982
+ ProtocolDetails?: ProtocolDetails | undefined;
3983
3983
  /**
3984
3984
  * <p>Specifies the domain of the storage system that is used for file transfers. There are two domains
3985
3985
  * available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The
3986
3986
  * default value is S3.</p>
3987
3987
  * @public
3988
3988
  */
3989
- Domain?: Domain;
3989
+ Domain?: Domain | undefined;
3990
3990
  /**
3991
3991
  * <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
3992
3992
  * When you host your endpoint within your VPC, you can make your endpoint accessible only to resources
@@ -3995,27 +3995,27 @@ export interface DescribedServer {
3995
3995
  * endpoint.</p>
3996
3996
  * @public
3997
3997
  */
3998
- EndpointDetails?: EndpointDetails;
3998
+ EndpointDetails?: EndpointDetails | undefined;
3999
3999
  /**
4000
4000
  * <p>Defines the type of endpoint that your server is connected to. If your server is connected
4001
4001
  * to a VPC endpoint, your server isn't accessible over the public internet.</p>
4002
4002
  * @public
4003
4003
  */
4004
- EndpointType?: EndpointType;
4004
+ EndpointType?: EndpointType | undefined;
4005
4005
  /**
4006
4006
  * <p>Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value
4007
4007
  * is equivalent to the output of the <code>ssh-keygen -l -f my-new-server-key</code>
4008
4008
  * command.</p>
4009
4009
  * @public
4010
4010
  */
4011
- HostKeyFingerprint?: string;
4011
+ HostKeyFingerprint?: string | undefined;
4012
4012
  /**
4013
4013
  * <p>Specifies information to call a customer-supplied authentication API. This field is not
4014
4014
  * populated when the <code>IdentityProviderType</code> of a server is
4015
4015
  * <code>AWS_DIRECTORY_SERVICE</code> or <code>SERVICE_MANAGED</code>.</p>
4016
4016
  * @public
4017
4017
  */
4018
- IdentityProviderDetails?: IdentityProviderDetails;
4018
+ IdentityProviderDetails?: IdentityProviderDetails | undefined;
4019
4019
  /**
4020
4020
  * <p>The mode of authentication for a server. The default value is
4021
4021
  * <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
@@ -4032,14 +4032,14 @@ export interface DescribedServer {
4032
4032
  * for the <code>IdentityProviderDetails</code> data type.</p>
4033
4033
  * @public
4034
4034
  */
4035
- IdentityProviderType?: IdentityProviderType;
4035
+ IdentityProviderType?: IdentityProviderType | undefined;
4036
4036
  /**
4037
4037
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
4038
4038
  * on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
4039
4039
  * your CloudWatch logs.</p>
4040
4040
  * @public
4041
4041
  */
4042
- LoggingRole?: string;
4042
+ LoggingRole?: string | undefined;
4043
4043
  /**
4044
4044
  * <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p>
4045
4045
  * <note>
@@ -4047,7 +4047,7 @@ export interface DescribedServer {
4047
4047
  * </note>
4048
4048
  * @public
4049
4049
  */
4050
- PostAuthenticationLoginBanner?: string;
4050
+ PostAuthenticationLoginBanner?: string | undefined;
4051
4051
  /**
4052
4052
  * <p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.
4053
4053
  * For example, the following banner displays details about using the system:</p>
@@ -4058,7 +4058,7 @@ export interface DescribedServer {
4058
4058
  * </p>
4059
4059
  * @public
4060
4060
  */
4061
- PreAuthenticationLoginBanner?: string;
4061
+ PreAuthenticationLoginBanner?: string | undefined;
4062
4062
  /**
4063
4063
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
4064
4064
  * client can connect to your server's endpoint. The available protocols are:</p>
@@ -4111,17 +4111,17 @@ export interface DescribedServer {
4111
4111
  * </note>
4112
4112
  * @public
4113
4113
  */
4114
- Protocols?: Protocol[];
4114
+ Protocols?: Protocol[] | undefined;
4115
4115
  /**
4116
4116
  * <p>Specifies the name of the security policy for the server.</p>
4117
4117
  * @public
4118
4118
  */
4119
- SecurityPolicyName?: string;
4119
+ SecurityPolicyName?: string | undefined;
4120
4120
  /**
4121
4121
  * <p>Specifies the unique system-assigned identifier for a server that you instantiate.</p>
4122
4122
  * @public
4123
4123
  */
4124
- ServerId?: string;
4124
+ ServerId?: string | undefined;
4125
4125
  /**
4126
4126
  * <p>The condition of the server that was described. A value of
4127
4127
  * <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A
@@ -4133,19 +4133,19 @@ export interface DescribedServer {
4133
4133
  * condition.</p>
4134
4134
  * @public
4135
4135
  */
4136
- State?: State;
4136
+ State?: State | undefined;
4137
4137
  /**
4138
4138
  * <p>Specifies the key-value pairs that you can use to search for and group servers that were
4139
4139
  * assigned to the server that was described.</p>
4140
4140
  * @public
4141
4141
  */
4142
- Tags?: Tag[];
4142
+ Tags?: Tag[] | undefined;
4143
4143
  /**
4144
4144
  * <p>Specifies the number of users that are assigned to a server you specified with the
4145
4145
  * <code>ServerId</code>.</p>
4146
4146
  * @public
4147
4147
  */
4148
- UserCount?: number;
4148
+ UserCount?: number | undefined;
4149
4149
  /**
4150
4150
  * <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
4151
4151
  * <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> can also contain a
@@ -4153,7 +4153,7 @@ export interface DescribedServer {
4153
4153
  * while the file is still being uploaded.</p>
4154
4154
  * @public
4155
4155
  */
4156
- WorkflowDetails?: WorkflowDetails;
4156
+ WorkflowDetails?: WorkflowDetails | undefined;
4157
4157
  /**
4158
4158
  * <p>Specifies the log groups to which your server logs are sent.</p>
4159
4159
  * <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>
@@ -4169,14 +4169,14 @@ export interface DescribedServer {
4169
4169
  * </p>
4170
4170
  * @public
4171
4171
  */
4172
- StructuredLogDestinations?: string[];
4172
+ StructuredLogDestinations?: string[] | undefined;
4173
4173
  /**
4174
4174
  * <p>Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.</p>
4175
4175
  * <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code>
4176
4176
  * <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
4177
4177
  * @public
4178
4178
  */
4179
- S3StorageOptions?: S3StorageOptions;
4179
+ S3StorageOptions?: S3StorageOptions | undefined;
4180
4180
  /**
4181
4181
  * <p>The list of egress IP addresses of this server. These IP addresses are only relevant
4182
4182
  * for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.</p>
@@ -4184,7 +4184,7 @@ export interface DescribedServer {
4184
4184
  * if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.</p>
4185
4185
  * @public
4186
4186
  */
4187
- As2ServiceManagedEgressIpAddresses?: string[];
4187
+ As2ServiceManagedEgressIpAddresses?: string[] | undefined;
4188
4188
  }
4189
4189
  /**
4190
4190
  * <p>Provides information about the public Secure Shell (SSH) key that is associated with a Transfer Family
@@ -4233,7 +4233,7 @@ export interface DescribedUser {
4233
4233
  * </note>
4234
4234
  * @public
4235
4235
  */
4236
- HomeDirectory?: string;
4236
+ HomeDirectory?: string | undefined;
4237
4237
  /**
4238
4238
  * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
4239
4239
  * be visible to your user and how you want to make them visible. You must specify the
@@ -4249,7 +4249,7 @@ export interface DescribedUser {
4249
4249
  * parameter value.</p>
4250
4250
  * @public
4251
4251
  */
4252
- HomeDirectoryMappings?: HomeDirectoryMapEntry[];
4252
+ HomeDirectoryMappings?: HomeDirectoryMapEntry[] | undefined;
4253
4253
  /**
4254
4254
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
4255
4255
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
@@ -4265,14 +4265,14 @@ export interface DescribedUser {
4265
4265
  * </note>
4266
4266
  * @public
4267
4267
  */
4268
- HomeDirectoryType?: HomeDirectoryType;
4268
+ HomeDirectoryType?: HomeDirectoryType | undefined;
4269
4269
  /**
4270
4270
  * <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
4271
4271
  * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>$\{Transfer:UserName\}</code>,
4272
4272
  * <code>$\{Transfer:HomeDirectory\}</code>, and <code>$\{Transfer:HomeBucket\}</code>.</p>
4273
4273
  * @public
4274
4274
  */
4275
- Policy?: string;
4275
+ Policy?: string | undefined;
4276
4276
  /**
4277
4277
  * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID
4278
4278
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
@@ -4282,7 +4282,7 @@ export interface DescribedUser {
4282
4282
  * systems.</p>
4283
4283
  * @public
4284
4284
  */
4285
- PosixProfile?: PosixProfile;
4285
+ PosixProfile?: PosixProfile | undefined;
4286
4286
  /**
4287
4287
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
4288
4288
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
@@ -4290,26 +4290,26 @@ export interface DescribedUser {
4290
4290
  * relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
4291
4291
  * @public
4292
4292
  */
4293
- Role?: string;
4293
+ Role?: string | undefined;
4294
4294
  /**
4295
4295
  * <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for the described
4296
4296
  * user.</p>
4297
4297
  * @public
4298
4298
  */
4299
- SshPublicKeys?: SshPublicKey[];
4299
+ SshPublicKeys?: SshPublicKey[] | undefined;
4300
4300
  /**
4301
4301
  * <p>Specifies the key-value pairs for the user requested. Tag can be used to search for and
4302
4302
  * group users for a variety of purposes.</p>
4303
4303
  * @public
4304
4304
  */
4305
- Tags?: Tag[];
4305
+ Tags?: Tag[] | undefined;
4306
4306
  /**
4307
4307
  * <p>Specifies the name of the user that was requested to be described. User names are used for
4308
4308
  * authentication purposes. This is the string that will be used by your user when they log in to
4309
4309
  * your server.</p>
4310
4310
  * @public
4311
4311
  */
4312
- UserName?: string;
4312
+ UserName?: string | undefined;
4313
4313
  }
4314
4314
  /**
4315
4315
  * <p>Describes the properties of the specified workflow</p>
@@ -4325,27 +4325,27 @@ export interface DescribedWorkflow {
4325
4325
  * <p>Specifies the text description for the workflow.</p>
4326
4326
  * @public
4327
4327
  */
4328
- Description?: string;
4328
+ Description?: string | undefined;
4329
4329
  /**
4330
4330
  * <p>Specifies the details for the steps that are in the specified workflow.</p>
4331
4331
  * @public
4332
4332
  */
4333
- Steps?: WorkflowStep[];
4333
+ Steps?: WorkflowStep[] | undefined;
4334
4334
  /**
4335
4335
  * <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p>
4336
4336
  * @public
4337
4337
  */
4338
- OnExceptionSteps?: WorkflowStep[];
4338
+ OnExceptionSteps?: WorkflowStep[] | undefined;
4339
4339
  /**
4340
4340
  * <p>A unique identifier for the workflow.</p>
4341
4341
  * @public
4342
4342
  */
4343
- WorkflowId?: string;
4343
+ WorkflowId?: string | undefined;
4344
4344
  /**
4345
4345
  * <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</p>
4346
4346
  * @public
4347
4347
  */
4348
- Tags?: Tag[];
4348
+ Tags?: Tag[] | undefined;
4349
4349
  }
4350
4350
  /**
4351
4351
  * @public
@@ -4534,12 +4534,12 @@ export interface ImportHostKeyRequest {
4534
4534
  * <p>The text description that identifies this host key.</p>
4535
4535
  * @public
4536
4536
  */
4537
- Description?: string;
4537
+ Description?: string | undefined;
4538
4538
  /**
4539
4539
  * <p>Key-value pairs that can be used to group and search for host keys.</p>
4540
4540
  * @public
4541
4541
  */
4542
- Tags?: Tag[];
4542
+ Tags?: Tag[] | undefined;
4543
4543
  }
4544
4544
  /**
4545
4545
  * @public
@@ -4608,7 +4608,7 @@ export interface ListAccessesRequest {
4608
4608
  * <p>Specifies the maximum number of access SIDs to return.</p>
4609
4609
  * @public
4610
4610
  */
4611
- MaxResults?: number;
4611
+ MaxResults?: number | undefined;
4612
4612
  /**
4613
4613
  * <p>When you can get additional results from the <code>ListAccesses</code> call, a
4614
4614
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
@@ -4616,7 +4616,7 @@ export interface ListAccessesRequest {
4616
4616
  * accesses.</p>
4617
4617
  * @public
4618
4618
  */
4619
- NextToken?: string;
4619
+ NextToken?: string | undefined;
4620
4620
  /**
4621
4621
  * <p>A system-assigned unique identifier for a server that has users assigned to it.</p>
4622
4622
  * @public
@@ -4636,7 +4636,7 @@ export interface ListedAccess {
4636
4636
  * </note>
4637
4637
  * @public
4638
4638
  */
4639
- HomeDirectory?: string;
4639
+ HomeDirectory?: string | undefined;
4640
4640
  /**
4641
4641
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
4642
4642
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
@@ -4652,7 +4652,7 @@ export interface ListedAccess {
4652
4652
  * </note>
4653
4653
  * @public
4654
4654
  */
4655
- HomeDirectoryType?: HomeDirectoryType;
4655
+ HomeDirectoryType?: HomeDirectoryType | undefined;
4656
4656
  /**
4657
4657
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
4658
4658
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
@@ -4660,7 +4660,7 @@ export interface ListedAccess {
4660
4660
  * relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
4661
4661
  * @public
4662
4662
  */
4663
- Role?: string;
4663
+ Role?: string | undefined;
4664
4664
  /**
4665
4665
  * <p>A unique identifier that is required to identify specific groups within your directory.
4666
4666
  * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
@@ -4674,7 +4674,7 @@ export interface ListedAccess {
4674
4674
  * You can also include underscores or any of the following characters: =,.@:/-</p>
4675
4675
  * @public
4676
4676
  */
4677
- ExternalId?: string;
4677
+ ExternalId?: string | undefined;
4678
4678
  }
4679
4679
  /**
4680
4680
  * @public
@@ -4687,7 +4687,7 @@ export interface ListAccessesResponse {
4687
4687
  * accesses.</p>
4688
4688
  * @public
4689
4689
  */
4690
- NextToken?: string;
4690
+ NextToken?: string | undefined;
4691
4691
  /**
4692
4692
  * <p>A system-assigned unique identifier for a server that has users assigned to it.</p>
4693
4693
  * @public
@@ -4709,24 +4709,24 @@ export interface ListedExecution {
4709
4709
  * <p>A unique identifier for the execution of a workflow.</p>
4710
4710
  * @public
4711
4711
  */
4712
- ExecutionId?: string;
4712
+ ExecutionId?: string | undefined;
4713
4713
  /**
4714
4714
  * <p>A structure that describes the Amazon S3 or EFS file location.
4715
4715
  * This is the file location when the execution begins: if the file is being copied,
4716
4716
  * this is the initial (as opposed to destination) file location.</p>
4717
4717
  * @public
4718
4718
  */
4719
- InitialFileLocation?: FileLocation;
4719
+ InitialFileLocation?: FileLocation | undefined;
4720
4720
  /**
4721
4721
  * <p>A container object for the session details that are associated with a workflow.</p>
4722
4722
  * @public
4723
4723
  */
4724
- ServiceMetadata?: ServiceMetadata;
4724
+ ServiceMetadata?: ServiceMetadata | undefined;
4725
4725
  /**
4726
4726
  * <p>The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.</p>
4727
4727
  * @public
4728
4728
  */
4729
- Status?: ExecutionStatus;
4729
+ Status?: ExecutionStatus | undefined;
4730
4730
  }
4731
4731
  /**
4732
4732
  * <p>Returns properties of the host key that's specified.</p>
@@ -4742,17 +4742,17 @@ export interface ListedHostKey {
4742
4742
  * <p>A unique identifier for the host key.</p>
4743
4743
  * @public
4744
4744
  */
4745
- HostKeyId?: string;
4745
+ HostKeyId?: string | undefined;
4746
4746
  /**
4747
4747
  * <p>The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.</p>
4748
4748
  * @public
4749
4749
  */
4750
- Fingerprint?: string;
4750
+ Fingerprint?: string | undefined;
4751
4751
  /**
4752
4752
  * <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>
4753
4753
  * @public
4754
4754
  */
4755
- Description?: string;
4755
+ Description?: string | undefined;
4756
4756
  /**
4757
4757
  * <p>The encryption algorithm that is used for the host key. The <code>Type</code> parameter is specified by using one of the
4758
4758
  * following values:</p>
@@ -4785,12 +4785,12 @@ export interface ListedHostKey {
4785
4785
  * </ul>
4786
4786
  * @public
4787
4787
  */
4788
- Type?: string;
4788
+ Type?: string | undefined;
4789
4789
  /**
4790
4790
  * <p>The date on which the host key was added to the server.</p>
4791
4791
  * @public
4792
4792
  */
4793
- DateImported?: Date;
4793
+ DateImported?: Date | undefined;
4794
4794
  }
4795
4795
  /**
4796
4796
  * <p>Returns the properties of the profile that was specified.</p>
@@ -4801,12 +4801,12 @@ export interface ListedProfile {
4801
4801
  * <p>The Amazon Resource Name (ARN) of the specified profile.</p>
4802
4802
  * @public
4803
4803
  */
4804
- Arn?: string;
4804
+ Arn?: string | undefined;
4805
4805
  /**
4806
4806
  * <p>A unique identifier for the local or partner AS2 profile.</p>
4807
4807
  * @public
4808
4808
  */
4809
- ProfileId?: string;
4809
+ ProfileId?: string | undefined;
4810
4810
  /**
4811
4811
  * <p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the
4812
4812
  * <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
@@ -4814,13 +4814,13 @@ export interface ListedProfile {
4814
4814
  * AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.</p>
4815
4815
  * @public
4816
4816
  */
4817
- As2Id?: string;
4817
+ As2Id?: string | undefined;
4818
4818
  /**
4819
4819
  * <p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles.
4820
4820
  * If not supplied in the request, the command lists all types of profiles.</p>
4821
4821
  * @public
4822
4822
  */
4823
- ProfileType?: ProfileType;
4823
+ ProfileType?: ProfileType | undefined;
4824
4824
  }
4825
4825
  /**
4826
4826
  * <p>Returns properties of a file transfer protocol-enabled server that was specified.</p>
@@ -4838,7 +4838,7 @@ export interface ListedServer {
4838
4838
  * default value is S3.</p>
4839
4839
  * @public
4840
4840
  */
4841
- Domain?: Domain;
4841
+ Domain?: Domain | undefined;
4842
4842
  /**
4843
4843
  * <p>The mode of authentication for a server. The default value is
4844
4844
  * <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
@@ -4855,25 +4855,25 @@ export interface ListedServer {
4855
4855
  * for the <code>IdentityProviderDetails</code> data type.</p>
4856
4856
  * @public
4857
4857
  */
4858
- IdentityProviderType?: IdentityProviderType;
4858
+ IdentityProviderType?: IdentityProviderType | undefined;
4859
4859
  /**
4860
4860
  * <p>Specifies the type of VPC endpoint that your server is connected to. If your server is
4861
4861
  * connected to a VPC endpoint, your server isn't accessible over the public internet.</p>
4862
4862
  * @public
4863
4863
  */
4864
- EndpointType?: EndpointType;
4864
+ EndpointType?: EndpointType | undefined;
4865
4865
  /**
4866
4866
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
4867
4867
  * on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
4868
4868
  * your CloudWatch logs.</p>
4869
4869
  * @public
4870
4870
  */
4871
- LoggingRole?: string;
4871
+ LoggingRole?: string | undefined;
4872
4872
  /**
4873
4873
  * <p>Specifies the unique system assigned identifier for the servers that were listed.</p>
4874
4874
  * @public
4875
4875
  */
4876
- ServerId?: string;
4876
+ ServerId?: string | undefined;
4877
4877
  /**
4878
4878
  * <p>The condition of the server that was described. A value of
4879
4879
  * <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A
@@ -4885,13 +4885,13 @@ export interface ListedServer {
4885
4885
  * condition.</p>
4886
4886
  * @public
4887
4887
  */
4888
- State?: State;
4888
+ State?: State | undefined;
4889
4889
  /**
4890
4890
  * <p>Specifies the number of users that are assigned to a server you specified with the
4891
4891
  * <code>ServerId</code>.</p>
4892
4892
  * @public
4893
4893
  */
4894
- UserCount?: number;
4894
+ UserCount?: number | undefined;
4895
4895
  }
4896
4896
  /**
4897
4897
  * <p>Returns properties of the user that you specify.</p>
@@ -4912,7 +4912,7 @@ export interface ListedUser {
4912
4912
  * </note>
4913
4913
  * @public
4914
4914
  */
4915
- HomeDirectory?: string;
4915
+ HomeDirectory?: string | undefined;
4916
4916
  /**
4917
4917
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
4918
4918
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
@@ -4928,7 +4928,7 @@ export interface ListedUser {
4928
4928
  * </note>
4929
4929
  * @public
4930
4930
  */
4931
- HomeDirectoryType?: HomeDirectoryType;
4931
+ HomeDirectoryType?: HomeDirectoryType | undefined;
4932
4932
  /**
4933
4933
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
4934
4934
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
@@ -4942,18 +4942,18 @@ export interface ListedUser {
4942
4942
  * </note>
4943
4943
  * @public
4944
4944
  */
4945
- Role?: string;
4945
+ Role?: string | undefined;
4946
4946
  /**
4947
4947
  * <p>Specifies the number of SSH public keys stored for the user you specified.</p>
4948
4948
  * @public
4949
4949
  */
4950
- SshPublicKeyCount?: number;
4950
+ SshPublicKeyCount?: number | undefined;
4951
4951
  /**
4952
4952
  * <p>Specifies the name of the user whose ARN was specified. User names are used for
4953
4953
  * authentication purposes.</p>
4954
4954
  * @public
4955
4955
  */
4956
- UserName?: string;
4956
+ UserName?: string | undefined;
4957
4957
  }
4958
4958
  /**
4959
4959
  * <p>Contains the identifier, text description, and Amazon Resource Name (ARN) for the
@@ -4965,17 +4965,17 @@ export interface ListedWorkflow {
4965
4965
  * <p>A unique identifier for the workflow.</p>
4966
4966
  * @public
4967
4967
  */
4968
- WorkflowId?: string;
4968
+ WorkflowId?: string | undefined;
4969
4969
  /**
4970
4970
  * <p>Specifies the text description for the workflow.</p>
4971
4971
  * @public
4972
4972
  */
4973
- Description?: string;
4973
+ Description?: string | undefined;
4974
4974
  /**
4975
4975
  * <p>Specifies the unique Amazon Resource Name (ARN) for the workflow.</p>
4976
4976
  * @public
4977
4977
  */
4978
- Arn?: string;
4978
+ Arn?: string | undefined;
4979
4979
  }
4980
4980
  /**
4981
4981
  * @public
@@ -4985,7 +4985,7 @@ export interface ListExecutionsRequest {
4985
4985
  * <p>Specifies the maximum number of executions to return.</p>
4986
4986
  * @public
4987
4987
  */
4988
- MaxResults?: number;
4988
+ MaxResults?: number | undefined;
4989
4989
  /**
4990
4990
  * <p>
4991
4991
  * <code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output.
@@ -5011,7 +5011,7 @@ export interface ListExecutionsRequest {
5011
5011
  * </p>
5012
5012
  * @public
5013
5013
  */
5014
- NextToken?: string;
5014
+ NextToken?: string | undefined;
5015
5015
  /**
5016
5016
  * <p>A unique identifier for the workflow.</p>
5017
5017
  * @public
@@ -5029,7 +5029,7 @@ export interface ListExecutionsResponse {
5029
5029
  * continue listing additional executions.</p>
5030
5030
  * @public
5031
5031
  */
5032
- NextToken?: string;
5032
+ NextToken?: string | undefined;
5033
5033
  /**
5034
5034
  * <p>A unique identifier for the workflow.</p>
5035
5035
  * @public
@@ -5059,7 +5059,7 @@ export interface ListFileTransferResultsRequest {
5059
5059
  * <p>If there are more file details than returned in this call, use this value for a subsequent call to <code>ListFileTransferResults</code> to retrieve them.</p>
5060
5060
  * @public
5061
5061
  */
5062
- NextToken?: string;
5062
+ NextToken?: string | undefined;
5063
5063
  /**
5064
5064
  * <p>The maximum number of files to return in a single page. Note that currently you can specify a maximum of 10 file paths in a single
5065
5065
  * <a href="https://docs.aws.amazon.com/transfer/latest/APIReference/API_StartFileTransfer.html">StartFileTransfer</a> operation. Thus, the maximum
@@ -5067,7 +5067,7 @@ export interface ListFileTransferResultsRequest {
5067
5067
  * </p>
5068
5068
  * @public
5069
5069
  */
5070
- MaxResults?: number;
5070
+ MaxResults?: number | undefined;
5071
5071
  }
5072
5072
  /**
5073
5073
  * @public
@@ -5104,7 +5104,7 @@ export interface ListFileTransferResultsResponse {
5104
5104
  * additional results, if there are any (against the same <code>TransferId</code>.</p>
5105
5105
  * @public
5106
5106
  */
5107
- NextToken?: string;
5107
+ NextToken?: string | undefined;
5108
5108
  }
5109
5109
  /**
5110
5110
  * @public
@@ -5114,14 +5114,14 @@ export interface ListHostKeysRequest {
5114
5114
  * <p>The maximum number of host keys to return.</p>
5115
5115
  * @public
5116
5116
  */
5117
- MaxResults?: number;
5117
+ MaxResults?: number | undefined;
5118
5118
  /**
5119
5119
  * <p>When there are additional results that were not returned, a <code>NextToken</code>
5120
5120
  * parameter is returned. You can use that value for a subsequent call to
5121
5121
  * <code>ListHostKeys</code> to continue listing results.</p>
5122
5122
  * @public
5123
5123
  */
5124
- NextToken?: string;
5124
+ NextToken?: string | undefined;
5125
5125
  /**
5126
5126
  * <p>The identifier of the server that contains the host keys that you want to view.</p>
5127
5127
  * @public
@@ -5137,7 +5137,7 @@ export interface ListHostKeysResponse {
5137
5137
  * additional results, if there are any.</p>
5138
5138
  * @public
5139
5139
  */
5140
- NextToken?: string;
5140
+ NextToken?: string | undefined;
5141
5141
  /**
5142
5142
  * <p>Returns the server identifier that contains the listed host keys.</p>
5143
5143
  * @public
@@ -5157,20 +5157,20 @@ export interface ListProfilesRequest {
5157
5157
  * <p>The maximum number of profiles to return.</p>
5158
5158
  * @public
5159
5159
  */
5160
- MaxResults?: number;
5160
+ MaxResults?: number | undefined;
5161
5161
  /**
5162
5162
  * <p>When there are additional results that were not returned, a <code>NextToken</code>
5163
5163
  * parameter is returned. You can use that value for a subsequent call to
5164
5164
  * <code>ListProfiles</code> to continue listing results.</p>
5165
5165
  * @public
5166
5166
  */
5167
- NextToken?: string;
5167
+ NextToken?: string | undefined;
5168
5168
  /**
5169
5169
  * <p>Indicates whether to list only <code>LOCAL</code> type profiles or only <code>PARTNER</code> type profiles.
5170
5170
  * If not supplied in the request, the command lists all types of profiles.</p>
5171
5171
  * @public
5172
5172
  */
5173
- ProfileType?: ProfileType;
5173
+ ProfileType?: ProfileType | undefined;
5174
5174
  }
5175
5175
  /**
5176
5176
  * @public
@@ -5181,7 +5181,7 @@ export interface ListProfilesResponse {
5181
5181
  * additional results, if there are any.</p>
5182
5182
  * @public
5183
5183
  */
5184
- NextToken?: string;
5184
+ NextToken?: string | undefined;
5185
5185
  /**
5186
5186
  * <p>Returns an array, where each item contains the details of a profile.</p>
5187
5187
  * @public
@@ -5197,7 +5197,7 @@ export interface ListSecurityPoliciesRequest {
5197
5197
  * <code>ListSecurityPolicies</code> query.</p>
5198
5198
  * @public
5199
5199
  */
5200
- MaxResults?: number;
5200
+ MaxResults?: number | undefined;
5201
5201
  /**
5202
5202
  * <p>When additional results are obtained from the <code>ListSecurityPolicies</code> command, a
5203
5203
  * <code>NextToken</code> parameter is returned in the output. You can then pass the
@@ -5205,7 +5205,7 @@ export interface ListSecurityPoliciesRequest {
5205
5205
  * security policies.</p>
5206
5206
  * @public
5207
5207
  */
5208
- NextToken?: string;
5208
+ NextToken?: string | undefined;
5209
5209
  }
5210
5210
  /**
5211
5211
  * @public
@@ -5217,7 +5217,7 @@ export interface ListSecurityPoliciesResponse {
5217
5217
  * pass in the <code>NextToken</code> parameter to continue listing security policies.</p>
5218
5218
  * @public
5219
5219
  */
5220
- NextToken?: string;
5220
+ NextToken?: string | undefined;
5221
5221
  /**
5222
5222
  * <p>An array of security policies that were listed.</p>
5223
5223
  * @public
@@ -5233,7 +5233,7 @@ export interface ListServersRequest {
5233
5233
  * query.</p>
5234
5234
  * @public
5235
5235
  */
5236
- MaxResults?: number;
5236
+ MaxResults?: number | undefined;
5237
5237
  /**
5238
5238
  * <p>When additional results are obtained from the <code>ListServers</code> command, a
5239
5239
  * <code>NextToken</code> parameter is returned in the output. You can then pass the
@@ -5241,7 +5241,7 @@ export interface ListServersRequest {
5241
5241
  * servers.</p>
5242
5242
  * @public
5243
5243
  */
5244
- NextToken?: string;
5244
+ NextToken?: string | undefined;
5245
5245
  }
5246
5246
  /**
5247
5247
  * @public
@@ -5253,7 +5253,7 @@ export interface ListServersResponse {
5253
5253
  * pass in the <code>NextToken</code> parameter to continue listing additional servers.</p>
5254
5254
  * @public
5255
5255
  */
5256
- NextToken?: string;
5256
+ NextToken?: string | undefined;
5257
5257
  /**
5258
5258
  * <p>An array of servers that were listed.</p>
5259
5259
  * @public
@@ -5275,14 +5275,14 @@ export interface ListTagsForResourceRequest {
5275
5275
  * <code>ListTagsForResource</code> request.</p>
5276
5276
  * @public
5277
5277
  */
5278
- MaxResults?: number;
5278
+ MaxResults?: number | undefined;
5279
5279
  /**
5280
5280
  * <p>When you request additional results from the <code>ListTagsForResource</code> operation, a
5281
5281
  * <code>NextToken</code> parameter is returned in the input. You can then pass in a subsequent
5282
5282
  * command to the <code>NextToken</code> parameter to continue listing additional tags.</p>
5283
5283
  * @public
5284
5284
  */
5285
- NextToken?: string;
5285
+ NextToken?: string | undefined;
5286
5286
  }
5287
5287
  /**
5288
5288
  * @public
@@ -5292,7 +5292,7 @@ export interface ListTagsForResourceResponse {
5292
5292
  * <p>The ARN you specified to list the tags of.</p>
5293
5293
  * @public
5294
5294
  */
5295
- Arn?: string;
5295
+ Arn?: string | undefined;
5296
5296
  /**
5297
5297
  * <p>When you can get additional results from the <code>ListTagsForResource</code> call, a
5298
5298
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
@@ -5300,13 +5300,13 @@ export interface ListTagsForResourceResponse {
5300
5300
  * tags.</p>
5301
5301
  * @public
5302
5302
  */
5303
- NextToken?: string;
5303
+ NextToken?: string | undefined;
5304
5304
  /**
5305
5305
  * <p>Key-value pairs that are assigned to a resource, usually for the purpose of grouping and
5306
5306
  * searching for items. Tags are metadata that you define.</p>
5307
5307
  * @public
5308
5308
  */
5309
- Tags?: Tag[];
5309
+ Tags?: Tag[] | undefined;
5310
5310
  }
5311
5311
  /**
5312
5312
  * @public
@@ -5317,7 +5317,7 @@ export interface ListUsersRequest {
5317
5317
  * request.</p>
5318
5318
  * @public
5319
5319
  */
5320
- MaxResults?: number;
5320
+ MaxResults?: number | undefined;
5321
5321
  /**
5322
5322
  * <p>If there are additional results from the <code>ListUsers</code> call, a
5323
5323
  * <code>NextToken</code> parameter is returned in the output. You can then pass
@@ -5325,7 +5325,7 @@ export interface ListUsersRequest {
5325
5325
  * users.</p>
5326
5326
  * @public
5327
5327
  */
5328
- NextToken?: string;
5328
+ NextToken?: string | undefined;
5329
5329
  /**
5330
5330
  * <p>A system-assigned unique identifier for a server that has users assigned to it.</p>
5331
5331
  * @public
@@ -5343,7 +5343,7 @@ export interface ListUsersResponse {
5343
5343
  * users.</p>
5344
5344
  * @public
5345
5345
  */
5346
- NextToken?: string;
5346
+ NextToken?: string | undefined;
5347
5347
  /**
5348
5348
  * <p>A system-assigned unique identifier for a server that the users are assigned to.</p>
5349
5349
  * @public
@@ -5364,7 +5364,7 @@ export interface ListWorkflowsRequest {
5364
5364
  * <p>Specifies the maximum number of workflows to return.</p>
5365
5365
  * @public
5366
5366
  */
5367
- MaxResults?: number;
5367
+ MaxResults?: number | undefined;
5368
5368
  /**
5369
5369
  * <p>
5370
5370
  * <code>ListWorkflows</code> returns the <code>NextToken</code> parameter in the output.
@@ -5372,7 +5372,7 @@ export interface ListWorkflowsRequest {
5372
5372
  * continue listing additional workflows.</p>
5373
5373
  * @public
5374
5374
  */
5375
- NextToken?: string;
5375
+ NextToken?: string | undefined;
5376
5376
  }
5377
5377
  /**
5378
5378
  * @public
@@ -5385,7 +5385,7 @@ export interface ListWorkflowsResponse {
5385
5385
  * continue listing additional workflows.</p>
5386
5386
  * @public
5387
5387
  */
5388
- NextToken?: string;
5388
+ NextToken?: string | undefined;
5389
5389
  /**
5390
5390
  * <p>Returns the <code>Arn</code>, <code>WorkflowId</code>, and <code>Description</code> for each workflow.</p>
5391
5391
  * @public
@@ -5405,7 +5405,7 @@ export interface UpdateProfileRequest {
5405
5405
  * <p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>
5406
5406
  * @public
5407
5407
  */
5408
- CertificateIds?: string[];
5408
+ CertificateIds?: string[] | undefined;
5409
5409
  }
5410
5410
  /**
5411
5411
  * @public
@@ -5486,7 +5486,7 @@ export interface UpdateServerRequest {
5486
5486
  * </note>
5487
5487
  * @public
5488
5488
  */
5489
- Certificate?: string;
5489
+ Certificate?: string | undefined;
5490
5490
  /**
5491
5491
  * <p>The protocol settings that are configured for your server.</p>
5492
5492
  * <ul>
@@ -5515,7 +5515,7 @@ export interface UpdateServerRequest {
5515
5515
  * </ul>
5516
5516
  * @public
5517
5517
  */
5518
- ProtocolDetails?: ProtocolDetails;
5518
+ ProtocolDetails?: ProtocolDetails | undefined;
5519
5519
  /**
5520
5520
  * <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
5521
5521
  * When you host your endpoint within your VPC, you can make your endpoint accessible only to resources
@@ -5524,7 +5524,7 @@ export interface UpdateServerRequest {
5524
5524
  * endpoint.</p>
5525
5525
  * @public
5526
5526
  */
5527
- EndpointDetails?: EndpointDetails;
5527
+ EndpointDetails?: EndpointDetails | undefined;
5528
5528
  /**
5529
5529
  * <p>The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)
5530
5530
  * or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and
@@ -5546,7 +5546,7 @@ export interface UpdateServerRequest {
5546
5546
  * </note>
5547
5547
  * @public
5548
5548
  */
5549
- EndpointType?: EndpointType;
5549
+ EndpointType?: EndpointType | undefined;
5550
5550
  /**
5551
5551
  * <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
5552
5552
  * to rotate keys, or have a set of active keys that use different algorithms.</p>
@@ -5570,20 +5570,20 @@ export interface UpdateServerRequest {
5570
5570
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Manage host keys for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>
5571
5571
  * @public
5572
5572
  */
5573
- HostKey?: string;
5573
+ HostKey?: string | undefined;
5574
5574
  /**
5575
5575
  * <p>An array containing all of the information required to call a customer's
5576
5576
  * authentication API method.</p>
5577
5577
  * @public
5578
5578
  */
5579
- IdentityProviderDetails?: IdentityProviderDetails;
5579
+ IdentityProviderDetails?: IdentityProviderDetails | undefined;
5580
5580
  /**
5581
5581
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
5582
5582
  * on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in
5583
5583
  * your CloudWatch logs.</p>
5584
5584
  * @public
5585
5585
  */
5586
- LoggingRole?: string;
5586
+ LoggingRole?: string | undefined;
5587
5587
  /**
5588
5588
  * <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p>
5589
5589
  * <note>
@@ -5591,7 +5591,7 @@ export interface UpdateServerRequest {
5591
5591
  * </note>
5592
5592
  * @public
5593
5593
  */
5594
- PostAuthenticationLoginBanner?: string;
5594
+ PostAuthenticationLoginBanner?: string | undefined;
5595
5595
  /**
5596
5596
  * <p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.
5597
5597
  * For example, the following banner displays details about using the system:</p>
@@ -5602,7 +5602,7 @@ export interface UpdateServerRequest {
5602
5602
  * </p>
5603
5603
  * @public
5604
5604
  */
5605
- PreAuthenticationLoginBanner?: string;
5605
+ PreAuthenticationLoginBanner?: string | undefined;
5606
5606
  /**
5607
5607
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
5608
5608
  * client can connect to your server's endpoint. The available protocols are:</p>
@@ -5655,12 +5655,12 @@ export interface UpdateServerRequest {
5655
5655
  * </note>
5656
5656
  * @public
5657
5657
  */
5658
- Protocols?: Protocol[];
5658
+ Protocols?: Protocol[] | undefined;
5659
5659
  /**
5660
5660
  * <p>Specifies the name of the security policy for the server.</p>
5661
5661
  * @public
5662
5662
  */
5663
- SecurityPolicyName?: string;
5663
+ SecurityPolicyName?: string | undefined;
5664
5664
  /**
5665
5665
  * <p>A system-assigned unique identifier for a server instance that the Transfer Family user is
5666
5666
  * assigned to.</p>
@@ -5678,7 +5678,7 @@ export interface UpdateServerRequest {
5678
5678
  * </p>
5679
5679
  * @public
5680
5680
  */
5681
- WorkflowDetails?: WorkflowDetails;
5681
+ WorkflowDetails?: WorkflowDetails | undefined;
5682
5682
  /**
5683
5683
  * <p>Specifies the log groups to which your server logs are sent.</p>
5684
5684
  * <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>
@@ -5694,14 +5694,14 @@ export interface UpdateServerRequest {
5694
5694
  * </p>
5695
5695
  * @public
5696
5696
  */
5697
- StructuredLogDestinations?: string[];
5697
+ StructuredLogDestinations?: string[] | undefined;
5698
5698
  /**
5699
5699
  * <p>Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.</p>
5700
5700
  * <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code>
5701
5701
  * <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
5702
5702
  * @public
5703
5703
  */
5704
- S3StorageOptions?: S3StorageOptions;
5704
+ S3StorageOptions?: S3StorageOptions | undefined;
5705
5705
  }
5706
5706
  /**
5707
5707
  * @public
@@ -5733,7 +5733,7 @@ export interface StartDirectoryListingRequest {
5733
5733
  * retrieve. The default value is 1,000.</p>
5734
5734
  * @public
5735
5735
  */
5736
- MaxItems?: number;
5736
+ MaxItems?: number | undefined;
5737
5737
  /**
5738
5738
  * <p>Specifies the path (bucket and prefix) in Amazon S3 storage to store the results of the directory listing.</p>
5739
5739
  * @public
@@ -5777,18 +5777,18 @@ export interface StartFileTransferRequest {
5777
5777
  * </note>
5778
5778
  * @public
5779
5779
  */
5780
- SendFilePaths?: string[];
5780
+ SendFilePaths?: string[] | undefined;
5781
5781
  /**
5782
5782
  * <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>
5783
5783
  * @public
5784
5784
  */
5785
- RetrieveFilePaths?: string[];
5785
+ RetrieveFilePaths?: string[] | undefined;
5786
5786
  /**
5787
5787
  * <p>For an inbound transfer, the <code>LocaDirectoryPath</code> specifies the destination for one or more files
5788
5788
  * that are transferred from the partner's SFTP server.</p>
5789
5789
  * @public
5790
5790
  */
5791
- LocalDirectoryPath?: string;
5791
+ LocalDirectoryPath?: string | undefined;
5792
5792
  /**
5793
5793
  * <p>For an outbound transfer, the <code>RemoteDirectoryPath</code> specifies the destination
5794
5794
  * for one or more files that are transferred to the partner's SFTP server. If you don't specify
@@ -5796,7 +5796,7 @@ export interface StartFileTransferRequest {
5796
5796
  * home directory.</p>
5797
5797
  * @public
5798
5798
  */
5799
- RemoteDirectoryPath?: string;
5799
+ RemoteDirectoryPath?: string | undefined;
5800
5800
  }
5801
5801
  /**
5802
5802
  * @public
@@ -5863,12 +5863,12 @@ export interface TestConnectionResponse {
5863
5863
  * <p>Returns the identifier of the connector object that you are testing.</p>
5864
5864
  * @public
5865
5865
  */
5866
- ConnectorId?: string;
5866
+ ConnectorId?: string | undefined;
5867
5867
  /**
5868
5868
  * <p>Returns <code>OK</code> for successful test, or <code>ERROR</code> if the test fails.</p>
5869
5869
  * @public
5870
5870
  */
5871
- Status?: string;
5871
+ Status?: string | undefined;
5872
5872
  /**
5873
5873
  * <p>Returns <code>Connection succeeded</code> if the test is successful. Or, returns a descriptive error message
5874
5874
  * if the test fails. The following list provides troubleshooting details, depending on the error message that you receive.</p>
@@ -5891,7 +5891,7 @@ export interface TestConnectionResponse {
5891
5891
  * </ul>
5892
5892
  * @public
5893
5893
  */
5894
- StatusMessage?: string;
5894
+ StatusMessage?: string | undefined;
5895
5895
  }
5896
5896
  /**
5897
5897
  * @public
@@ -5922,12 +5922,12 @@ export interface TestIdentityProviderRequest {
5922
5922
  * </ul>
5923
5923
  * @public
5924
5924
  */
5925
- ServerProtocol?: Protocol;
5925
+ ServerProtocol?: Protocol | undefined;
5926
5926
  /**
5927
5927
  * <p>The source IP address of the account to be tested.</p>
5928
5928
  * @public
5929
5929
  */
5930
- SourceIp?: string;
5930
+ SourceIp?: string | undefined;
5931
5931
  /**
5932
5932
  * <p>The name of the account to be tested.</p>
5933
5933
  * @public
@@ -5937,7 +5937,7 @@ export interface TestIdentityProviderRequest {
5937
5937
  * <p>The password of the account to be tested.</p>
5938
5938
  * @public
5939
5939
  */
5940
- UserPassword?: string;
5940
+ UserPassword?: string | undefined;
5941
5941
  }
5942
5942
  /**
5943
5943
  * @public
@@ -5947,7 +5947,7 @@ export interface TestIdentityProviderResponse {
5947
5947
  * <p>The response that is returned from your API Gateway or your Lambda function.</p>
5948
5948
  * @public
5949
5949
  */
5950
- Response?: string;
5950
+ Response?: string | undefined;
5951
5951
  /**
5952
5952
  * <p>The HTTP status code that is the response from your API Gateway or your Lambda function.</p>
5953
5953
  * @public
@@ -5960,7 +5960,7 @@ export interface TestIdentityProviderResponse {
5960
5960
  * </note>
5961
5961
  * @public
5962
5962
  */
5963
- Message?: string;
5963
+ Message?: string | undefined;
5964
5964
  /**
5965
5965
  * <p>The endpoint of the service used to authenticate a user.</p>
5966
5966
  * @public
@@ -5996,7 +5996,7 @@ export interface UpdateAccessRequest {
5996
5996
  * </note>
5997
5997
  * @public
5998
5998
  */
5999
- HomeDirectory?: string;
5999
+ HomeDirectory?: string | undefined;
6000
6000
  /**
6001
6001
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
6002
6002
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
@@ -6012,7 +6012,7 @@ export interface UpdateAccessRequest {
6012
6012
  * </note>
6013
6013
  * @public
6014
6014
  */
6015
- HomeDirectoryType?: HomeDirectoryType;
6015
+ HomeDirectoryType?: HomeDirectoryType | undefined;
6016
6016
  /**
6017
6017
  * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
6018
6018
  * be visible to your user and how you want to make them visible. You must specify the
@@ -6036,7 +6036,7 @@ export interface UpdateAccessRequest {
6036
6036
  * </p>
6037
6037
  * @public
6038
6038
  */
6039
- HomeDirectoryMappings?: HomeDirectoryMapEntry[];
6039
+ HomeDirectoryMappings?: HomeDirectoryMapEntry[] | undefined;
6040
6040
  /**
6041
6041
  * <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
6042
6042
  * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>$\{Transfer:UserName\}</code>,
@@ -6053,7 +6053,7 @@ export interface UpdateAccessRequest {
6053
6053
  * </note>
6054
6054
  * @public
6055
6055
  */
6056
- Policy?: string;
6056
+ Policy?: string | undefined;
6057
6057
  /**
6058
6058
  * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
6059
6059
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
@@ -6062,7 +6062,7 @@ export interface UpdateAccessRequest {
6062
6062
  * transferring files into and out of your Amazon EFS file systems.</p>
6063
6063
  * @public
6064
6064
  */
6065
- PosixProfile?: PosixProfile;
6065
+ PosixProfile?: PosixProfile | undefined;
6066
6066
  /**
6067
6067
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
6068
6068
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
@@ -6070,7 +6070,7 @@ export interface UpdateAccessRequest {
6070
6070
  * relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
6071
6071
  * @public
6072
6072
  */
6073
- Role?: string;
6073
+ Role?: string | undefined;
6074
6074
  /**
6075
6075
  * <p>A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.</p>
6076
6076
  * @public
@@ -6154,7 +6154,7 @@ export interface UpdateUserRequest {
6154
6154
  * </note>
6155
6155
  * @public
6156
6156
  */
6157
- HomeDirectory?: string;
6157
+ HomeDirectory?: string | undefined;
6158
6158
  /**
6159
6159
  * <p>The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
6160
6160
  * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
@@ -6170,7 +6170,7 @@ export interface UpdateUserRequest {
6170
6170
  * </note>
6171
6171
  * @public
6172
6172
  */
6173
- HomeDirectoryType?: HomeDirectoryType;
6173
+ HomeDirectoryType?: HomeDirectoryType | undefined;
6174
6174
  /**
6175
6175
  * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
6176
6176
  * be visible to your user and how you want to make them visible. You must specify the
@@ -6194,7 +6194,7 @@ export interface UpdateUserRequest {
6194
6194
  * </p>
6195
6195
  * @public
6196
6196
  */
6197
- HomeDirectoryMappings?: HomeDirectoryMapEntry[];
6197
+ HomeDirectoryMappings?: HomeDirectoryMapEntry[] | undefined;
6198
6198
  /**
6199
6199
  * <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
6200
6200
  * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>$\{Transfer:UserName\}</code>,
@@ -6211,7 +6211,7 @@ export interface UpdateUserRequest {
6211
6211
  * </note>
6212
6212
  * @public
6213
6213
  */
6214
- Policy?: string;
6214
+ Policy?: string | undefined;
6215
6215
  /**
6216
6216
  * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID
6217
6217
  * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
@@ -6220,7 +6220,7 @@ export interface UpdateUserRequest {
6220
6220
  * users get when transferring files into and out of your Amazon EFS file systems.</p>
6221
6221
  * @public
6222
6222
  */
6223
- PosixProfile?: PosixProfile;
6223
+ PosixProfile?: PosixProfile | undefined;
6224
6224
  /**
6225
6225
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3
6226
6226
  * bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users
@@ -6228,7 +6228,7 @@ export interface UpdateUserRequest {
6228
6228
  * relationship that allows the server to access your resources when servicing your users' transfer requests.</p>
6229
6229
  * @public
6230
6230
  */
6231
- Role?: string;
6231
+ Role?: string | undefined;
6232
6232
  /**
6233
6233
  * <p>A system-assigned unique identifier for a Transfer Family server instance that the user is
6234
6234
  * assigned to.</p>