@aws-sdk/client-mailmanager 3.799.0 → 3.803.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -8
- package/dist-cjs/models/models_0.js +14 -2
- package/dist-es/models/models_0.js +12 -0
- package/dist-types/MailManager.d.ts +1 -7
- package/dist-types/MailManagerClient.d.ts +1 -7
- package/dist-types/commands/CreateAddonInstanceCommand.d.ts +1 -3
- package/dist-types/commands/CreateAddonSubscriptionCommand.d.ts +1 -3
- package/dist-types/commands/CreateRelayCommand.d.ts +1 -2
- package/dist-types/commands/CreateRuleSetCommand.d.ts +7 -0
- package/dist-types/commands/DeleteArchiveCommand.d.ts +1 -5
- package/dist-types/commands/GetArchiveMessageCommand.d.ts +1 -3
- package/dist-types/commands/GetArchiveMessageContentCommand.d.ts +1 -3
- package/dist-types/commands/GetRuleSetCommand.d.ts +7 -0
- package/dist-types/commands/UpdateRuleSetCommand.d.ts +7 -0
- package/dist-types/index.d.ts +1 -7
- package/dist-types/models/models_0.d.ts +195 -295
- package/dist-types/ts3.4/models/models_0.d.ts +44 -0
- package/package.json +4 -4
|
@@ -38,15 +38,12 @@ export declare const ActionFailurePolicy: {
|
|
|
38
38
|
*/
|
|
39
39
|
export type ActionFailurePolicy = (typeof ActionFailurePolicy)[keyof typeof ActionFailurePolicy];
|
|
40
40
|
/**
|
|
41
|
-
* <p>The action to add a header to a message. When executed, this action will add the given
|
|
42
|
-
* header to the message.</p>
|
|
41
|
+
* <p>The action to add a header to a message. When executed, this action will add the given header to the message.</p>
|
|
43
42
|
* @public
|
|
44
43
|
*/
|
|
45
44
|
export interface AddHeaderAction {
|
|
46
45
|
/**
|
|
47
|
-
* <p>The name of the header to add to an email. The header must be prefixed with
|
|
48
|
-
* "X-". Headers are added regardless of whether the header name pre-existed in
|
|
49
|
-
* the email.</p>
|
|
46
|
+
* <p>The name of the header to add to an email. The header must be prefixed with "X-". Headers are added regardless of whether the header name pre-existed in the email.</p>
|
|
50
47
|
* @public
|
|
51
48
|
*/
|
|
52
49
|
HeaderName: string | undefined;
|
|
@@ -121,14 +118,12 @@ export interface Tag {
|
|
|
121
118
|
*/
|
|
122
119
|
export interface CreateAddonInstanceRequest {
|
|
123
120
|
/**
|
|
124
|
-
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same
|
|
125
|
-
* request.</p>
|
|
121
|
+
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
|
|
126
122
|
* @public
|
|
127
123
|
*/
|
|
128
124
|
ClientToken?: string | undefined;
|
|
129
125
|
/**
|
|
130
|
-
* <p>The unique ID of a previously created subscription that an Add On instance is created
|
|
131
|
-
* for. You can only have one instance per subscription.</p>
|
|
126
|
+
* <p>The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription.</p>
|
|
132
127
|
* @public
|
|
133
128
|
*/
|
|
134
129
|
AddonSubscriptionId: string | undefined;
|
|
@@ -247,8 +242,7 @@ export interface ListAddonInstancesRequest {
|
|
|
247
242
|
*/
|
|
248
243
|
NextToken?: string | undefined;
|
|
249
244
|
/**
|
|
250
|
-
* <p>The maximum number of ingress endpoint resources that are returned per call. You can
|
|
251
|
-
* use NextToken to obtain further ingress endpoints. </p>
|
|
245
|
+
* <p>The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints. </p>
|
|
252
246
|
* @public
|
|
253
247
|
*/
|
|
254
248
|
PageSize?: number | undefined;
|
|
@@ -269,8 +263,7 @@ export interface ListAddonInstancesResponse {
|
|
|
269
263
|
NextToken?: string | undefined;
|
|
270
264
|
}
|
|
271
265
|
/**
|
|
272
|
-
* <p>A subscription for an Add On representing the acceptance of its terms of use and
|
|
273
|
-
* additional pricing.</p>
|
|
266
|
+
* <p>A subscription for an Add On representing the acceptance of its terms of use and additional pricing.</p>
|
|
274
267
|
* @public
|
|
275
268
|
*/
|
|
276
269
|
export interface AddonSubscription {
|
|
@@ -300,14 +293,12 @@ export interface AddonSubscription {
|
|
|
300
293
|
*/
|
|
301
294
|
export interface CreateAddonSubscriptionRequest {
|
|
302
295
|
/**
|
|
303
|
-
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same
|
|
304
|
-
* request.</p>
|
|
296
|
+
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
|
|
305
297
|
* @public
|
|
306
298
|
*/
|
|
307
299
|
ClientToken?: string | undefined;
|
|
308
300
|
/**
|
|
309
|
-
* <p>The name of the Add On to subscribe to. You can only have one subscription for each
|
|
310
|
-
* Add On name.</p>
|
|
301
|
+
* <p>The name of the Add On to subscribe to. You can only have one subscription for each Add On name.</p>
|
|
311
302
|
* @public
|
|
312
303
|
*/
|
|
313
304
|
AddonName: string | undefined;
|
|
@@ -382,8 +373,7 @@ export interface ListAddonSubscriptionsRequest {
|
|
|
382
373
|
*/
|
|
383
374
|
NextToken?: string | undefined;
|
|
384
375
|
/**
|
|
385
|
-
* <p>The maximum number of ingress endpoint resources that are returned per call. You can
|
|
386
|
-
* use NextToken to obtain further ingress endpoints. </p>
|
|
376
|
+
* <p>The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints. </p>
|
|
387
377
|
* @public
|
|
388
378
|
*/
|
|
389
379
|
PageSize?: number | undefined;
|
|
@@ -450,8 +440,7 @@ export interface AddressList {
|
|
|
450
440
|
*/
|
|
451
441
|
export interface CreateAddressListRequest {
|
|
452
442
|
/**
|
|
453
|
-
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same
|
|
454
|
-
* request.</p>
|
|
443
|
+
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
|
|
455
444
|
* @public
|
|
456
445
|
*/
|
|
457
446
|
ClientToken?: string | undefined;
|
|
@@ -554,8 +543,7 @@ export interface ListAddressListsRequest {
|
|
|
554
543
|
*/
|
|
555
544
|
NextToken?: string | undefined;
|
|
556
545
|
/**
|
|
557
|
-
* <p>The maximum number of address list resources that are returned per call. You can use
|
|
558
|
-
* NextToken to retrieve the next page of address lists.</p>
|
|
546
|
+
* <p>The maximum number of address list resources that are returned per call. You can use NextToken to retrieve the next page of address lists.</p>
|
|
559
547
|
* @public
|
|
560
548
|
*/
|
|
561
549
|
PageSize?: number | undefined;
|
|
@@ -576,8 +564,7 @@ export interface ListAddressListsResponse {
|
|
|
576
564
|
NextToken?: string | undefined;
|
|
577
565
|
}
|
|
578
566
|
/**
|
|
579
|
-
* <p>The result of an analysis can be used in conditions to trigger actions. Analyses can
|
|
580
|
-
* inspect the email content and report a certain aspect of the email.</p>
|
|
567
|
+
* <p>The result of an analysis can be used in conditions to trigger actions. Analyses can inspect the email content and report a certain aspect of the email.</p>
|
|
581
568
|
* @public
|
|
582
569
|
*/
|
|
583
570
|
export interface Analysis {
|
|
@@ -620,19 +607,7 @@ export interface Archive {
|
|
|
620
607
|
*/
|
|
621
608
|
ArchiveName?: string | undefined;
|
|
622
609
|
/**
|
|
623
|
-
* <p>The current state of the archive:</p>
|
|
624
|
-
* <ul>
|
|
625
|
-
* <li>
|
|
626
|
-
* <p>
|
|
627
|
-
* <code>ACTIVE</code> – The archive is ready and available for use. </p>
|
|
628
|
-
* </li>
|
|
629
|
-
* <li>
|
|
630
|
-
* <p>
|
|
631
|
-
* <code>PENDING_DELETION</code> – The archive has been marked for deletion
|
|
632
|
-
* and will be permanently deleted in 30 days. No further modifications can be made
|
|
633
|
-
* in this state. </p>
|
|
634
|
-
* </li>
|
|
635
|
-
* </ul>
|
|
610
|
+
* <p>The current state of the archive:</p> <ul> <li> <p> <code>ACTIVE</code> – The archive is ready and available for use. </p> </li> <li> <p> <code>PENDING_DELETION</code> – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state. </p> </li> </ul>
|
|
636
611
|
* @public
|
|
637
612
|
*/
|
|
638
613
|
ArchiveState?: ArchiveState | undefined;
|
|
@@ -648,8 +623,7 @@ export interface Archive {
|
|
|
648
623
|
*/
|
|
649
624
|
export interface ArchiveAction {
|
|
650
625
|
/**
|
|
651
|
-
* <p>A policy that states what to do in the case of failure. The action will fail if there
|
|
652
|
-
* are configuration errors. For example, the specified archive has been deleted.</p>
|
|
626
|
+
* <p>A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified archive has been deleted.</p>
|
|
653
627
|
* @public
|
|
654
628
|
*/
|
|
655
629
|
ActionFailurePolicy?: ActionFailurePolicy | undefined;
|
|
@@ -891,8 +865,7 @@ export declare const RetentionPeriod: {
|
|
|
891
865
|
*/
|
|
892
866
|
export type RetentionPeriod = (typeof RetentionPeriod)[keyof typeof RetentionPeriod];
|
|
893
867
|
/**
|
|
894
|
-
* <p>The retention policy for an email archive that specifies how long emails are kept
|
|
895
|
-
* before being automatically deleted. </p>
|
|
868
|
+
* <p>The retention policy for an email archive that specifies how long emails are kept before being automatically deleted. </p>
|
|
896
869
|
* @public
|
|
897
870
|
*/
|
|
898
871
|
export type ArchiveRetention = ArchiveRetention.RetentionPeriodMember | ArchiveRetention.$UnknownMember;
|
|
@@ -975,9 +948,7 @@ export interface DeleteArchiveRequest {
|
|
|
975
948
|
ArchiveId: string | undefined;
|
|
976
949
|
}
|
|
977
950
|
/**
|
|
978
|
-
* <p>The response indicating if the archive deletion was successfully initiated.</p>
|
|
979
|
-
* <p>On success, returns an HTTP 200 status code. On failure, returns an error
|
|
980
|
-
* message.</p>
|
|
951
|
+
* <p>The response indicating if the archive deletion was successfully initiated.</p> <p>On success, returns an HTTP 200 status code. On failure, returns an error message.</p>
|
|
981
952
|
* @public
|
|
982
953
|
*/
|
|
983
954
|
export interface DeleteArchiveResponse {
|
|
@@ -1014,19 +985,7 @@ export interface GetArchiveResponse {
|
|
|
1014
985
|
*/
|
|
1015
986
|
ArchiveArn: string | undefined;
|
|
1016
987
|
/**
|
|
1017
|
-
* <p>The current state of the archive:</p>
|
|
1018
|
-
* <ul>
|
|
1019
|
-
* <li>
|
|
1020
|
-
* <p>
|
|
1021
|
-
* <code>ACTIVE</code> – The archive is ready and available for use. </p>
|
|
1022
|
-
* </li>
|
|
1023
|
-
* <li>
|
|
1024
|
-
* <p>
|
|
1025
|
-
* <code>PENDING_DELETION</code> – The archive has been marked for deletion
|
|
1026
|
-
* and will be permanently deleted in 30 days. No further modifications can be made
|
|
1027
|
-
* in this state. </p>
|
|
1028
|
-
* </li>
|
|
1029
|
-
* </ul>
|
|
988
|
+
* <p>The current state of the archive:</p> <ul> <li> <p> <code>ACTIVE</code> – The archive is ready and available for use. </p> </li> <li> <p> <code>PENDING_DELETION</code> – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state. </p> </li> </ul>
|
|
1030
989
|
* @public
|
|
1031
990
|
*/
|
|
1032
991
|
ArchiveState: ArchiveState | undefined;
|
|
@@ -1057,15 +1016,12 @@ export interface GetArchiveResponse {
|
|
|
1057
1016
|
*/
|
|
1058
1017
|
export interface ListArchivesRequest {
|
|
1059
1018
|
/**
|
|
1060
|
-
* <p>If NextToken is returned, there are more results available. The value of NextToken is
|
|
1061
|
-
* a unique pagination token for each page. Make the call again using the returned token to
|
|
1062
|
-
* retrieve the next page. </p>
|
|
1019
|
+
* <p>If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. </p>
|
|
1063
1020
|
* @public
|
|
1064
1021
|
*/
|
|
1065
1022
|
NextToken?: string | undefined;
|
|
1066
1023
|
/**
|
|
1067
|
-
* <p>The maximum number of archives that are returned per call. You can use NextToken to
|
|
1068
|
-
* obtain further pages of archives. </p>
|
|
1024
|
+
* <p>The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives. </p>
|
|
1069
1025
|
* @public
|
|
1070
1026
|
*/
|
|
1071
1027
|
PageSize?: number | undefined;
|
|
@@ -1108,9 +1064,7 @@ export interface UpdateArchiveRequest {
|
|
|
1108
1064
|
Retention?: ArchiveRetention | undefined;
|
|
1109
1065
|
}
|
|
1110
1066
|
/**
|
|
1111
|
-
* <p>The response indicating if the archive update succeeded or failed.</p>
|
|
1112
|
-
* <p>On success, returns an HTTP 200 status code. On failure, returns an error
|
|
1113
|
-
* message.</p>
|
|
1067
|
+
* <p>The response indicating if the archive update succeeded or failed.</p> <p>On success, returns an HTTP 200 status code. On failure, returns an error message.</p>
|
|
1114
1068
|
* @public
|
|
1115
1069
|
*/
|
|
1116
1070
|
export interface UpdateArchiveResponse {
|
|
@@ -1128,8 +1082,7 @@ export declare const ImportDataType: {
|
|
|
1128
1082
|
*/
|
|
1129
1083
|
export type ImportDataType = (typeof ImportDataType)[keyof typeof ImportDataType];
|
|
1130
1084
|
/**
|
|
1131
|
-
* <p>The import data format contains the specifications of the input file that would be passed to the address list
|
|
1132
|
-
* import job.</p>
|
|
1085
|
+
* <p>The import data format contains the specifications of the input file that would be passed to the address list import job.</p>
|
|
1133
1086
|
* @public
|
|
1134
1087
|
*/
|
|
1135
1088
|
export interface ImportDataFormat {
|
|
@@ -1144,8 +1097,7 @@ export interface ImportDataFormat {
|
|
|
1144
1097
|
*/
|
|
1145
1098
|
export interface CreateAddressListImportJobRequest {
|
|
1146
1099
|
/**
|
|
1147
|
-
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same
|
|
1148
|
-
* request.</p>
|
|
1100
|
+
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
|
|
1149
1101
|
* @public
|
|
1150
1102
|
*/
|
|
1151
1103
|
ClientToken?: string | undefined;
|
|
@@ -1315,8 +1267,7 @@ export type IngressPointType = (typeof IngressPointType)[keyof typeof IngressPoi
|
|
|
1315
1267
|
*/
|
|
1316
1268
|
export interface CreateIngressPointRequest {
|
|
1317
1269
|
/**
|
|
1318
|
-
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same
|
|
1319
|
-
* request.</p>
|
|
1270
|
+
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
|
|
1320
1271
|
* @public
|
|
1321
1272
|
*/
|
|
1322
1273
|
ClientToken?: string | undefined;
|
|
@@ -1331,27 +1282,22 @@ export interface CreateIngressPointRequest {
|
|
|
1331
1282
|
*/
|
|
1332
1283
|
Type: IngressPointType | undefined;
|
|
1333
1284
|
/**
|
|
1334
|
-
* <p>The identifier of an existing rule set that you attach to an ingress endpoint
|
|
1335
|
-
* resource.</p>
|
|
1285
|
+
* <p>The identifier of an existing rule set that you attach to an ingress endpoint resource.</p>
|
|
1336
1286
|
* @public
|
|
1337
1287
|
*/
|
|
1338
1288
|
RuleSetId: string | undefined;
|
|
1339
1289
|
/**
|
|
1340
|
-
* <p>The identifier of an existing traffic policy that you attach to an ingress endpoint
|
|
1341
|
-
* resource.</p>
|
|
1290
|
+
* <p>The identifier of an existing traffic policy that you attach to an ingress endpoint resource.</p>
|
|
1342
1291
|
* @public
|
|
1343
1292
|
*/
|
|
1344
1293
|
TrafficPolicyId: string | undefined;
|
|
1345
1294
|
/**
|
|
1346
|
-
* <p>If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret
|
|
1347
|
-
* ARN.</p>
|
|
1295
|
+
* <p>If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.</p>
|
|
1348
1296
|
* @public
|
|
1349
1297
|
*/
|
|
1350
1298
|
IngressPointConfiguration?: IngressPointConfiguration | undefined;
|
|
1351
1299
|
/**
|
|
1352
|
-
* <p>Specifies the network configuration for the ingress point.
|
|
1353
|
-
* This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only.
|
|
1354
|
-
* </p>
|
|
1300
|
+
* <p>Specifies the network configuration for the ingress point. This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only. </p>
|
|
1355
1301
|
* @public
|
|
1356
1302
|
*/
|
|
1357
1303
|
NetworkConfiguration?: NetworkConfiguration | undefined;
|
|
@@ -1378,8 +1324,7 @@ export interface CreateIngressPointResponse {
|
|
|
1378
1324
|
export interface NoAuthentication {
|
|
1379
1325
|
}
|
|
1380
1326
|
/**
|
|
1381
|
-
* <p>Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored,
|
|
1382
|
-
* or specify an empty NoAuthentication structure if the relay destination server does not require SMTP credential authentication.</p>
|
|
1327
|
+
* <p>Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored, or specify an empty NoAuthentication structure if the relay destination server does not require SMTP credential authentication.</p>
|
|
1383
1328
|
* @public
|
|
1384
1329
|
*/
|
|
1385
1330
|
export type RelayAuthentication = RelayAuthentication.NoAuthenticationMember | RelayAuthentication.SecretArnMember | RelayAuthentication.$UnknownMember;
|
|
@@ -1425,8 +1370,7 @@ export declare namespace RelayAuthentication {
|
|
|
1425
1370
|
*/
|
|
1426
1371
|
export interface CreateRelayRequest {
|
|
1427
1372
|
/**
|
|
1428
|
-
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same
|
|
1429
|
-
* request.</p>
|
|
1373
|
+
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
|
|
1430
1374
|
* @public
|
|
1431
1375
|
*/
|
|
1432
1376
|
ClientToken?: string | undefined;
|
|
@@ -1446,8 +1390,7 @@ export interface CreateRelayRequest {
|
|
|
1446
1390
|
*/
|
|
1447
1391
|
ServerPort: number | undefined;
|
|
1448
1392
|
/**
|
|
1449
|
-
* <p>Authentication for the relay destination server—specify the secretARN where
|
|
1450
|
-
* the SMTP credentials are stored.</p>
|
|
1393
|
+
* <p>Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.</p>
|
|
1451
1394
|
* @public
|
|
1452
1395
|
*/
|
|
1453
1396
|
Authentication: RelayAuthentication | undefined;
|
|
@@ -1473,8 +1416,7 @@ export interface CreateRelayResponse {
|
|
|
1473
1416
|
*/
|
|
1474
1417
|
export interface DeliverToMailboxAction {
|
|
1475
1418
|
/**
|
|
1476
|
-
* <p>A policy that states what to do in the case of failure. The action will fail if there
|
|
1477
|
-
* are configuration errors. For example, the mailbox ARN is no longer valid.</p>
|
|
1419
|
+
* <p>A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid.</p>
|
|
1478
1420
|
* @public
|
|
1479
1421
|
*/
|
|
1480
1422
|
ActionFailurePolicy?: ActionFailurePolicy | undefined;
|
|
@@ -1484,8 +1426,7 @@ export interface DeliverToMailboxAction {
|
|
|
1484
1426
|
*/
|
|
1485
1427
|
MailboxArn: string | undefined;
|
|
1486
1428
|
/**
|
|
1487
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to
|
|
1488
|
-
* the workmail:DeliverToMailbox API.</p>
|
|
1429
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to the workmail:DeliverToMailbox API.</p>
|
|
1489
1430
|
* @public
|
|
1490
1431
|
*/
|
|
1491
1432
|
RoleArn: string | undefined;
|
|
@@ -1496,39 +1437,87 @@ export interface DeliverToMailboxAction {
|
|
|
1496
1437
|
*/
|
|
1497
1438
|
export interface DeliverToQBusinessAction {
|
|
1498
1439
|
/**
|
|
1499
|
-
* <p>A policy that states what to do in the case of failure. The action will fail if there are
|
|
1500
|
-
* configuration errors. For example, the specified application has been deleted or the role lacks
|
|
1501
|
-
* necessary permissions to call the qbusiness:BatchPutDocument API.</p>
|
|
1440
|
+
* <p>A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the <code>qbusiness:BatchPutDocument</code> API.</p>
|
|
1502
1441
|
* @public
|
|
1503
1442
|
*/
|
|
1504
1443
|
ActionFailurePolicy?: ActionFailurePolicy | undefined;
|
|
1505
1444
|
/**
|
|
1506
|
-
* <p>The unique identifier of the Amazon Q Business application instance where the email
|
|
1507
|
-
* content will be delivered.</p>
|
|
1445
|
+
* <p>The unique identifier of the Amazon Q Business application instance where the email content will be delivered.</p>
|
|
1508
1446
|
* @public
|
|
1509
1447
|
*/
|
|
1510
1448
|
ApplicationId: string | undefined;
|
|
1511
1449
|
/**
|
|
1512
|
-
* <p>The identifier of the knowledge base index within the Amazon Q Business application
|
|
1513
|
-
* where the email content will be stored and indexed.</p>
|
|
1450
|
+
* <p>The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.</p>
|
|
1514
1451
|
* @public
|
|
1515
1452
|
*/
|
|
1516
1453
|
IndexId: string | undefined;
|
|
1517
1454
|
/**
|
|
1518
|
-
* <p>The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access
|
|
1519
|
-
* to the qbusiness:BatchPutDocument API for the given application and index.</p>
|
|
1455
|
+
* <p>The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the <code>qbusiness:BatchPutDocument</code> API for the given application and index.</p>
|
|
1520
1456
|
* @public
|
|
1521
1457
|
*/
|
|
1522
1458
|
RoleArn: string | undefined;
|
|
1523
1459
|
}
|
|
1524
1460
|
/**
|
|
1525
|
-
* <p>This action causes processing to stop and the email to be dropped. If the action
|
|
1526
|
-
* applies only to certain recipients, only those recipients are dropped, and processing
|
|
1527
|
-
* continues for other recipients.</p>
|
|
1461
|
+
* <p>This action causes processing to stop and the email to be dropped. If the action applies only to certain recipients, only those recipients are dropped, and processing continues for other recipients.</p>
|
|
1528
1462
|
* @public
|
|
1529
1463
|
*/
|
|
1530
1464
|
export interface DropAction {
|
|
1531
1465
|
}
|
|
1466
|
+
/**
|
|
1467
|
+
* @public
|
|
1468
|
+
* @enum
|
|
1469
|
+
*/
|
|
1470
|
+
export declare const SnsNotificationEncoding: {
|
|
1471
|
+
readonly BASE64: "BASE64";
|
|
1472
|
+
readonly UTF_8: "UTF-8";
|
|
1473
|
+
};
|
|
1474
|
+
/**
|
|
1475
|
+
* @public
|
|
1476
|
+
*/
|
|
1477
|
+
export type SnsNotificationEncoding = (typeof SnsNotificationEncoding)[keyof typeof SnsNotificationEncoding];
|
|
1478
|
+
/**
|
|
1479
|
+
* @public
|
|
1480
|
+
* @enum
|
|
1481
|
+
*/
|
|
1482
|
+
export declare const SnsNotificationPayloadType: {
|
|
1483
|
+
readonly CONTENT: "CONTENT";
|
|
1484
|
+
readonly HEADERS: "HEADERS";
|
|
1485
|
+
};
|
|
1486
|
+
/**
|
|
1487
|
+
* @public
|
|
1488
|
+
*/
|
|
1489
|
+
export type SnsNotificationPayloadType = (typeof SnsNotificationPayloadType)[keyof typeof SnsNotificationPayloadType];
|
|
1490
|
+
/**
|
|
1491
|
+
* <p>The action to publish the email content to an Amazon SNS topic. When executed, this action will send the email as a notification to the specified SNS topic.</p>
|
|
1492
|
+
* @public
|
|
1493
|
+
*/
|
|
1494
|
+
export interface SnsAction {
|
|
1495
|
+
/**
|
|
1496
|
+
* <p>A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the <code>sns:Publish</code> API.</p>
|
|
1497
|
+
* @public
|
|
1498
|
+
*/
|
|
1499
|
+
ActionFailurePolicy?: ActionFailurePolicy | undefined;
|
|
1500
|
+
/**
|
|
1501
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.</p>
|
|
1502
|
+
* @public
|
|
1503
|
+
*/
|
|
1504
|
+
TopicArn: string | undefined;
|
|
1505
|
+
/**
|
|
1506
|
+
* <p>The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS. This role must have access to the <code>sns:Publish</code> API for the given topic.</p>
|
|
1507
|
+
* @public
|
|
1508
|
+
*/
|
|
1509
|
+
RoleArn: string | undefined;
|
|
1510
|
+
/**
|
|
1511
|
+
* <p>The encoding to use for the email within the Amazon SNS notification. The default value is <code>UTF-8</code>. Use <code>BASE64</code> if you need to preserve all special characters, especially when the original message uses a different encoding format.</p>
|
|
1512
|
+
* @public
|
|
1513
|
+
*/
|
|
1514
|
+
Encoding?: SnsNotificationEncoding | undefined;
|
|
1515
|
+
/**
|
|
1516
|
+
* <p>The expected payload type within the Amazon SNS notification. <code>CONTENT</code> attempts to publish the full email content with 20KB of headers content. <code>HEADERS</code> extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is <code>CONTENT</code>.</p>
|
|
1517
|
+
* @public
|
|
1518
|
+
*/
|
|
1519
|
+
PayloadType?: SnsNotificationPayloadType | undefined;
|
|
1520
|
+
}
|
|
1532
1521
|
/**
|
|
1533
1522
|
* @public
|
|
1534
1523
|
* @enum
|
|
@@ -1547,8 +1536,7 @@ export type MailFrom = (typeof MailFrom)[keyof typeof MailFrom];
|
|
|
1547
1536
|
*/
|
|
1548
1537
|
export interface RelayAction {
|
|
1549
1538
|
/**
|
|
1550
|
-
* <p>A policy that states what to do in the case of failure. The action will fail if there
|
|
1551
|
-
* are configuration errors. For example, the specified relay has been deleted.</p>
|
|
1539
|
+
* <p>A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified relay has been deleted.</p>
|
|
1552
1540
|
* @public
|
|
1553
1541
|
*/
|
|
1554
1542
|
ActionFailurePolicy?: ActionFailurePolicy | undefined;
|
|
@@ -1558,18 +1546,13 @@ export interface RelayAction {
|
|
|
1558
1546
|
*/
|
|
1559
1547
|
Relay: string | undefined;
|
|
1560
1548
|
/**
|
|
1561
|
-
* <p>This action specifies whether to preserve or replace original mail from address while
|
|
1562
|
-
* relaying received emails to a destination server.</p>
|
|
1549
|
+
* <p>This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.</p>
|
|
1563
1550
|
* @public
|
|
1564
1551
|
*/
|
|
1565
1552
|
MailFrom?: MailFrom | undefined;
|
|
1566
1553
|
}
|
|
1567
1554
|
/**
|
|
1568
|
-
* <p>This action replaces the email envelope recipients with the given list of recipients.
|
|
1569
|
-
* If the condition of this action applies only to a subset of recipients, only those
|
|
1570
|
-
* recipients are replaced with the recipients specified in the action. The message
|
|
1571
|
-
* contents and headers are unaffected by this action, only the envelope recipients are
|
|
1572
|
-
* updated.</p>
|
|
1555
|
+
* <p>This action replaces the email envelope recipients with the given list of recipients. If the condition of this action applies only to a subset of recipients, only those recipients are replaced with the recipients specified in the action. The message contents and headers are unaffected by this action, only the envelope recipients are updated.</p>
|
|
1573
1556
|
* @public
|
|
1574
1557
|
*/
|
|
1575
1558
|
export interface ReplaceRecipientAction {
|
|
@@ -1585,15 +1568,12 @@ export interface ReplaceRecipientAction {
|
|
|
1585
1568
|
*/
|
|
1586
1569
|
export interface SendAction {
|
|
1587
1570
|
/**
|
|
1588
|
-
* <p>A policy that states what to do in the case of failure. The action will fail if there
|
|
1589
|
-
* are configuration errors. For example, the caller does not have the permissions to call
|
|
1590
|
-
* the sendRawEmail API.</p>
|
|
1571
|
+
* <p>A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API.</p>
|
|
1591
1572
|
* @public
|
|
1592
1573
|
*/
|
|
1593
1574
|
ActionFailurePolicy?: ActionFailurePolicy | undefined;
|
|
1594
1575
|
/**
|
|
1595
|
-
* <p>The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the
|
|
1596
|
-
* ses:SendRawEmail API.</p>
|
|
1576
|
+
* <p>The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API.</p>
|
|
1597
1577
|
* @public
|
|
1598
1578
|
*/
|
|
1599
1579
|
RoleArn: string | undefined;
|
|
@@ -1604,14 +1584,12 @@ export interface SendAction {
|
|
|
1604
1584
|
*/
|
|
1605
1585
|
export interface S3Action {
|
|
1606
1586
|
/**
|
|
1607
|
-
* <p>A policy that states what to do in the case of failure. The action will fail if there
|
|
1608
|
-
* are configuration errors. For example, the specified the bucket has been deleted.</p>
|
|
1587
|
+
* <p>A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.</p>
|
|
1609
1588
|
* @public
|
|
1610
1589
|
*/
|
|
1611
1590
|
ActionFailurePolicy?: ActionFailurePolicy | undefined;
|
|
1612
1591
|
/**
|
|
1613
|
-
* <p>The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to
|
|
1614
|
-
* the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.</p>
|
|
1592
|
+
* <p>The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.</p>
|
|
1615
1593
|
* @public
|
|
1616
1594
|
*/
|
|
1617
1595
|
RoleArn: string | undefined;
|
|
@@ -1635,7 +1613,7 @@ export interface S3Action {
|
|
|
1635
1613
|
* <p>The action for a rule to take. Only one of the contained actions can be set.</p>
|
|
1636
1614
|
* @public
|
|
1637
1615
|
*/
|
|
1638
|
-
export type RuleAction = RuleAction.AddHeaderMember | RuleAction.ArchiveMember | RuleAction.DeliverToMailboxMember | RuleAction.DeliverToQBusinessMember | RuleAction.DropMember | RuleAction.RelayMember | RuleAction.ReplaceRecipientMember | RuleAction.SendMember | RuleAction.WriteToS3Member | RuleAction.$UnknownMember;
|
|
1616
|
+
export type RuleAction = RuleAction.AddHeaderMember | RuleAction.ArchiveMember | RuleAction.DeliverToMailboxMember | RuleAction.DeliverToQBusinessMember | RuleAction.DropMember | RuleAction.PublishToSnsMember | RuleAction.RelayMember | RuleAction.ReplaceRecipientMember | RuleAction.SendMember | RuleAction.WriteToS3Member | RuleAction.$UnknownMember;
|
|
1639
1617
|
/**
|
|
1640
1618
|
* @public
|
|
1641
1619
|
*/
|
|
@@ -1654,6 +1632,7 @@ export declare namespace RuleAction {
|
|
|
1654
1632
|
ReplaceRecipient?: never;
|
|
1655
1633
|
DeliverToMailbox?: never;
|
|
1656
1634
|
DeliverToQBusiness?: never;
|
|
1635
|
+
PublishToSns?: never;
|
|
1657
1636
|
$unknown?: never;
|
|
1658
1637
|
}
|
|
1659
1638
|
/**
|
|
@@ -1670,11 +1649,11 @@ export declare namespace RuleAction {
|
|
|
1670
1649
|
ReplaceRecipient?: never;
|
|
1671
1650
|
DeliverToMailbox?: never;
|
|
1672
1651
|
DeliverToQBusiness?: never;
|
|
1652
|
+
PublishToSns?: never;
|
|
1673
1653
|
$unknown?: never;
|
|
1674
1654
|
}
|
|
1675
1655
|
/**
|
|
1676
|
-
* <p>This action archives the email. This can be used to deliver an email to an
|
|
1677
|
-
* archive.</p>
|
|
1656
|
+
* <p>This action archives the email. This can be used to deliver an email to an archive.</p>
|
|
1678
1657
|
* @public
|
|
1679
1658
|
*/
|
|
1680
1659
|
interface ArchiveMember {
|
|
@@ -1687,6 +1666,7 @@ export declare namespace RuleAction {
|
|
|
1687
1666
|
ReplaceRecipient?: never;
|
|
1688
1667
|
DeliverToMailbox?: never;
|
|
1689
1668
|
DeliverToQBusiness?: never;
|
|
1669
|
+
PublishToSns?: never;
|
|
1690
1670
|
$unknown?: never;
|
|
1691
1671
|
}
|
|
1692
1672
|
/**
|
|
@@ -1703,6 +1683,7 @@ export declare namespace RuleAction {
|
|
|
1703
1683
|
ReplaceRecipient?: never;
|
|
1704
1684
|
DeliverToMailbox?: never;
|
|
1705
1685
|
DeliverToQBusiness?: never;
|
|
1686
|
+
PublishToSns?: never;
|
|
1706
1687
|
$unknown?: never;
|
|
1707
1688
|
}
|
|
1708
1689
|
/**
|
|
@@ -1719,6 +1700,7 @@ export declare namespace RuleAction {
|
|
|
1719
1700
|
ReplaceRecipient?: never;
|
|
1720
1701
|
DeliverToMailbox?: never;
|
|
1721
1702
|
DeliverToQBusiness?: never;
|
|
1703
|
+
PublishToSns?: never;
|
|
1722
1704
|
$unknown?: never;
|
|
1723
1705
|
}
|
|
1724
1706
|
/**
|
|
@@ -1735,11 +1717,11 @@ export declare namespace RuleAction {
|
|
|
1735
1717
|
ReplaceRecipient?: never;
|
|
1736
1718
|
DeliverToMailbox?: never;
|
|
1737
1719
|
DeliverToQBusiness?: never;
|
|
1720
|
+
PublishToSns?: never;
|
|
1738
1721
|
$unknown?: never;
|
|
1739
1722
|
}
|
|
1740
1723
|
/**
|
|
1741
|
-
* <p>The action replaces certain or all recipients with a different set of
|
|
1742
|
-
* recipients.</p>
|
|
1724
|
+
* <p>The action replaces certain or all recipients with a different set of recipients.</p>
|
|
1743
1725
|
* @public
|
|
1744
1726
|
*/
|
|
1745
1727
|
interface ReplaceRecipientMember {
|
|
@@ -1752,6 +1734,7 @@ export declare namespace RuleAction {
|
|
|
1752
1734
|
ReplaceRecipient: ReplaceRecipientAction;
|
|
1753
1735
|
DeliverToMailbox?: never;
|
|
1754
1736
|
DeliverToQBusiness?: never;
|
|
1737
|
+
PublishToSns?: never;
|
|
1755
1738
|
$unknown?: never;
|
|
1756
1739
|
}
|
|
1757
1740
|
/**
|
|
@@ -1768,11 +1751,11 @@ export declare namespace RuleAction {
|
|
|
1768
1751
|
ReplaceRecipient?: never;
|
|
1769
1752
|
DeliverToMailbox: DeliverToMailboxAction;
|
|
1770
1753
|
DeliverToQBusiness?: never;
|
|
1754
|
+
PublishToSns?: never;
|
|
1771
1755
|
$unknown?: never;
|
|
1772
1756
|
}
|
|
1773
1757
|
/**
|
|
1774
|
-
* <p>This action delivers an email to an Amazon Q Business application for ingestion into
|
|
1775
|
-
* its knowledge base.</p>
|
|
1758
|
+
* <p>This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.</p>
|
|
1776
1759
|
* @public
|
|
1777
1760
|
*/
|
|
1778
1761
|
interface DeliverToQBusinessMember {
|
|
@@ -1785,6 +1768,24 @@ export declare namespace RuleAction {
|
|
|
1785
1768
|
ReplaceRecipient?: never;
|
|
1786
1769
|
DeliverToMailbox?: never;
|
|
1787
1770
|
DeliverToQBusiness: DeliverToQBusinessAction;
|
|
1771
|
+
PublishToSns?: never;
|
|
1772
|
+
$unknown?: never;
|
|
1773
|
+
}
|
|
1774
|
+
/**
|
|
1775
|
+
* <p>This action publishes the email content to an Amazon SNS topic.</p>
|
|
1776
|
+
* @public
|
|
1777
|
+
*/
|
|
1778
|
+
interface PublishToSnsMember {
|
|
1779
|
+
Drop?: never;
|
|
1780
|
+
Relay?: never;
|
|
1781
|
+
Archive?: never;
|
|
1782
|
+
WriteToS3?: never;
|
|
1783
|
+
Send?: never;
|
|
1784
|
+
AddHeader?: never;
|
|
1785
|
+
ReplaceRecipient?: never;
|
|
1786
|
+
DeliverToMailbox?: never;
|
|
1787
|
+
DeliverToQBusiness?: never;
|
|
1788
|
+
PublishToSns: SnsAction;
|
|
1788
1789
|
$unknown?: never;
|
|
1789
1790
|
}
|
|
1790
1791
|
/**
|
|
@@ -1800,6 +1801,7 @@ export declare namespace RuleAction {
|
|
|
1800
1801
|
ReplaceRecipient?: never;
|
|
1801
1802
|
DeliverToMailbox?: never;
|
|
1802
1803
|
DeliverToQBusiness?: never;
|
|
1804
|
+
PublishToSns?: never;
|
|
1803
1805
|
$unknown: [string, any];
|
|
1804
1806
|
}
|
|
1805
1807
|
interface Visitor<T> {
|
|
@@ -1812,6 +1814,7 @@ export declare namespace RuleAction {
|
|
|
1812
1814
|
ReplaceRecipient: (value: ReplaceRecipientAction) => T;
|
|
1813
1815
|
DeliverToMailbox: (value: DeliverToMailboxAction) => T;
|
|
1814
1816
|
DeliverToQBusiness: (value: DeliverToQBusinessAction) => T;
|
|
1817
|
+
PublishToSns: (value: SnsAction) => T;
|
|
1815
1818
|
_: (name: string, value: any) => T;
|
|
1816
1819
|
}
|
|
1817
1820
|
const visit: <T>(value: RuleAction, visitor: Visitor<T>) => T;
|
|
@@ -1862,8 +1865,7 @@ export interface RuleIsInAddressList {
|
|
|
1862
1865
|
AddressLists: string[] | undefined;
|
|
1863
1866
|
}
|
|
1864
1867
|
/**
|
|
1865
|
-
* <p>The union type representing the allowed types of operands for a boolean
|
|
1866
|
-
* condition.</p>
|
|
1868
|
+
* <p>The union type representing the allowed types of operands for a boolean condition.</p>
|
|
1867
1869
|
* @public
|
|
1868
1870
|
*/
|
|
1869
1871
|
export type RuleBooleanToEvaluate = RuleBooleanToEvaluate.AnalysisMember | RuleBooleanToEvaluate.AttributeMember | RuleBooleanToEvaluate.IsInAddressListMember | RuleBooleanToEvaluate.$UnknownMember;
|
|
@@ -1972,8 +1974,7 @@ export declare const RuleDmarcPolicy: {
|
|
|
1972
1974
|
*/
|
|
1973
1975
|
export type RuleDmarcPolicy = (typeof RuleDmarcPolicy)[keyof typeof RuleDmarcPolicy];
|
|
1974
1976
|
/**
|
|
1975
|
-
* <p>A DMARC policy expression. The condition matches if the given DMARC policy matches
|
|
1976
|
-
* that of the incoming email.</p>
|
|
1977
|
+
* <p>A DMARC policy expression. The condition matches if the given DMARC policy matches that of the incoming email.</p>
|
|
1977
1978
|
* @public
|
|
1978
1979
|
*/
|
|
1979
1980
|
export interface RuleDmarcExpression {
|
|
@@ -1983,12 +1984,7 @@ export interface RuleDmarcExpression {
|
|
|
1983
1984
|
*/
|
|
1984
1985
|
Operator: RuleDmarcOperator | undefined;
|
|
1985
1986
|
/**
|
|
1986
|
-
* <p>The values to use for the given DMARC policy operator. For the operator EQUALS, if
|
|
1987
|
-
* multiple values are given, they are evaluated as an OR. That is, if any of the given
|
|
1988
|
-
* values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple
|
|
1989
|
-
* values are given, they are evaluated as an AND. That is, only if the email's DMARC
|
|
1990
|
-
* policy is not equal to any of the given values, then the condition is deemed to
|
|
1991
|
-
* match.</p>
|
|
1987
|
+
* <p>The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match.</p>
|
|
1992
1988
|
* @public
|
|
1993
1989
|
*/
|
|
1994
1990
|
Values: RuleDmarcPolicy[] | undefined;
|
|
@@ -2047,8 +2043,7 @@ export declare const RuleIpOperator: {
|
|
|
2047
2043
|
*/
|
|
2048
2044
|
export type RuleIpOperator = (typeof RuleIpOperator)[keyof typeof RuleIpOperator];
|
|
2049
2045
|
/**
|
|
2050
|
-
* <p>An IP address expression matching certain IP addresses within a given range of IP
|
|
2051
|
-
* addresses.</p>
|
|
2046
|
+
* <p>An IP address expression matching certain IP addresses within a given range of IP addresses.</p>
|
|
2052
2047
|
* @public
|
|
2053
2048
|
*/
|
|
2054
2049
|
export interface RuleIpExpression {
|
|
@@ -2063,12 +2058,7 @@ export interface RuleIpExpression {
|
|
|
2063
2058
|
*/
|
|
2064
2059
|
Operator: RuleIpOperator | undefined;
|
|
2065
2060
|
/**
|
|
2066
|
-
* <p>The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the
|
|
2067
|
-
* email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they
|
|
2068
|
-
* are evaluated as an OR. That is, if the IP address is contained within any of the given
|
|
2069
|
-
* CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR
|
|
2070
|
-
* ranges are given, the condition is deemed to match if the IP address is not contained in
|
|
2071
|
-
* any of the given CIDR ranges.</p>
|
|
2061
|
+
* <p>The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges.</p>
|
|
2072
2062
|
* @public
|
|
2073
2063
|
*/
|
|
2074
2064
|
Values: string[] | undefined;
|
|
@@ -2131,8 +2121,7 @@ export declare const RuleNumberOperator: {
|
|
|
2131
2121
|
*/
|
|
2132
2122
|
export type RuleNumberOperator = (typeof RuleNumberOperator)[keyof typeof RuleNumberOperator];
|
|
2133
2123
|
/**
|
|
2134
|
-
* <p>A number expression to match numeric conditions with integers from the incoming
|
|
2135
|
-
* email.</p>
|
|
2124
|
+
* <p>A number expression to match numeric conditions with integers from the incoming email.</p>
|
|
2136
2125
|
* @public
|
|
2137
2126
|
*/
|
|
2138
2127
|
export interface RuleNumberExpression {
|
|
@@ -2257,11 +2246,7 @@ export interface RuleStringExpression {
|
|
|
2257
2246
|
*/
|
|
2258
2247
|
Operator: RuleStringOperator | undefined;
|
|
2259
2248
|
/**
|
|
2260
|
-
* <p>The string(s) to be evaluated in a string condition expression. For all operators,
|
|
2261
|
-
* except for NOT_EQUALS, if multiple values are given, the values are processed as an OR.
|
|
2262
|
-
* That is, if any of the values match the email's string using the given operator, the
|
|
2263
|
-
* condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to
|
|
2264
|
-
* match if none of the given strings match the email's string.</p>
|
|
2249
|
+
* <p>The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string.</p>
|
|
2265
2250
|
* @public
|
|
2266
2251
|
*/
|
|
2267
2252
|
Values: string[] | undefined;
|
|
@@ -2297,8 +2282,7 @@ export declare namespace RuleVerdictToEvaluate {
|
|
|
2297
2282
|
$unknown?: never;
|
|
2298
2283
|
}
|
|
2299
2284
|
/**
|
|
2300
|
-
* <p>The Add On ARN and its returned value to evaluate in a verdict condition
|
|
2301
|
-
* expression.</p>
|
|
2285
|
+
* <p>The Add On ARN and its returned value to evaluate in a verdict condition expression.</p>
|
|
2302
2286
|
* @public
|
|
2303
2287
|
*/
|
|
2304
2288
|
interface AnalysisMember {
|
|
@@ -2363,18 +2347,13 @@ export interface RuleVerdictExpression {
|
|
|
2363
2347
|
*/
|
|
2364
2348
|
Operator: RuleVerdictOperator | undefined;
|
|
2365
2349
|
/**
|
|
2366
|
-
* <p>The values to match with the email's verdict using the given operator. For the EQUALS
|
|
2367
|
-
* operator, if multiple values are given, the condition is deemed to match if any of the
|
|
2368
|
-
* given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values
|
|
2369
|
-
* are given, the condition is deemed to match of none of the given verdicts match the
|
|
2370
|
-
* verdict of the email.</p>
|
|
2350
|
+
* <p>The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email.</p>
|
|
2371
2351
|
* @public
|
|
2372
2352
|
*/
|
|
2373
2353
|
Values: RuleVerdict[] | undefined;
|
|
2374
2354
|
}
|
|
2375
2355
|
/**
|
|
2376
|
-
* <p>The conditional expression used to evaluate an email for determining if a rule action
|
|
2377
|
-
* should be taken.</p>
|
|
2356
|
+
* <p>The conditional expression used to evaluate an email for determining if a rule action should be taken.</p>
|
|
2378
2357
|
* @public
|
|
2379
2358
|
*/
|
|
2380
2359
|
export type RuleCondition = RuleCondition.BooleanExpressionMember | RuleCondition.DmarcExpressionMember | RuleCondition.IpExpressionMember | RuleCondition.NumberExpressionMember | RuleCondition.StringExpressionMember | RuleCondition.VerdictExpressionMember | RuleCondition.$UnknownMember;
|
|
@@ -2484,12 +2463,7 @@ export declare namespace RuleCondition {
|
|
|
2484
2463
|
const visit: <T>(value: RuleCondition, visitor: Visitor<T>) => T;
|
|
2485
2464
|
}
|
|
2486
2465
|
/**
|
|
2487
|
-
* <p>A rule contains conditions, "unless conditions" and actions. For each
|
|
2488
|
-
* envelope recipient of an email, if all conditions match and none of the "unless
|
|
2489
|
-
* conditions" match, then all of the actions are executed sequentially. If no
|
|
2490
|
-
* conditions are provided, the rule always applies and the actions are implicitly
|
|
2491
|
-
* executed. If only "unless conditions" are provided, the rule applies if the
|
|
2492
|
-
* email does not match the evaluation of the "unless conditions".</p>
|
|
2466
|
+
* <p>A rule contains conditions, "unless conditions" and actions. For each envelope recipient of an email, if all conditions match and none of the "unless conditions" match, then all of the actions are executed sequentially. If no conditions are provided, the rule always applies and the actions are implicitly executed. If only "unless conditions" are provided, the rule applies if the email does not match the evaluation of the "unless conditions".</p>
|
|
2493
2467
|
* @public
|
|
2494
2468
|
*/
|
|
2495
2469
|
export interface Rule {
|
|
@@ -2499,22 +2473,17 @@ export interface Rule {
|
|
|
2499
2473
|
*/
|
|
2500
2474
|
Name?: string | undefined;
|
|
2501
2475
|
/**
|
|
2502
|
-
* <p>The conditions of this rule. All conditions must match the email for the actions to be
|
|
2503
|
-
* executed. An empty list of conditions means that all emails match, but are still subject
|
|
2504
|
-
* to any "unless conditions"</p>
|
|
2476
|
+
* <p>The conditions of this rule. All conditions must match the email for the actions to be executed. An empty list of conditions means that all emails match, but are still subject to any "unless conditions"</p>
|
|
2505
2477
|
* @public
|
|
2506
2478
|
*/
|
|
2507
2479
|
Conditions?: RuleCondition[] | undefined;
|
|
2508
2480
|
/**
|
|
2509
|
-
* <p>The "unless conditions" of this rule. None of the conditions can match the
|
|
2510
|
-
* email for the actions to be executed. If any of these conditions do match the email,
|
|
2511
|
-
* then the actions are not executed.</p>
|
|
2481
|
+
* <p>The "unless conditions" of this rule. None of the conditions can match the email for the actions to be executed. If any of these conditions do match the email, then the actions are not executed.</p>
|
|
2512
2482
|
* @public
|
|
2513
2483
|
*/
|
|
2514
2484
|
Unless?: RuleCondition[] | undefined;
|
|
2515
2485
|
/**
|
|
2516
|
-
* <p>The list of actions to execute when the conditions match the incoming email, and none
|
|
2517
|
-
* of the "unless conditions" match.</p>
|
|
2486
|
+
* <p>The list of actions to execute when the conditions match the incoming email, and none of the "unless conditions" match.</p>
|
|
2518
2487
|
* @public
|
|
2519
2488
|
*/
|
|
2520
2489
|
Actions: RuleAction[] | undefined;
|
|
@@ -2524,8 +2493,7 @@ export interface Rule {
|
|
|
2524
2493
|
*/
|
|
2525
2494
|
export interface CreateRuleSetRequest {
|
|
2526
2495
|
/**
|
|
2527
|
-
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same
|
|
2528
|
-
* request.</p>
|
|
2496
|
+
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
|
|
2529
2497
|
* @public
|
|
2530
2498
|
*/
|
|
2531
2499
|
ClientToken?: string | undefined;
|
|
@@ -2556,8 +2524,7 @@ export interface CreateRuleSetResponse {
|
|
|
2556
2524
|
RuleSetId: string | undefined;
|
|
2557
2525
|
}
|
|
2558
2526
|
/**
|
|
2559
|
-
* <p>The Add On ARN and its returned value that is evaluated in a policy statement's
|
|
2560
|
-
* conditional expression to either deny or block the incoming email.</p>
|
|
2527
|
+
* <p>The Add On ARN and its returned value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.</p>
|
|
2561
2528
|
* @public
|
|
2562
2529
|
*/
|
|
2563
2530
|
export interface IngressAnalysis {
|
|
@@ -2584,8 +2551,7 @@ export declare const IngressAddressListEmailAttribute: {
|
|
|
2584
2551
|
*/
|
|
2585
2552
|
export type IngressAddressListEmailAttribute = (typeof IngressAddressListEmailAttribute)[keyof typeof IngressAddressListEmailAttribute];
|
|
2586
2553
|
/**
|
|
2587
|
-
* <p>The address lists and the address list attribute value that is evaluated in a policy statement's
|
|
2588
|
-
* conditional expression to either deny or block the incoming email.</p>
|
|
2554
|
+
* <p>The address lists and the address list attribute value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.</p>
|
|
2589
2555
|
* @public
|
|
2590
2556
|
*/
|
|
2591
2557
|
export interface IngressIsInAddressList {
|
|
@@ -2601,8 +2567,7 @@ export interface IngressIsInAddressList {
|
|
|
2601
2567
|
AddressLists: string[] | undefined;
|
|
2602
2568
|
}
|
|
2603
2569
|
/**
|
|
2604
|
-
* <p>The union type representing the allowed types of operands for a boolean
|
|
2605
|
-
* condition.</p>
|
|
2570
|
+
* <p>The union type representing the allowed types of operands for a boolean condition.</p>
|
|
2606
2571
|
* @public
|
|
2607
2572
|
*/
|
|
2608
2573
|
export type IngressBooleanToEvaluate = IngressBooleanToEvaluate.AnalysisMember | IngressBooleanToEvaluate.IsInAddressListMember | IngressBooleanToEvaluate.$UnknownMember;
|
|
@@ -2611,8 +2576,7 @@ export type IngressBooleanToEvaluate = IngressBooleanToEvaluate.AnalysisMember |
|
|
|
2611
2576
|
*/
|
|
2612
2577
|
export declare namespace IngressBooleanToEvaluate {
|
|
2613
2578
|
/**
|
|
2614
|
-
* <p>The structure type for a boolean condition stating the Add On ARN and its returned
|
|
2615
|
-
* value.</p>
|
|
2579
|
+
* <p>The structure type for a boolean condition stating the Add On ARN and its returned value.</p>
|
|
2616
2580
|
* @public
|
|
2617
2581
|
*/
|
|
2618
2582
|
interface AnalysisMember {
|
|
@@ -2726,8 +2690,7 @@ export declare const IngressIpOperator: {
|
|
|
2726
2690
|
*/
|
|
2727
2691
|
export type IngressIpOperator = (typeof IngressIpOperator)[keyof typeof IngressIpOperator];
|
|
2728
2692
|
/**
|
|
2729
|
-
* <p>The union type representing the allowed types for the left hand side of an IP
|
|
2730
|
-
* condition.</p>
|
|
2693
|
+
* <p>The union type representing the allowed types for the left hand side of an IP condition.</p>
|
|
2731
2694
|
* @public
|
|
2732
2695
|
*/
|
|
2733
2696
|
export interface IngressIpv4Expression {
|
|
@@ -2821,8 +2784,7 @@ export declare const IngressStringEmailAttribute: {
|
|
|
2821
2784
|
*/
|
|
2822
2785
|
export type IngressStringEmailAttribute = (typeof IngressStringEmailAttribute)[keyof typeof IngressStringEmailAttribute];
|
|
2823
2786
|
/**
|
|
2824
|
-
* <p>The union type representing the allowed types for the left hand side of a string
|
|
2825
|
-
* condition.</p>
|
|
2787
|
+
* <p>The union type representing the allowed types for the left hand side of a string condition.</p>
|
|
2826
2788
|
* @public
|
|
2827
2789
|
*/
|
|
2828
2790
|
export type IngressStringToEvaluate = IngressStringToEvaluate.AnalysisMember | IngressStringToEvaluate.AttributeMember | IngressStringToEvaluate.$UnknownMember;
|
|
@@ -2911,8 +2873,7 @@ export declare const IngressTlsAttribute: {
|
|
|
2911
2873
|
*/
|
|
2912
2874
|
export type IngressTlsAttribute = (typeof IngressTlsAttribute)[keyof typeof IngressTlsAttribute];
|
|
2913
2875
|
/**
|
|
2914
|
-
* <p>The union type representing the allowed types for the left hand side of a TLS
|
|
2915
|
-
* condition.</p>
|
|
2876
|
+
* <p>The union type representing the allowed types for the left hand side of a TLS condition.</p>
|
|
2916
2877
|
* @public
|
|
2917
2878
|
*/
|
|
2918
2879
|
export type IngressTlsProtocolToEvaluate = IngressTlsProtocolToEvaluate.AttributeMember | IngressTlsProtocolToEvaluate.$UnknownMember;
|
|
@@ -2987,8 +2948,7 @@ export interface IngressTlsProtocolExpression {
|
|
|
2987
2948
|
Value: IngressTlsProtocolAttribute | undefined;
|
|
2988
2949
|
}
|
|
2989
2950
|
/**
|
|
2990
|
-
* <p>The email traffic filtering conditions which are contained in a traffic policy
|
|
2991
|
-
* resource.</p>
|
|
2951
|
+
* <p>The email traffic filtering conditions which are contained in a traffic policy resource.</p>
|
|
2992
2952
|
* @public
|
|
2993
2953
|
*/
|
|
2994
2954
|
export type PolicyCondition = PolicyCondition.BooleanExpressionMember | PolicyCondition.IpExpressionMember | PolicyCondition.Ipv6ExpressionMember | PolicyCondition.StringExpressionMember | PolicyCondition.TlsExpressionMember | PolicyCondition.$UnknownMember;
|
|
@@ -2997,9 +2957,7 @@ export type PolicyCondition = PolicyCondition.BooleanExpressionMember | PolicyCo
|
|
|
2997
2957
|
*/
|
|
2998
2958
|
export declare namespace PolicyCondition {
|
|
2999
2959
|
/**
|
|
3000
|
-
* <p>This represents a string based condition matching on the incoming mail. It performs
|
|
3001
|
-
* the string operation configured in 'Operator' and evaluates the 'Protocol' object
|
|
3002
|
-
* against the 'Value'.</p>
|
|
2960
|
+
* <p>This represents a string based condition matching on the incoming mail. It performs the string operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.</p>
|
|
3003
2961
|
* @public
|
|
3004
2962
|
*/
|
|
3005
2963
|
interface StringExpressionMember {
|
|
@@ -3011,9 +2969,7 @@ export declare namespace PolicyCondition {
|
|
|
3011
2969
|
$unknown?: never;
|
|
3012
2970
|
}
|
|
3013
2971
|
/**
|
|
3014
|
-
* <p>This represents an IP based condition matching on the incoming mail. It performs the
|
|
3015
|
-
* operation configured in 'Operator' and evaluates the 'Protocol' object against the
|
|
3016
|
-
* 'Value'.</p>
|
|
2972
|
+
* <p>This represents an IP based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.</p>
|
|
3017
2973
|
* @public
|
|
3018
2974
|
*/
|
|
3019
2975
|
interface IpExpressionMember {
|
|
@@ -3025,9 +2981,7 @@ export declare namespace PolicyCondition {
|
|
|
3025
2981
|
$unknown?: never;
|
|
3026
2982
|
}
|
|
3027
2983
|
/**
|
|
3028
|
-
* <p>This represents an IPv6 based condition matching on the incoming mail. It performs the
|
|
3029
|
-
* operation configured in 'Operator' and evaluates the 'Protocol' object against the
|
|
3030
|
-
* 'Value'.</p>
|
|
2984
|
+
* <p>This represents an IPv6 based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.</p>
|
|
3031
2985
|
* @public
|
|
3032
2986
|
*/
|
|
3033
2987
|
interface Ipv6ExpressionMember {
|
|
@@ -3039,9 +2993,7 @@ export declare namespace PolicyCondition {
|
|
|
3039
2993
|
$unknown?: never;
|
|
3040
2994
|
}
|
|
3041
2995
|
/**
|
|
3042
|
-
* <p>This represents a TLS based condition matching on the incoming mail. It performs the
|
|
3043
|
-
* operation configured in 'Operator' and evaluates the 'Protocol' object against the
|
|
3044
|
-
* 'Value'.</p>
|
|
2996
|
+
* <p>This represents a TLS based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.</p>
|
|
3045
2997
|
* @public
|
|
3046
2998
|
*/
|
|
3047
2999
|
interface TlsExpressionMember {
|
|
@@ -3053,9 +3005,7 @@ export declare namespace PolicyCondition {
|
|
|
3053
3005
|
$unknown?: never;
|
|
3054
3006
|
}
|
|
3055
3007
|
/**
|
|
3056
|
-
* <p>This represents a boolean type condition matching on the incoming mail. It performs
|
|
3057
|
-
* the boolean operation configured in 'Operator' and evaluates the 'Protocol' object
|
|
3058
|
-
* against the 'Value'.</p>
|
|
3008
|
+
* <p>This represents a boolean type condition matching on the incoming mail. It performs the boolean operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.</p>
|
|
3059
3009
|
* @public
|
|
3060
3010
|
*/
|
|
3061
3011
|
interface BooleanExpressionMember {
|
|
@@ -3093,14 +3043,12 @@ export declare namespace PolicyCondition {
|
|
|
3093
3043
|
*/
|
|
3094
3044
|
export interface PolicyStatement {
|
|
3095
3045
|
/**
|
|
3096
|
-
* <p>The list of conditions to apply to incoming messages for filtering email
|
|
3097
|
-
* traffic.</p>
|
|
3046
|
+
* <p>The list of conditions to apply to incoming messages for filtering email traffic.</p>
|
|
3098
3047
|
* @public
|
|
3099
3048
|
*/
|
|
3100
3049
|
Conditions: PolicyCondition[] | undefined;
|
|
3101
3050
|
/**
|
|
3102
|
-
* <p>The action that informs a traffic policy resource to either allow or block the email
|
|
3103
|
-
* if it matches a condition in the policy statement.</p>
|
|
3051
|
+
* <p>The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.</p>
|
|
3104
3052
|
* @public
|
|
3105
3053
|
*/
|
|
3106
3054
|
Action: AcceptAction | undefined;
|
|
@@ -3110,8 +3058,7 @@ export interface PolicyStatement {
|
|
|
3110
3058
|
*/
|
|
3111
3059
|
export interface CreateTrafficPolicyRequest {
|
|
3112
3060
|
/**
|
|
3113
|
-
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same
|
|
3114
|
-
* request.</p>
|
|
3061
|
+
* <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
|
|
3115
3062
|
* @public
|
|
3116
3063
|
*/
|
|
3117
3064
|
ClientToken?: string | undefined;
|
|
@@ -3131,8 +3078,7 @@ export interface CreateTrafficPolicyRequest {
|
|
|
3131
3078
|
*/
|
|
3132
3079
|
DefaultAction: AcceptAction | undefined;
|
|
3133
3080
|
/**
|
|
3134
|
-
* <p>The maximum message size in bytes of email which is allowed in by this traffic
|
|
3135
|
-
* policy—anything larger will be blocked.</p>
|
|
3081
|
+
* <p>The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.</p>
|
|
3136
3082
|
* @public
|
|
3137
3083
|
*/
|
|
3138
3084
|
MaxMessageSizeBytes?: number | undefined;
|
|
@@ -3556,26 +3502,22 @@ export interface Metadata {
|
|
|
3556
3502
|
*/
|
|
3557
3503
|
SendingMethod?: string | undefined;
|
|
3558
3504
|
/**
|
|
3559
|
-
* <p>The identity name used to authorize the sending action when sent through a configuration set with
|
|
3560
|
-
* archiving enabled.</p>
|
|
3505
|
+
* <p>The identity name used to authorize the sending action when sent through a configuration set with archiving enabled.</p>
|
|
3561
3506
|
* @public
|
|
3562
3507
|
*/
|
|
3563
3508
|
SourceIdentity?: string | undefined;
|
|
3564
3509
|
/**
|
|
3565
|
-
* <p>The name of the dedicated IP pool used when sent through a configuration set with archiving
|
|
3566
|
-
* enabled.</p>
|
|
3510
|
+
* <p>The name of the dedicated IP pool used when sent through a configuration set with archiving enabled.</p>
|
|
3567
3511
|
* @public
|
|
3568
3512
|
*/
|
|
3569
3513
|
SendingPool?: string | undefined;
|
|
3570
3514
|
/**
|
|
3571
|
-
* <p>The name of the configuration set used when sent through a configuration set with archiving
|
|
3572
|
-
* enabled.</p>
|
|
3515
|
+
* <p>The name of the configuration set used when sent through a configuration set with archiving enabled.</p>
|
|
3573
3516
|
* @public
|
|
3574
3517
|
*/
|
|
3575
3518
|
ConfigurationSet?: string | undefined;
|
|
3576
3519
|
/**
|
|
3577
|
-
* <p>Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a
|
|
3578
|
-
* Configuration Set's Archive ARN.</p>
|
|
3520
|
+
* <p>Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.</p>
|
|
3579
3521
|
* @public
|
|
3580
3522
|
*/
|
|
3581
3523
|
SourceArn?: string | undefined;
|
|
@@ -3829,16 +3771,7 @@ export interface Row {
|
|
|
3829
3771
|
*/
|
|
3830
3772
|
SenderHostname?: string | undefined;
|
|
3831
3773
|
/**
|
|
3832
|
-
* <ul>
|
|
3833
|
-
* <li>
|
|
3834
|
-
* <p>Mail archived with Mail Manager: The IP address of the client that connects to
|
|
3835
|
-
* the ingress endpoint.</p>
|
|
3836
|
-
* </li>
|
|
3837
|
-
* <li>
|
|
3838
|
-
* <p>Mail sent through a configuration set with the
|
|
3839
|
-
* archiving option enabled: The IP address of the client that makes the SendEmail API call.</p>
|
|
3840
|
-
* </li>
|
|
3841
|
-
* </ul>
|
|
3774
|
+
* <ul> <li> <p>Mail archived with Mail Manager: The IP address of the client that connects to the ingress endpoint.</p> </li> <li> <p>Mail sent through a configuration set with the archiving option enabled: The IP address of the client that makes the SendEmail API call.</p> </li> </ul>
|
|
3842
3775
|
* @public
|
|
3843
3776
|
*/
|
|
3844
3777
|
SenderIpAddress?: string | undefined;
|
|
@@ -3848,8 +3781,7 @@ export interface Row {
|
|
|
3848
3781
|
*/
|
|
3849
3782
|
Envelope?: Envelope | undefined;
|
|
3850
3783
|
/**
|
|
3851
|
-
* <p>Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a
|
|
3852
|
-
* Configuration Set's Archive ARN.</p>
|
|
3784
|
+
* <p>Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.</p>
|
|
3853
3785
|
* @public
|
|
3854
3786
|
*/
|
|
3855
3787
|
SourceArn?: string | undefined;
|
|
@@ -3907,8 +3839,7 @@ export interface IngressPointAuthConfiguration {
|
|
|
3907
3839
|
*/
|
|
3908
3840
|
IngressPointPasswordConfiguration?: IngressPointPasswordConfiguration | undefined;
|
|
3909
3841
|
/**
|
|
3910
|
-
* <p>The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint
|
|
3911
|
-
* resource.</p>
|
|
3842
|
+
* <p>The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint resource.</p>
|
|
3912
3843
|
* @public
|
|
3913
3844
|
*/
|
|
3914
3845
|
SecretArn?: string | undefined;
|
|
@@ -3959,9 +3890,7 @@ export interface GetIngressPointResponse {
|
|
|
3959
3890
|
*/
|
|
3960
3891
|
Type?: IngressPointType | undefined;
|
|
3961
3892
|
/**
|
|
3962
|
-
* <p>
|
|
3963
|
-
* The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.
|
|
3964
|
-
* </p>
|
|
3893
|
+
* <p> The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager. </p>
|
|
3965
3894
|
* @public
|
|
3966
3895
|
*/
|
|
3967
3896
|
ARecord?: string | undefined;
|
|
@@ -3971,8 +3900,7 @@ export interface GetIngressPointResponse {
|
|
|
3971
3900
|
*/
|
|
3972
3901
|
RuleSetId?: string | undefined;
|
|
3973
3902
|
/**
|
|
3974
|
-
* <p>The identifier of the traffic policy resource associated with the ingress
|
|
3975
|
-
* endpoint.</p>
|
|
3903
|
+
* <p>The identifier of the traffic policy resource associated with the ingress endpoint.</p>
|
|
3976
3904
|
* @public
|
|
3977
3905
|
*/
|
|
3978
3906
|
TrafficPolicyId?: string | undefined;
|
|
@@ -4067,8 +3995,7 @@ export interface GetRelayResponse {
|
|
|
4067
3995
|
*/
|
|
4068
3996
|
ServerPort?: number | undefined;
|
|
4069
3997
|
/**
|
|
4070
|
-
* <p>The authentication attribute—contains the secret ARN where the customer relay
|
|
4071
|
-
* server credentials are stored. </p>
|
|
3998
|
+
* <p>The authentication attribute—contains the secret ARN where the customer relay server credentials are stored. </p>
|
|
4072
3999
|
* @public
|
|
4073
4000
|
*/
|
|
4074
4001
|
Authentication?: RelayAuthentication | undefined;
|
|
@@ -4163,8 +4090,7 @@ export interface GetTrafficPolicyResponse {
|
|
|
4163
4090
|
*/
|
|
4164
4091
|
PolicyStatements?: PolicyStatement[] | undefined;
|
|
4165
4092
|
/**
|
|
4166
|
-
* <p>The maximum message size in bytes of email which is allowed in by this traffic
|
|
4167
|
-
* policy—anything larger will be blocked.</p>
|
|
4093
|
+
* <p>The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.</p>
|
|
4168
4094
|
* @public
|
|
4169
4095
|
*/
|
|
4170
4096
|
MaxMessageSizeBytes?: number | undefined;
|
|
@@ -4276,9 +4202,7 @@ export interface IngressPoint {
|
|
|
4276
4202
|
*/
|
|
4277
4203
|
Type: IngressPointType | undefined;
|
|
4278
4204
|
/**
|
|
4279
|
-
* <p>
|
|
4280
|
-
* The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.
|
|
4281
|
-
* </p>
|
|
4205
|
+
* <p> The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager. </p>
|
|
4282
4206
|
* @public
|
|
4283
4207
|
*/
|
|
4284
4208
|
ARecord?: string | undefined;
|
|
@@ -4288,8 +4212,7 @@ export interface IngressPoint {
|
|
|
4288
4212
|
*/
|
|
4289
4213
|
export interface ListIngressPointsRequest {
|
|
4290
4214
|
/**
|
|
4291
|
-
* <p>The maximum number of ingress endpoint resources that are returned per call. You can
|
|
4292
|
-
* use NextToken to obtain further ingress endpoints.</p>
|
|
4215
|
+
* <p>The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.</p>
|
|
4293
4216
|
* @public
|
|
4294
4217
|
*/
|
|
4295
4218
|
PageSize?: number | undefined;
|
|
@@ -4346,20 +4269,17 @@ export interface UpdateIngressPointRequest {
|
|
|
4346
4269
|
*/
|
|
4347
4270
|
StatusToUpdate?: IngressPointStatusToUpdate | undefined;
|
|
4348
4271
|
/**
|
|
4349
|
-
* <p>The identifier of an existing rule set that you attach to an ingress endpoint
|
|
4350
|
-
* resource.</p>
|
|
4272
|
+
* <p>The identifier of an existing rule set that you attach to an ingress endpoint resource.</p>
|
|
4351
4273
|
* @public
|
|
4352
4274
|
*/
|
|
4353
4275
|
RuleSetId?: string | undefined;
|
|
4354
4276
|
/**
|
|
4355
|
-
* <p>The identifier of an existing traffic policy that you attach to an ingress endpoint
|
|
4356
|
-
* resource.</p>
|
|
4277
|
+
* <p>The identifier of an existing traffic policy that you attach to an ingress endpoint resource.</p>
|
|
4357
4278
|
* @public
|
|
4358
4279
|
*/
|
|
4359
4280
|
TrafficPolicyId?: string | undefined;
|
|
4360
4281
|
/**
|
|
4361
|
-
* <p>If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret
|
|
4362
|
-
* ARN.</p>
|
|
4282
|
+
* <p>If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.</p>
|
|
4363
4283
|
* @public
|
|
4364
4284
|
*/
|
|
4365
4285
|
IngressPointConfiguration?: IngressPointConfiguration | undefined;
|
|
@@ -4415,16 +4335,12 @@ export interface ListArchiveExportsRequest {
|
|
|
4415
4335
|
*/
|
|
4416
4336
|
ArchiveId: string | undefined;
|
|
4417
4337
|
/**
|
|
4418
|
-
* <p>If NextToken is returned, there are more results available. The value of NextToken is a unique pagination
|
|
4419
|
-
* token for each page. Make the call again using the returned token to retrieve the next page.
|
|
4420
|
-
* </p>
|
|
4338
|
+
* <p>If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. </p>
|
|
4421
4339
|
* @public
|
|
4422
4340
|
*/
|
|
4423
4341
|
NextToken?: string | undefined;
|
|
4424
4342
|
/**
|
|
4425
|
-
* <p>The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain
|
|
4426
|
-
* further pages of archives.
|
|
4427
|
-
* </p>
|
|
4343
|
+
* <p>The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain further pages of archives. </p>
|
|
4428
4344
|
* @public
|
|
4429
4345
|
*/
|
|
4430
4346
|
PageSize?: number | undefined;
|
|
@@ -4456,16 +4372,12 @@ export interface ListArchiveSearchesRequest {
|
|
|
4456
4372
|
*/
|
|
4457
4373
|
ArchiveId: string | undefined;
|
|
4458
4374
|
/**
|
|
4459
|
-
* <p>If NextToken is returned, there are more results available. The value of NextToken is a unique pagination
|
|
4460
|
-
* token for each page. Make the call again using the returned token to retrieve the next page.
|
|
4461
|
-
* </p>
|
|
4375
|
+
* <p>If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. </p>
|
|
4462
4376
|
* @public
|
|
4463
4377
|
*/
|
|
4464
4378
|
NextToken?: string | undefined;
|
|
4465
4379
|
/**
|
|
4466
|
-
* <p>The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain
|
|
4467
|
-
* further pages of archives.
|
|
4468
|
-
* </p>
|
|
4380
|
+
* <p>The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives. </p>
|
|
4469
4381
|
* @public
|
|
4470
4382
|
*/
|
|
4471
4383
|
PageSize?: number | undefined;
|
|
@@ -4522,8 +4434,7 @@ export interface ListMembersOfAddressListRequest {
|
|
|
4522
4434
|
*/
|
|
4523
4435
|
NextToken?: string | undefined;
|
|
4524
4436
|
/**
|
|
4525
|
-
* <p>The maximum number of address list members that are returned per call.
|
|
4526
|
-
* You can use NextToken to retrieve the next page of members.</p>
|
|
4437
|
+
* <p>The maximum number of address list members that are returned per call. You can use NextToken to retrieve the next page of members.</p>
|
|
4527
4438
|
* @public
|
|
4528
4439
|
*/
|
|
4529
4440
|
PageSize?: number | undefined;
|
|
@@ -4575,8 +4486,7 @@ export interface ListRelaysRequest {
|
|
|
4575
4486
|
NextToken?: string | undefined;
|
|
4576
4487
|
}
|
|
4577
4488
|
/**
|
|
4578
|
-
* <p>The relay resource that can be used as a rule to relay receiving emails to the destination
|
|
4579
|
-
* relay server.</p>
|
|
4489
|
+
* <p>The relay resource that can be used as a rule to relay receiving emails to the destination relay server.</p>
|
|
4580
4490
|
* @public
|
|
4581
4491
|
*/
|
|
4582
4492
|
export interface Relay {
|
|
@@ -4621,15 +4531,13 @@ export interface ListRuleSetsRequest {
|
|
|
4621
4531
|
*/
|
|
4622
4532
|
NextToken?: string | undefined;
|
|
4623
4533
|
/**
|
|
4624
|
-
* <p>The maximum number of rule set resources that are returned per call. You can use
|
|
4625
|
-
* NextToken to obtain further rule sets.</p>
|
|
4534
|
+
* <p>The maximum number of rule set resources that are returned per call. You can use NextToken to obtain further rule sets.</p>
|
|
4626
4535
|
* @public
|
|
4627
4536
|
*/
|
|
4628
4537
|
PageSize?: number | undefined;
|
|
4629
4538
|
}
|
|
4630
4539
|
/**
|
|
4631
|
-
* <p>A rule set contains a list of rules that are evaluated in order. Each rule is
|
|
4632
|
-
* evaluated sequentially for each email.</p>
|
|
4540
|
+
* <p>A rule set contains a list of rules that are evaluated in order. Each rule is evaluated sequentially for each email.</p>
|
|
4633
4541
|
* @public
|
|
4634
4542
|
*/
|
|
4635
4543
|
export interface RuleSet {
|
|
@@ -4689,8 +4597,7 @@ export interface ListTagsForResourceResponse {
|
|
|
4689
4597
|
*/
|
|
4690
4598
|
export interface ListTrafficPoliciesRequest {
|
|
4691
4599
|
/**
|
|
4692
|
-
* <p>The maximum number of traffic policy resources that are returned per call. You can use
|
|
4693
|
-
* NextToken to obtain further traffic policies.</p>
|
|
4600
|
+
* <p>The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.</p>
|
|
4694
4601
|
* @public
|
|
4695
4602
|
*/
|
|
4696
4603
|
PageSize?: number | undefined;
|
|
@@ -4701,8 +4608,7 @@ export interface ListTrafficPoliciesRequest {
|
|
|
4701
4608
|
NextToken?: string | undefined;
|
|
4702
4609
|
}
|
|
4703
4610
|
/**
|
|
4704
|
-
* <p>The structure of a traffic policy resource which is a container for policy
|
|
4705
|
-
* statements.</p>
|
|
4611
|
+
* <p>The structure of a traffic policy resource which is a container for policy statements.</p>
|
|
4706
4612
|
* @public
|
|
4707
4613
|
*/
|
|
4708
4614
|
export interface TrafficPolicy {
|
|
@@ -4782,8 +4688,7 @@ export interface UpdateRelayRequest {
|
|
|
4782
4688
|
*/
|
|
4783
4689
|
ServerPort?: number | undefined;
|
|
4784
4690
|
/**
|
|
4785
|
-
* <p>Authentication for the relay destination server—specify the secretARN where
|
|
4786
|
-
* the SMTP credentials are stored.</p>
|
|
4691
|
+
* <p>Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.</p>
|
|
4787
4692
|
* @public
|
|
4788
4693
|
*/
|
|
4789
4694
|
Authentication?: RelayAuthentication | undefined;
|
|
@@ -4808,8 +4713,7 @@ export interface UpdateRuleSetRequest {
|
|
|
4808
4713
|
*/
|
|
4809
4714
|
RuleSetName?: string | undefined;
|
|
4810
4715
|
/**
|
|
4811
|
-
* <p>A new set of rules to replace the current rules of the rule set—these rules will
|
|
4812
|
-
* override all the rules of the rule set.</p>
|
|
4716
|
+
* <p>A new set of rules to replace the current rules of the rule set—these rules will override all the rules of the rule set.</p>
|
|
4813
4717
|
* @public
|
|
4814
4718
|
*/
|
|
4815
4719
|
Rules?: Rule[] | undefined;
|
|
@@ -4955,8 +4859,7 @@ export interface StopArchiveExportRequest {
|
|
|
4955
4859
|
ExportId: string | undefined;
|
|
4956
4860
|
}
|
|
4957
4861
|
/**
|
|
4958
|
-
* <p>The response indicating if the request to stop the export job succeeded.</p>
|
|
4959
|
-
* <p>On success, returns an HTTP 200 status code. On failure, returns an error message.</p>
|
|
4862
|
+
* <p>The response indicating if the request to stop the export job succeeded.</p> <p>On success, returns an HTTP 200 status code. On failure, returns an error message.</p>
|
|
4960
4863
|
* @public
|
|
4961
4864
|
*/
|
|
4962
4865
|
export interface StopArchiveExportResponse {
|
|
@@ -4973,8 +4876,7 @@ export interface StopArchiveSearchRequest {
|
|
|
4973
4876
|
SearchId: string | undefined;
|
|
4974
4877
|
}
|
|
4975
4878
|
/**
|
|
4976
|
-
* <p>The response indicating if the request to stop the search job succeeded.</p>
|
|
4977
|
-
* <p>On success, returns an HTTP 200 status code. On failure, returns an error message.</p>
|
|
4879
|
+
* <p>The response indicating if the request to stop the search job succeeded.</p> <p>On success, returns an HTTP 200 status code. On failure, returns an error message.</p>
|
|
4978
4880
|
* @public
|
|
4979
4881
|
*/
|
|
4980
4882
|
export interface StopArchiveSearchResponse {
|
|
@@ -5024,8 +4926,7 @@ export interface UpdateTrafficPolicyRequest {
|
|
|
5024
4926
|
*/
|
|
5025
4927
|
DefaultAction?: AcceptAction | undefined;
|
|
5026
4928
|
/**
|
|
5027
|
-
* <p>The maximum message size in bytes of email which is allowed in by this traffic
|
|
5028
|
-
* policy—anything larger will be blocked.</p>
|
|
4929
|
+
* <p>The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.</p>
|
|
5029
4930
|
* @public
|
|
5030
4931
|
*/
|
|
5031
4932
|
MaxMessageSizeBytes?: number | undefined;
|
|
@@ -5045,8 +4946,7 @@ export interface UntagResourceRequest {
|
|
|
5045
4946
|
*/
|
|
5046
4947
|
ResourceArn: string | undefined;
|
|
5047
4948
|
/**
|
|
5048
|
-
* <p> The keys of the key-value pairs for the tag or tags you want to remove from the
|
|
5049
|
-
* specified resource. </p>
|
|
4949
|
+
* <p> The keys of the key-value pairs for the tag or tags you want to remove from the specified resource. </p>
|
|
5050
4950
|
* @public
|
|
5051
4951
|
*/
|
|
5052
4952
|
TagKeys: string[] | undefined;
|