aws-sdk-mailmanager 1.16.0 → 1.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-mailmanager/client.rb +543 -1
- data/lib/aws-sdk-mailmanager/client_api.rb +389 -0
- data/lib/aws-sdk-mailmanager/types.rb +691 -2
- data/lib/aws-sdk-mailmanager.rb +1 -1
- data/sig/client.rbs +197 -4
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +214 -1
- metadata +4 -4
@@ -257,11 +257,34 @@ module Aws::MailManager
|
|
257
257
|
# Used when loading credentials from the shared credentials file
|
258
258
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
259
259
|
#
|
260
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
261
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
262
|
+
#
|
263
|
+
# * `when_supported` - (default) When set, a checksum will be
|
264
|
+
# calculated for all request payloads of operations modeled with the
|
265
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
266
|
+
# `requestAlgorithmMember` is modeled.
|
267
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
268
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
269
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
270
|
+
# is modeled and supplied.
|
271
|
+
#
|
260
272
|
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
261
273
|
# The minimum size in bytes that triggers compression for request
|
262
274
|
# bodies. The value must be non-negative integer value between 0
|
263
275
|
# and 10485780 bytes inclusive.
|
264
276
|
#
|
277
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
278
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
279
|
+
#
|
280
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
281
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
282
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
283
|
+
# are supported.
|
284
|
+
# * `when_required` - When set, checksum validation is not performed on
|
285
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
286
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
287
|
+
#
|
265
288
|
# @option options [Proc] :retry_backoff
|
266
289
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
267
290
|
# This option is only used in the `legacy` retry mode.
|
@@ -555,6 +578,101 @@ module Aws::MailManager
|
|
555
578
|
req.send_request(options)
|
556
579
|
end
|
557
580
|
|
581
|
+
# Creates a new address list.
|
582
|
+
#
|
583
|
+
# @option params [required, String] :address_list_name
|
584
|
+
# A user-friendly name for the address list.
|
585
|
+
#
|
586
|
+
# @option params [String] :client_token
|
587
|
+
# A unique token that Amazon SES uses to recognize subsequent retries of
|
588
|
+
# the same request.
|
589
|
+
#
|
590
|
+
# **A suitable default value is auto-generated.** You should normally
|
591
|
+
# not need to pass this option.**
|
592
|
+
#
|
593
|
+
# @option params [Array<Types::Tag>] :tags
|
594
|
+
# The tags used to organize, track, or control access for the resource.
|
595
|
+
# For example, \{ "tags": \{"key1":"value1", "key2":"value2"}
|
596
|
+
# }.
|
597
|
+
#
|
598
|
+
# @return [Types::CreateAddressListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
599
|
+
#
|
600
|
+
# * {Types::CreateAddressListResponse#address_list_id #address_list_id} => String
|
601
|
+
#
|
602
|
+
# @example Request syntax with placeholder values
|
603
|
+
#
|
604
|
+
# resp = client.create_address_list({
|
605
|
+
# address_list_name: "AddressListName", # required
|
606
|
+
# client_token: "IdempotencyToken",
|
607
|
+
# tags: [
|
608
|
+
# {
|
609
|
+
# key: "TagKey", # required
|
610
|
+
# value: "TagValue", # required
|
611
|
+
# },
|
612
|
+
# ],
|
613
|
+
# })
|
614
|
+
#
|
615
|
+
# @example Response structure
|
616
|
+
#
|
617
|
+
# resp.address_list_id #=> String
|
618
|
+
#
|
619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateAddressList AWS API Documentation
|
620
|
+
#
|
621
|
+
# @overload create_address_list(params = {})
|
622
|
+
# @param [Hash] params ({})
|
623
|
+
def create_address_list(params = {}, options = {})
|
624
|
+
req = build_request(:create_address_list, params)
|
625
|
+
req.send_request(options)
|
626
|
+
end
|
627
|
+
|
628
|
+
# Creates an import job for an address list.
|
629
|
+
#
|
630
|
+
# @option params [required, String] :address_list_id
|
631
|
+
# The unique identifier of the address list for importing addresses to.
|
632
|
+
#
|
633
|
+
# @option params [String] :client_token
|
634
|
+
# A unique token that Amazon SES uses to recognize subsequent retries of
|
635
|
+
# the same request.
|
636
|
+
#
|
637
|
+
# **A suitable default value is auto-generated.** You should normally
|
638
|
+
# not need to pass this option.**
|
639
|
+
#
|
640
|
+
# @option params [required, Types::ImportDataFormat] :import_data_format
|
641
|
+
# The format of the input for an import job.
|
642
|
+
#
|
643
|
+
# @option params [required, String] :name
|
644
|
+
# A user-friendly name for the import job.
|
645
|
+
#
|
646
|
+
# @return [Types::CreateAddressListImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
647
|
+
#
|
648
|
+
# * {Types::CreateAddressListImportJobResponse#job_id #job_id} => String
|
649
|
+
# * {Types::CreateAddressListImportJobResponse#pre_signed_url #pre_signed_url} => String
|
650
|
+
#
|
651
|
+
# @example Request syntax with placeholder values
|
652
|
+
#
|
653
|
+
# resp = client.create_address_list_import_job({
|
654
|
+
# address_list_id: "AddressListId", # required
|
655
|
+
# client_token: "IdempotencyToken",
|
656
|
+
# import_data_format: { # required
|
657
|
+
# import_data_type: "CSV", # required, accepts CSV, JSON
|
658
|
+
# },
|
659
|
+
# name: "JobName", # required
|
660
|
+
# })
|
661
|
+
#
|
662
|
+
# @example Response structure
|
663
|
+
#
|
664
|
+
# resp.job_id #=> String
|
665
|
+
# resp.pre_signed_url #=> String
|
666
|
+
#
|
667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateAddressListImportJob AWS API Documentation
|
668
|
+
#
|
669
|
+
# @overload create_address_list_import_job(params = {})
|
670
|
+
# @param [Hash] params ({})
|
671
|
+
def create_address_list_import_job(params = {}, options = {})
|
672
|
+
req = build_request(:create_address_list_import_job, params)
|
673
|
+
req.send_request(options)
|
674
|
+
end
|
675
|
+
|
558
676
|
# Creates a new email archive resource for storing and retaining emails.
|
559
677
|
#
|
560
678
|
# @option params [required, String] :archive_name
|
@@ -827,6 +945,10 @@ module Aws::MailManager
|
|
827
945
|
# boolean_expression: {
|
828
946
|
# evaluate: { # required
|
829
947
|
# attribute: "READ_RECEIPT_REQUESTED", # accepts READ_RECEIPT_REQUESTED, TLS, TLS_WRAPPED
|
948
|
+
# is_in_address_list: {
|
949
|
+
# address_lists: ["AddressListArn"], # required
|
950
|
+
# attribute: "RECIPIENT", # required, accepts RECIPIENT, MAIL_FROM, SENDER, FROM, TO, CC
|
951
|
+
# },
|
830
952
|
# },
|
831
953
|
# operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
|
832
954
|
# },
|
@@ -875,6 +997,10 @@ module Aws::MailManager
|
|
875
997
|
# boolean_expression: {
|
876
998
|
# evaluate: { # required
|
877
999
|
# attribute: "READ_RECEIPT_REQUESTED", # accepts READ_RECEIPT_REQUESTED, TLS, TLS_WRAPPED
|
1000
|
+
# is_in_address_list: {
|
1001
|
+
# address_lists: ["AddressListArn"], # required
|
1002
|
+
# attribute: "RECIPIENT", # required, accepts RECIPIENT, MAIL_FROM, SENDER, FROM, TO, CC
|
1003
|
+
# },
|
878
1004
|
# },
|
879
1005
|
# operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
|
880
1006
|
# },
|
@@ -990,6 +1116,10 @@ module Aws::MailManager
|
|
990
1116
|
# analyzer: "AnalyzerArn", # required
|
991
1117
|
# result_field: "ResultField", # required
|
992
1118
|
# },
|
1119
|
+
# is_in_address_list: {
|
1120
|
+
# address_lists: ["AddressListArn"], # required
|
1121
|
+
# attribute: "RECIPIENT", # required, accepts RECIPIENT
|
1122
|
+
# },
|
993
1123
|
# },
|
994
1124
|
# operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
|
995
1125
|
# },
|
@@ -1084,6 +1214,28 @@ module Aws::MailManager
|
|
1084
1214
|
req.send_request(options)
|
1085
1215
|
end
|
1086
1216
|
|
1217
|
+
# Deletes an address list.
|
1218
|
+
#
|
1219
|
+
# @option params [required, String] :address_list_id
|
1220
|
+
# The identifier of an existing address list resource to delete.
|
1221
|
+
#
|
1222
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1223
|
+
#
|
1224
|
+
# @example Request syntax with placeholder values
|
1225
|
+
#
|
1226
|
+
# resp = client.delete_address_list({
|
1227
|
+
# address_list_id: "AddressListId", # required
|
1228
|
+
# })
|
1229
|
+
#
|
1230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeleteAddressList AWS API Documentation
|
1231
|
+
#
|
1232
|
+
# @overload delete_address_list(params = {})
|
1233
|
+
# @param [Hash] params ({})
|
1234
|
+
def delete_address_list(params = {}, options = {})
|
1235
|
+
req = build_request(:delete_address_list, params)
|
1236
|
+
req.send_request(options)
|
1237
|
+
end
|
1238
|
+
|
1087
1239
|
# Initiates deletion of an email archive. This changes the archive state
|
1088
1240
|
# to pending deletion. In this state, no new emails can be added, and
|
1089
1241
|
# existing archived emails become inaccessible (search, export,
|
@@ -1200,6 +1352,32 @@ module Aws::MailManager
|
|
1200
1352
|
req.send_request(options)
|
1201
1353
|
end
|
1202
1354
|
|
1355
|
+
# Removes a member from an address list.
|
1356
|
+
#
|
1357
|
+
# @option params [required, String] :address
|
1358
|
+
# The address to be removed from the address list.
|
1359
|
+
#
|
1360
|
+
# @option params [required, String] :address_list_id
|
1361
|
+
# The unique identifier of the address list to remove the address from.
|
1362
|
+
#
|
1363
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1364
|
+
#
|
1365
|
+
# @example Request syntax with placeholder values
|
1366
|
+
#
|
1367
|
+
# resp = client.deregister_member_from_address_list({
|
1368
|
+
# address: "Address", # required
|
1369
|
+
# address_list_id: "AddressListId", # required
|
1370
|
+
# })
|
1371
|
+
#
|
1372
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/DeregisterMemberFromAddressList AWS API Documentation
|
1373
|
+
#
|
1374
|
+
# @overload deregister_member_from_address_list(params = {})
|
1375
|
+
# @param [Hash] params ({})
|
1376
|
+
def deregister_member_from_address_list(params = {}, options = {})
|
1377
|
+
req = build_request(:deregister_member_from_address_list, params)
|
1378
|
+
req.send_request(options)
|
1379
|
+
end
|
1380
|
+
|
1203
1381
|
# Gets detailed information about an Add On instance.
|
1204
1382
|
#
|
1205
1383
|
# @option params [required, String] :addon_instance_id
|
@@ -1266,6 +1444,92 @@ module Aws::MailManager
|
|
1266
1444
|
req.send_request(options)
|
1267
1445
|
end
|
1268
1446
|
|
1447
|
+
# Fetch attributes of an address list.
|
1448
|
+
#
|
1449
|
+
# @option params [required, String] :address_list_id
|
1450
|
+
# The identifier of an existing address list resource to be retrieved.
|
1451
|
+
#
|
1452
|
+
# @return [Types::GetAddressListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1453
|
+
#
|
1454
|
+
# * {Types::GetAddressListResponse#address_list_arn #address_list_arn} => String
|
1455
|
+
# * {Types::GetAddressListResponse#address_list_id #address_list_id} => String
|
1456
|
+
# * {Types::GetAddressListResponse#address_list_name #address_list_name} => String
|
1457
|
+
# * {Types::GetAddressListResponse#created_timestamp #created_timestamp} => Time
|
1458
|
+
# * {Types::GetAddressListResponse#last_updated_timestamp #last_updated_timestamp} => Time
|
1459
|
+
#
|
1460
|
+
# @example Request syntax with placeholder values
|
1461
|
+
#
|
1462
|
+
# resp = client.get_address_list({
|
1463
|
+
# address_list_id: "AddressListId", # required
|
1464
|
+
# })
|
1465
|
+
#
|
1466
|
+
# @example Response structure
|
1467
|
+
#
|
1468
|
+
# resp.address_list_arn #=> String
|
1469
|
+
# resp.address_list_id #=> String
|
1470
|
+
# resp.address_list_name #=> String
|
1471
|
+
# resp.created_timestamp #=> Time
|
1472
|
+
# resp.last_updated_timestamp #=> Time
|
1473
|
+
#
|
1474
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetAddressList AWS API Documentation
|
1475
|
+
#
|
1476
|
+
# @overload get_address_list(params = {})
|
1477
|
+
# @param [Hash] params ({})
|
1478
|
+
def get_address_list(params = {}, options = {})
|
1479
|
+
req = build_request(:get_address_list, params)
|
1480
|
+
req.send_request(options)
|
1481
|
+
end
|
1482
|
+
|
1483
|
+
# Fetch attributes of an import job.
|
1484
|
+
#
|
1485
|
+
# @option params [required, String] :job_id
|
1486
|
+
# The identifier of the import job that needs to be retrieved.
|
1487
|
+
#
|
1488
|
+
# @return [Types::GetAddressListImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1489
|
+
#
|
1490
|
+
# * {Types::GetAddressListImportJobResponse#address_list_id #address_list_id} => String
|
1491
|
+
# * {Types::GetAddressListImportJobResponse#completed_timestamp #completed_timestamp} => Time
|
1492
|
+
# * {Types::GetAddressListImportJobResponse#created_timestamp #created_timestamp} => Time
|
1493
|
+
# * {Types::GetAddressListImportJobResponse#error #error} => String
|
1494
|
+
# * {Types::GetAddressListImportJobResponse#failed_items_count #failed_items_count} => Integer
|
1495
|
+
# * {Types::GetAddressListImportJobResponse#import_data_format #import_data_format} => Types::ImportDataFormat
|
1496
|
+
# * {Types::GetAddressListImportJobResponse#imported_items_count #imported_items_count} => Integer
|
1497
|
+
# * {Types::GetAddressListImportJobResponse#job_id #job_id} => String
|
1498
|
+
# * {Types::GetAddressListImportJobResponse#name #name} => String
|
1499
|
+
# * {Types::GetAddressListImportJobResponse#pre_signed_url #pre_signed_url} => String
|
1500
|
+
# * {Types::GetAddressListImportJobResponse#start_timestamp #start_timestamp} => Time
|
1501
|
+
# * {Types::GetAddressListImportJobResponse#status #status} => String
|
1502
|
+
#
|
1503
|
+
# @example Request syntax with placeholder values
|
1504
|
+
#
|
1505
|
+
# resp = client.get_address_list_import_job({
|
1506
|
+
# job_id: "JobId", # required
|
1507
|
+
# })
|
1508
|
+
#
|
1509
|
+
# @example Response structure
|
1510
|
+
#
|
1511
|
+
# resp.address_list_id #=> String
|
1512
|
+
# resp.completed_timestamp #=> Time
|
1513
|
+
# resp.created_timestamp #=> Time
|
1514
|
+
# resp.error #=> String
|
1515
|
+
# resp.failed_items_count #=> Integer
|
1516
|
+
# resp.import_data_format.import_data_type #=> String, one of "CSV", "JSON"
|
1517
|
+
# resp.imported_items_count #=> Integer
|
1518
|
+
# resp.job_id #=> String
|
1519
|
+
# resp.name #=> String
|
1520
|
+
# resp.pre_signed_url #=> String
|
1521
|
+
# resp.start_timestamp #=> Time
|
1522
|
+
# resp.status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED", "STOPPED"
|
1523
|
+
#
|
1524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetAddressListImportJob AWS API Documentation
|
1525
|
+
#
|
1526
|
+
# @overload get_address_list_import_job(params = {})
|
1527
|
+
# @param [Hash] params ({})
|
1528
|
+
def get_address_list_import_job(params = {}, options = {})
|
1529
|
+
req = build_request(:get_address_list_import_job, params)
|
1530
|
+
req.send_request(options)
|
1531
|
+
end
|
1532
|
+
|
1269
1533
|
# Retrieves the full details and current state of a specified email
|
1270
1534
|
# archive.
|
1271
1535
|
#
|
@@ -1596,6 +1860,41 @@ module Aws::MailManager
|
|
1596
1860
|
req.send_request(options)
|
1597
1861
|
end
|
1598
1862
|
|
1863
|
+
# Fetch attributes of a member in an address list.
|
1864
|
+
#
|
1865
|
+
# @option params [required, String] :address
|
1866
|
+
# The address to be retrieved from the address list.
|
1867
|
+
#
|
1868
|
+
# @option params [required, String] :address_list_id
|
1869
|
+
# The unique identifier of the address list to retrieve the address
|
1870
|
+
# from.
|
1871
|
+
#
|
1872
|
+
# @return [Types::GetMemberOfAddressListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1873
|
+
#
|
1874
|
+
# * {Types::GetMemberOfAddressListResponse#address #address} => String
|
1875
|
+
# * {Types::GetMemberOfAddressListResponse#created_timestamp #created_timestamp} => Time
|
1876
|
+
#
|
1877
|
+
# @example Request syntax with placeholder values
|
1878
|
+
#
|
1879
|
+
# resp = client.get_member_of_address_list({
|
1880
|
+
# address: "Address", # required
|
1881
|
+
# address_list_id: "AddressListId", # required
|
1882
|
+
# })
|
1883
|
+
#
|
1884
|
+
# @example Response structure
|
1885
|
+
#
|
1886
|
+
# resp.address #=> String
|
1887
|
+
# resp.created_timestamp #=> Time
|
1888
|
+
#
|
1889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetMemberOfAddressList AWS API Documentation
|
1890
|
+
#
|
1891
|
+
# @overload get_member_of_address_list(params = {})
|
1892
|
+
# @param [Hash] params ({})
|
1893
|
+
def get_member_of_address_list(params = {}, options = {})
|
1894
|
+
req = build_request(:get_member_of_address_list, params)
|
1895
|
+
req.send_request(options)
|
1896
|
+
end
|
1897
|
+
|
1599
1898
|
# Fetch the relay resource and it's attributes.
|
1600
1899
|
#
|
1601
1900
|
# @option params [required, String] :relay_id
|
@@ -1692,6 +1991,9 @@ module Aws::MailManager
|
|
1692
1991
|
# resp.rules[0].actions[0].write_to_s3.s3_sse_kms_key_id #=> String
|
1693
1992
|
# resp.rules[0].conditions #=> Array
|
1694
1993
|
# resp.rules[0].conditions[0].boolean_expression.evaluate.attribute #=> String, one of "READ_RECEIPT_REQUESTED", "TLS", "TLS_WRAPPED"
|
1994
|
+
# resp.rules[0].conditions[0].boolean_expression.evaluate.is_in_address_list.address_lists #=> Array
|
1995
|
+
# resp.rules[0].conditions[0].boolean_expression.evaluate.is_in_address_list.address_lists[0] #=> String
|
1996
|
+
# resp.rules[0].conditions[0].boolean_expression.evaluate.is_in_address_list.attribute #=> String, one of "RECIPIENT", "MAIL_FROM", "SENDER", "FROM", "TO", "CC"
|
1695
1997
|
# resp.rules[0].conditions[0].boolean_expression.operator #=> String, one of "IS_TRUE", "IS_FALSE"
|
1696
1998
|
# resp.rules[0].conditions[0].dmarc_expression.operator #=> String, one of "EQUALS", "NOT_EQUALS"
|
1697
1999
|
# resp.rules[0].conditions[0].dmarc_expression.values #=> Array
|
@@ -1717,6 +2019,9 @@ module Aws::MailManager
|
|
1717
2019
|
# resp.rules[0].name #=> String
|
1718
2020
|
# resp.rules[0].unless #=> Array
|
1719
2021
|
# resp.rules[0].unless[0].boolean_expression.evaluate.attribute #=> String, one of "READ_RECEIPT_REQUESTED", "TLS", "TLS_WRAPPED"
|
2022
|
+
# resp.rules[0].unless[0].boolean_expression.evaluate.is_in_address_list.address_lists #=> Array
|
2023
|
+
# resp.rules[0].unless[0].boolean_expression.evaluate.is_in_address_list.address_lists[0] #=> String
|
2024
|
+
# resp.rules[0].unless[0].boolean_expression.evaluate.is_in_address_list.attribute #=> String, one of "RECIPIENT", "MAIL_FROM", "SENDER", "FROM", "TO", "CC"
|
1720
2025
|
# resp.rules[0].unless[0].boolean_expression.operator #=> String, one of "IS_TRUE", "IS_FALSE"
|
1721
2026
|
# resp.rules[0].unless[0].dmarc_expression.operator #=> String, one of "EQUALS", "NOT_EQUALS"
|
1722
2027
|
# resp.rules[0].unless[0].dmarc_expression.values #=> Array
|
@@ -1782,6 +2087,9 @@ module Aws::MailManager
|
|
1782
2087
|
# resp.policy_statements[0].conditions #=> Array
|
1783
2088
|
# resp.policy_statements[0].conditions[0].boolean_expression.evaluate.analysis.analyzer #=> String
|
1784
2089
|
# resp.policy_statements[0].conditions[0].boolean_expression.evaluate.analysis.result_field #=> String
|
2090
|
+
# resp.policy_statements[0].conditions[0].boolean_expression.evaluate.is_in_address_list.address_lists #=> Array
|
2091
|
+
# resp.policy_statements[0].conditions[0].boolean_expression.evaluate.is_in_address_list.address_lists[0] #=> String
|
2092
|
+
# resp.policy_statements[0].conditions[0].boolean_expression.evaluate.is_in_address_list.attribute #=> String, one of "RECIPIENT"
|
1785
2093
|
# resp.policy_statements[0].conditions[0].boolean_expression.operator #=> String, one of "IS_TRUE", "IS_FALSE"
|
1786
2094
|
# resp.policy_statements[0].conditions[0].ip_expression.evaluate.attribute #=> String, one of "SENDER_IP"
|
1787
2095
|
# resp.policy_statements[0].conditions[0].ip_expression.operator #=> String, one of "CIDR_MATCHES", "NOT_CIDR_MATCHES"
|
@@ -1894,6 +2202,106 @@ module Aws::MailManager
|
|
1894
2202
|
req.send_request(options)
|
1895
2203
|
end
|
1896
2204
|
|
2205
|
+
# Lists jobs for an address list.
|
2206
|
+
#
|
2207
|
+
# @option params [required, String] :address_list_id
|
2208
|
+
# The unique identifier of the address list for listing import jobs.
|
2209
|
+
#
|
2210
|
+
# @option params [String] :next_token
|
2211
|
+
# If you received a pagination token from a previous call to this API,
|
2212
|
+
# you can provide it here to continue paginating through the next page
|
2213
|
+
# of results.
|
2214
|
+
#
|
2215
|
+
# @option params [Integer] :page_size
|
2216
|
+
# The maximum number of import jobs that are returned per call. You can
|
2217
|
+
# use NextToken to retrieve the next page of jobs.
|
2218
|
+
#
|
2219
|
+
# @return [Types::ListAddressListImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2220
|
+
#
|
2221
|
+
# * {Types::ListAddressListImportJobsResponse#import_jobs #import_jobs} => Array<Types::ImportJob>
|
2222
|
+
# * {Types::ListAddressListImportJobsResponse#next_token #next_token} => String
|
2223
|
+
#
|
2224
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2225
|
+
#
|
2226
|
+
# @example Request syntax with placeholder values
|
2227
|
+
#
|
2228
|
+
# resp = client.list_address_list_import_jobs({
|
2229
|
+
# address_list_id: "AddressListId", # required
|
2230
|
+
# next_token: "PaginationToken",
|
2231
|
+
# page_size: 1,
|
2232
|
+
# })
|
2233
|
+
#
|
2234
|
+
# @example Response structure
|
2235
|
+
#
|
2236
|
+
# resp.import_jobs #=> Array
|
2237
|
+
# resp.import_jobs[0].address_list_id #=> String
|
2238
|
+
# resp.import_jobs[0].completed_timestamp #=> Time
|
2239
|
+
# resp.import_jobs[0].created_timestamp #=> Time
|
2240
|
+
# resp.import_jobs[0].error #=> String
|
2241
|
+
# resp.import_jobs[0].failed_items_count #=> Integer
|
2242
|
+
# resp.import_jobs[0].import_data_format.import_data_type #=> String, one of "CSV", "JSON"
|
2243
|
+
# resp.import_jobs[0].imported_items_count #=> Integer
|
2244
|
+
# resp.import_jobs[0].job_id #=> String
|
2245
|
+
# resp.import_jobs[0].name #=> String
|
2246
|
+
# resp.import_jobs[0].pre_signed_url #=> String
|
2247
|
+
# resp.import_jobs[0].start_timestamp #=> Time
|
2248
|
+
# resp.import_jobs[0].status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED", "STOPPED"
|
2249
|
+
# resp.next_token #=> String
|
2250
|
+
#
|
2251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListAddressListImportJobs AWS API Documentation
|
2252
|
+
#
|
2253
|
+
# @overload list_address_list_import_jobs(params = {})
|
2254
|
+
# @param [Hash] params ({})
|
2255
|
+
def list_address_list_import_jobs(params = {}, options = {})
|
2256
|
+
req = build_request(:list_address_list_import_jobs, params)
|
2257
|
+
req.send_request(options)
|
2258
|
+
end
|
2259
|
+
|
2260
|
+
# Lists address lists for this account.
|
2261
|
+
#
|
2262
|
+
# @option params [String] :next_token
|
2263
|
+
# If you received a pagination token from a previous call to this API,
|
2264
|
+
# you can provide it here to continue paginating through the next page
|
2265
|
+
# of results.
|
2266
|
+
#
|
2267
|
+
# @option params [Integer] :page_size
|
2268
|
+
# The maximum number of address list resources that are returned per
|
2269
|
+
# call. You can use NextToken to retrieve the next page of address
|
2270
|
+
# lists.
|
2271
|
+
#
|
2272
|
+
# @return [Types::ListAddressListsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2273
|
+
#
|
2274
|
+
# * {Types::ListAddressListsResponse#address_lists #address_lists} => Array<Types::AddressList>
|
2275
|
+
# * {Types::ListAddressListsResponse#next_token #next_token} => String
|
2276
|
+
#
|
2277
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2278
|
+
#
|
2279
|
+
# @example Request syntax with placeholder values
|
2280
|
+
#
|
2281
|
+
# resp = client.list_address_lists({
|
2282
|
+
# next_token: "PaginationToken",
|
2283
|
+
# page_size: 1,
|
2284
|
+
# })
|
2285
|
+
#
|
2286
|
+
# @example Response structure
|
2287
|
+
#
|
2288
|
+
# resp.address_lists #=> Array
|
2289
|
+
# resp.address_lists[0].address_list_arn #=> String
|
2290
|
+
# resp.address_lists[0].address_list_id #=> String
|
2291
|
+
# resp.address_lists[0].address_list_name #=> String
|
2292
|
+
# resp.address_lists[0].created_timestamp #=> Time
|
2293
|
+
# resp.address_lists[0].last_updated_timestamp #=> Time
|
2294
|
+
# resp.next_token #=> String
|
2295
|
+
#
|
2296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListAddressLists AWS API Documentation
|
2297
|
+
#
|
2298
|
+
# @overload list_address_lists(params = {})
|
2299
|
+
# @param [Hash] params ({})
|
2300
|
+
def list_address_lists(params = {}, options = {})
|
2301
|
+
req = build_request(:list_address_lists, params)
|
2302
|
+
req.send_request(options)
|
2303
|
+
end
|
2304
|
+
|
1897
2305
|
# Returns a list of email archive export jobs.
|
1898
2306
|
#
|
1899
2307
|
# @option params [required, String] :archive_id
|
@@ -2077,6 +2485,57 @@ module Aws::MailManager
|
|
2077
2485
|
req.send_request(options)
|
2078
2486
|
end
|
2079
2487
|
|
2488
|
+
# Lists members of an address list.
|
2489
|
+
#
|
2490
|
+
# @option params [required, String] :address_list_id
|
2491
|
+
# The unique identifier of the address list to list the addresses from.
|
2492
|
+
#
|
2493
|
+
# @option params [Types::AddressFilter] :filter
|
2494
|
+
# Filter to be used to limit the results.
|
2495
|
+
#
|
2496
|
+
# @option params [String] :next_token
|
2497
|
+
# If you received a pagination token from a previous call to this API,
|
2498
|
+
# you can provide it here to continue paginating through the next page
|
2499
|
+
# of results.
|
2500
|
+
#
|
2501
|
+
# @option params [Integer] :page_size
|
2502
|
+
# The maximum number of address list members that are returned per call.
|
2503
|
+
# You can use NextToken to retrieve the next page of members.
|
2504
|
+
#
|
2505
|
+
# @return [Types::ListMembersOfAddressListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2506
|
+
#
|
2507
|
+
# * {Types::ListMembersOfAddressListResponse#addresses #addresses} => Array<Types::SavedAddress>
|
2508
|
+
# * {Types::ListMembersOfAddressListResponse#next_token #next_token} => String
|
2509
|
+
#
|
2510
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2511
|
+
#
|
2512
|
+
# @example Request syntax with placeholder values
|
2513
|
+
#
|
2514
|
+
# resp = client.list_members_of_address_list({
|
2515
|
+
# address_list_id: "AddressListId", # required
|
2516
|
+
# filter: {
|
2517
|
+
# address_prefix: "AddressPrefix",
|
2518
|
+
# },
|
2519
|
+
# next_token: "PaginationToken",
|
2520
|
+
# page_size: 1,
|
2521
|
+
# })
|
2522
|
+
#
|
2523
|
+
# @example Response structure
|
2524
|
+
#
|
2525
|
+
# resp.addresses #=> Array
|
2526
|
+
# resp.addresses[0].address #=> String
|
2527
|
+
# resp.addresses[0].created_timestamp #=> Time
|
2528
|
+
# resp.next_token #=> String
|
2529
|
+
#
|
2530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListMembersOfAddressList AWS API Documentation
|
2531
|
+
#
|
2532
|
+
# @overload list_members_of_address_list(params = {})
|
2533
|
+
# @param [Hash] params ({})
|
2534
|
+
def list_members_of_address_list(params = {}, options = {})
|
2535
|
+
req = build_request(:list_members_of_address_list, params)
|
2536
|
+
req.send_request(options)
|
2537
|
+
end
|
2538
|
+
|
2080
2539
|
# Lists all the existing relay resources.
|
2081
2540
|
#
|
2082
2541
|
# @option params [String] :next_token
|
@@ -2232,6 +2691,55 @@ module Aws::MailManager
|
|
2232
2691
|
req.send_request(options)
|
2233
2692
|
end
|
2234
2693
|
|
2694
|
+
# Adds a member to an address list.
|
2695
|
+
#
|
2696
|
+
# @option params [required, String] :address
|
2697
|
+
# The address to be added to the address list.
|
2698
|
+
#
|
2699
|
+
# @option params [required, String] :address_list_id
|
2700
|
+
# The unique identifier of the address list where the address should be
|
2701
|
+
# added.
|
2702
|
+
#
|
2703
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2704
|
+
#
|
2705
|
+
# @example Request syntax with placeholder values
|
2706
|
+
#
|
2707
|
+
# resp = client.register_member_to_address_list({
|
2708
|
+
# address: "Address", # required
|
2709
|
+
# address_list_id: "AddressListId", # required
|
2710
|
+
# })
|
2711
|
+
#
|
2712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/RegisterMemberToAddressList AWS API Documentation
|
2713
|
+
#
|
2714
|
+
# @overload register_member_to_address_list(params = {})
|
2715
|
+
# @param [Hash] params ({})
|
2716
|
+
def register_member_to_address_list(params = {}, options = {})
|
2717
|
+
req = build_request(:register_member_to_address_list, params)
|
2718
|
+
req.send_request(options)
|
2719
|
+
end
|
2720
|
+
|
2721
|
+
# Starts an import job for an address list.
|
2722
|
+
#
|
2723
|
+
# @option params [required, String] :job_id
|
2724
|
+
# The identifier of the import job that needs to be started.
|
2725
|
+
#
|
2726
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2727
|
+
#
|
2728
|
+
# @example Request syntax with placeholder values
|
2729
|
+
#
|
2730
|
+
# resp = client.start_address_list_import_job({
|
2731
|
+
# job_id: "JobId", # required
|
2732
|
+
# })
|
2733
|
+
#
|
2734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/StartAddressListImportJob AWS API Documentation
|
2735
|
+
#
|
2736
|
+
# @overload start_address_list_import_job(params = {})
|
2737
|
+
# @param [Hash] params ({})
|
2738
|
+
def start_address_list_import_job(params = {}, options = {})
|
2739
|
+
req = build_request(:start_address_list_import_job, params)
|
2740
|
+
req.send_request(options)
|
2741
|
+
end
|
2742
|
+
|
2235
2743
|
# Initiates an export of emails from the specified archive.
|
2236
2744
|
#
|
2237
2745
|
# @option params [required, String] :archive_id
|
@@ -2402,6 +2910,28 @@ module Aws::MailManager
|
|
2402
2910
|
req.send_request(options)
|
2403
2911
|
end
|
2404
2912
|
|
2913
|
+
# Stops an ongoing import job for an address list.
|
2914
|
+
#
|
2915
|
+
# @option params [required, String] :job_id
|
2916
|
+
# The identifier of the import job that needs to be stopped.
|
2917
|
+
#
|
2918
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2919
|
+
#
|
2920
|
+
# @example Request syntax with placeholder values
|
2921
|
+
#
|
2922
|
+
# resp = client.stop_address_list_import_job({
|
2923
|
+
# job_id: "JobId", # required
|
2924
|
+
# })
|
2925
|
+
#
|
2926
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/StopAddressListImportJob AWS API Documentation
|
2927
|
+
#
|
2928
|
+
# @overload stop_address_list_import_job(params = {})
|
2929
|
+
# @param [Hash] params ({})
|
2930
|
+
def stop_address_list_import_job(params = {}, options = {})
|
2931
|
+
req = build_request(:stop_address_list_import_job, params)
|
2932
|
+
req.send_request(options)
|
2933
|
+
end
|
2934
|
+
|
2405
2935
|
# Stops an in-progress export of emails from an archive.
|
2406
2936
|
#
|
2407
2937
|
# @option params [required, String] :export_id
|
@@ -2699,6 +3229,10 @@ module Aws::MailManager
|
|
2699
3229
|
# boolean_expression: {
|
2700
3230
|
# evaluate: { # required
|
2701
3231
|
# attribute: "READ_RECEIPT_REQUESTED", # accepts READ_RECEIPT_REQUESTED, TLS, TLS_WRAPPED
|
3232
|
+
# is_in_address_list: {
|
3233
|
+
# address_lists: ["AddressListArn"], # required
|
3234
|
+
# attribute: "RECIPIENT", # required, accepts RECIPIENT, MAIL_FROM, SENDER, FROM, TO, CC
|
3235
|
+
# },
|
2702
3236
|
# },
|
2703
3237
|
# operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
|
2704
3238
|
# },
|
@@ -2747,6 +3281,10 @@ module Aws::MailManager
|
|
2747
3281
|
# boolean_expression: {
|
2748
3282
|
# evaluate: { # required
|
2749
3283
|
# attribute: "READ_RECEIPT_REQUESTED", # accepts READ_RECEIPT_REQUESTED, TLS, TLS_WRAPPED
|
3284
|
+
# is_in_address_list: {
|
3285
|
+
# address_lists: ["AddressListArn"], # required
|
3286
|
+
# attribute: "RECIPIENT", # required, accepts RECIPIENT, MAIL_FROM, SENDER, FROM, TO, CC
|
3287
|
+
# },
|
2750
3288
|
# },
|
2751
3289
|
# operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
|
2752
3290
|
# },
|
@@ -2840,6 +3378,10 @@ module Aws::MailManager
|
|
2840
3378
|
# analyzer: "AnalyzerArn", # required
|
2841
3379
|
# result_field: "ResultField", # required
|
2842
3380
|
# },
|
3381
|
+
# is_in_address_list: {
|
3382
|
+
# address_lists: ["AddressListArn"], # required
|
3383
|
+
# attribute: "RECIPIENT", # required, accepts RECIPIENT
|
3384
|
+
# },
|
2843
3385
|
# },
|
2844
3386
|
# operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
|
2845
3387
|
# },
|
@@ -2899,7 +3441,7 @@ module Aws::MailManager
|
|
2899
3441
|
tracer: tracer
|
2900
3442
|
)
|
2901
3443
|
context[:gem_name] = 'aws-sdk-mailmanager'
|
2902
|
-
context[:gem_version] = '1.
|
3444
|
+
context[:gem_version] = '1.18.0'
|
2903
3445
|
Seahorse::Client::Request.new(handlers, context)
|
2904
3446
|
end
|
2905
3447
|
|