aws-sdk-ses 1.0.0.rc5 → 1.0.0.rc6

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 9f58c38e2bd690eb63d395f31ca9480a6bfa753d
4
- data.tar.gz: c383cd4f4903fe20dfe120063133933060d214ba
3
+ metadata.gz: 60c26f677b7bc7f55dfdbc6c6a76a990eee2e1bb
4
+ data.tar.gz: 097d80eb226b2d3dda160fd43e3606c63ad0f86d
5
5
  SHA512:
6
- metadata.gz: 14c491ce1908a7fa436932a1a040d1a2fcf9427e610e46650bb6c48912068e879b47d19b6d319ae79aa88cbdda41cb64aed53fc787ddb136a0f2473e171e91e4
7
- data.tar.gz: bd53dbe2d96ed62508e576ebd69fd062deff8a67f7f370556d0e02396e805604880ee40136621eb696bf386fadc36a9ca982055266465ab09ccd9f799ab27087
6
+ metadata.gz: d895103dc8ffd1779c6e7ac7aade08f3987930b84b3c638ca4ba798360d7d98812d8ac140845d4abf8874c47b310b216e809d211c9463400d941548c3d078cf6
7
+ data.tar.gz: a7a6cc18408492d7afd8cb6c84f5b2741aa7812d28ebb6aca7c1696bb7c5338cf7677a9a26f8c1c091eaa7514c53bea216c637721ce0c46580e3702527a399a9
@@ -43,6 +43,6 @@ require_relative 'aws-sdk-ses/customizations'
43
43
  # @service
44
44
  module Aws::SES
45
45
 
46
- GEM_VERSION = '1.0.0.rc5'
46
+ GEM_VERSION = '1.0.0.rc6'
47
47
 
48
48
  end
@@ -173,6 +173,16 @@ module Aws::SES
173
173
  #
174
174
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
175
175
  #
176
+ #
177
+ # @example Example: CloneReceiptRuleSet
178
+ #
179
+ # # The following example creates a receipt rule set by cloning an existing one:
180
+ #
181
+ # resp = client.clone_receipt_rule_set({
182
+ # original_rule_set_name: "RuleSetToClone",
183
+ # rule_set_name: "RuleSetToCreate",
184
+ # })
185
+ #
176
186
  # @example Request syntax with placeholder values
177
187
  #
178
188
  # resp = client.clone_receipt_rule_set({
@@ -304,6 +314,21 @@ module Aws::SES
304
314
  #
305
315
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
306
316
  #
317
+ #
318
+ # @example Example: CreateReceiptFilter
319
+ #
320
+ # # The following example creates a new IP address filter:
321
+ #
322
+ # resp = client.create_receipt_filter({
323
+ # filter: {
324
+ # ip_filter: {
325
+ # cidr: "1.2.3.4/24",
326
+ # policy: "Allow",
327
+ # },
328
+ # name: "MyFilter",
329
+ # },
330
+ # })
331
+ #
307
332
  # @example Request syntax with placeholder values
308
333
  #
309
334
  # resp = client.create_receipt_filter({
@@ -350,6 +375,30 @@ module Aws::SES
350
375
  #
351
376
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
352
377
  #
378
+ #
379
+ # @example Example: CreateReceiptRule
380
+ #
381
+ # # The following example creates a new receipt rule:
382
+ #
383
+ # resp = client.create_receipt_rule({
384
+ # after: "",
385
+ # rule: {
386
+ # actions: [
387
+ # {
388
+ # s3_action: {
389
+ # bucket_name: "MyBucket",
390
+ # object_key_prefix: "email",
391
+ # },
392
+ # },
393
+ # ],
394
+ # enabled: true,
395
+ # name: "MyRule",
396
+ # scan_enabled: true,
397
+ # tls_policy: "Optional",
398
+ # },
399
+ # rule_set_name: "MyRuleSet",
400
+ # })
401
+ #
353
402
  # @example Request syntax with placeholder values
354
403
  #
355
404
  # resp = client.create_receipt_rule({
@@ -434,6 +483,15 @@ module Aws::SES
434
483
  #
435
484
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
436
485
  #
486
+ #
487
+ # @example Example: CreateReceiptRuleSet
488
+ #
489
+ # # The following example creates an empty receipt rule set:
490
+ #
491
+ # resp = client.create_receipt_rule_set({
492
+ # rule_set_name: "MyRuleSet",
493
+ # })
494
+ #
437
495
  # @example Request syntax with placeholder values
438
496
  #
439
497
  # resp = client.create_receipt_rule_set({
@@ -530,6 +588,15 @@ module Aws::SES
530
588
  #
531
589
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
532
590
  #
591
+ #
592
+ # @example Example: DeleteIdentity
593
+ #
594
+ # # The following example deletes an identity from the list of identities that have been submitted for verification with Amazon SES:
595
+ #
596
+ # resp = client.delete_identity({
597
+ # identity: "user@example.com",
598
+ # })
599
+ #
533
600
  # @example Request syntax with placeholder values
534
601
  #
535
602
  # resp = client.delete_identity({
@@ -578,6 +645,16 @@ module Aws::SES
578
645
  #
579
646
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
580
647
  #
648
+ #
649
+ # @example Example: DeleteIdentityPolicy
650
+ #
651
+ # # The following example deletes a sending authorization policy for an identity:
652
+ #
653
+ # resp = client.delete_identity_policy({
654
+ # identity: "user@example.com",
655
+ # policy_name: "MyPolicy",
656
+ # })
657
+ #
581
658
  # @example Request syntax with placeholder values
582
659
  #
583
660
  # resp = client.delete_identity_policy({
@@ -610,6 +687,15 @@ module Aws::SES
610
687
  #
611
688
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
612
689
  #
690
+ #
691
+ # @example Example: DeleteReceiptFilter
692
+ #
693
+ # # The following example deletes an IP address filter:
694
+ #
695
+ # resp = client.delete_receipt_filter({
696
+ # filter_name: "MyFilter",
697
+ # })
698
+ #
613
699
  # @example Request syntax with placeholder values
614
700
  #
615
701
  # resp = client.delete_receipt_filter({
@@ -645,6 +731,16 @@ module Aws::SES
645
731
  #
646
732
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
647
733
  #
734
+ #
735
+ # @example Example: DeleteReceiptRule
736
+ #
737
+ # # The following example deletes a receipt rule:
738
+ #
739
+ # resp = client.delete_receipt_rule({
740
+ # rule_name: "MyRule",
741
+ # rule_set_name: "MyRuleSet",
742
+ # })
743
+ #
648
744
  # @example Request syntax with placeholder values
649
745
  #
650
746
  # resp = client.delete_receipt_rule({
@@ -682,6 +778,15 @@ module Aws::SES
682
778
  #
683
779
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
684
780
  #
781
+ #
782
+ # @example Example: DeleteReceiptRuleSet
783
+ #
784
+ # # The following example deletes a receipt rule set:
785
+ #
786
+ # resp = client.delete_receipt_rule_set({
787
+ # rule_set_name: "MyRuleSet",
788
+ # })
789
+ #
685
790
  # @example Request syntax with placeholder values
686
791
  #
687
792
  # resp = client.delete_receipt_rule_set({
@@ -711,6 +816,15 @@ module Aws::SES
711
816
  #
712
817
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
713
818
  #
819
+ #
820
+ # @example Example: DeleteVerifiedEmailAddress
821
+ #
822
+ # # The following example deletes an email address from the list of identities that have been submitted for verification with Amazon SES:
823
+ #
824
+ # resp = client.delete_verified_email_address({
825
+ # email_address: "user@example.com",
826
+ # })
827
+ #
714
828
  # @example Request syntax with placeholder values
715
829
  #
716
830
  # resp = client.delete_verified_email_address({
@@ -743,6 +857,38 @@ module Aws::SES
743
857
  # * {Types::DescribeActiveReceiptRuleSetResponse#metadata #metadata} => Types::ReceiptRuleSetMetadata
744
858
  # * {Types::DescribeActiveReceiptRuleSetResponse#rules #rules} => Array<Types::ReceiptRule>
745
859
  #
860
+ #
861
+ # @example Example: DescribeActiveReceiptRuleSet
862
+ #
863
+ # # The following example returns the metadata and receipt rules for the receipt rule set that is currently active:
864
+ #
865
+ # resp = client.describe_active_receipt_rule_set({
866
+ # })
867
+ #
868
+ # resp.to_h outputs the following:
869
+ # {
870
+ # metadata: {
871
+ # created_timestamp: Time.parse("2016-07-15T16:25:59.607Z"),
872
+ # name: "default-rule-set",
873
+ # },
874
+ # rules: [
875
+ # {
876
+ # actions: [
877
+ # {
878
+ # s3_action: {
879
+ # bucket_name: "MyBucket",
880
+ # object_key_prefix: "email",
881
+ # },
882
+ # },
883
+ # ],
884
+ # enabled: true,
885
+ # name: "MyRule",
886
+ # scan_enabled: true,
887
+ # tls_policy: "Optional",
888
+ # },
889
+ # ],
890
+ # }
891
+ #
746
892
  # @example Response structure
747
893
  #
748
894
  # resp.metadata.name #=> String
@@ -860,6 +1006,34 @@ module Aws::SES
860
1006
  #
861
1007
  # * {Types::DescribeReceiptRuleResponse#rule #rule} => Types::ReceiptRule
862
1008
  #
1009
+ #
1010
+ # @example Example: DescribeReceiptRule
1011
+ #
1012
+ # # The following example returns the details of a receipt rule:
1013
+ #
1014
+ # resp = client.describe_receipt_rule({
1015
+ # rule_name: "MyRule",
1016
+ # rule_set_name: "MyRuleSet",
1017
+ # })
1018
+ #
1019
+ # resp.to_h outputs the following:
1020
+ # {
1021
+ # rule: {
1022
+ # actions: [
1023
+ # {
1024
+ # s3_action: {
1025
+ # bucket_name: "MyBucket",
1026
+ # object_key_prefix: "email",
1027
+ # },
1028
+ # },
1029
+ # ],
1030
+ # enabled: true,
1031
+ # name: "MyRule",
1032
+ # scan_enabled: true,
1033
+ # tls_policy: "Optional",
1034
+ # },
1035
+ # }
1036
+ #
863
1037
  # @example Request syntax with placeholder values
864
1038
  #
865
1039
  # resp = client.describe_receipt_rule({
@@ -925,6 +1099,39 @@ module Aws::SES
925
1099
  # * {Types::DescribeReceiptRuleSetResponse#metadata #metadata} => Types::ReceiptRuleSetMetadata
926
1100
  # * {Types::DescribeReceiptRuleSetResponse#rules #rules} => Array<Types::ReceiptRule>
927
1101
  #
1102
+ #
1103
+ # @example Example: DescribeReceiptRuleSet
1104
+ #
1105
+ # # The following example returns the metadata and receipt rules of a receipt rule set:
1106
+ #
1107
+ # resp = client.describe_receipt_rule_set({
1108
+ # rule_set_name: "MyRuleSet",
1109
+ # })
1110
+ #
1111
+ # resp.to_h outputs the following:
1112
+ # {
1113
+ # metadata: {
1114
+ # created_timestamp: Time.parse("2016-07-15T16:25:59.607Z"),
1115
+ # name: "MyRuleSet",
1116
+ # },
1117
+ # rules: [
1118
+ # {
1119
+ # actions: [
1120
+ # {
1121
+ # s3_action: {
1122
+ # bucket_name: "MyBucket",
1123
+ # object_key_prefix: "email",
1124
+ # },
1125
+ # },
1126
+ # ],
1127
+ # enabled: true,
1128
+ # name: "MyRule",
1129
+ # scan_enabled: true,
1130
+ # tls_policy: "Optional",
1131
+ # },
1132
+ # ],
1133
+ # }
1134
+ #
928
1135
  # @example Request syntax with placeholder values
929
1136
  #
930
1137
  # resp = client.describe_receipt_rule_set({
@@ -1008,6 +1215,37 @@ module Aws::SES
1008
1215
  #
1009
1216
  # * {Types::GetIdentityDkimAttributesResponse#dkim_attributes #dkim_attributes} => Hash<String,Types::IdentityDkimAttributes>
1010
1217
  #
1218
+ #
1219
+ # @example Example: GetIdentityDkimAttributes
1220
+ #
1221
+ # # The following example retrieves the Amazon SES Easy DKIM attributes for a list of identities:
1222
+ #
1223
+ # resp = client.get_identity_dkim_attributes({
1224
+ # identities: [
1225
+ # "example.com",
1226
+ # "user@example.com",
1227
+ # ],
1228
+ # })
1229
+ #
1230
+ # resp.to_h outputs the following:
1231
+ # {
1232
+ # dkim_attributes: {
1233
+ # "example.com" => {
1234
+ # dkim_enabled: true,
1235
+ # dkim_tokens: [
1236
+ # "EXAMPLEjcs5xoyqytjsotsijas7236gr",
1237
+ # "EXAMPLEjr76cvoc6mysspnioorxsn6ep",
1238
+ # "EXAMPLEkbmkqkhlm2lyz77ppkulerm4k",
1239
+ # ],
1240
+ # dkim_verification_status: "Success",
1241
+ # },
1242
+ # "user@example.com" => {
1243
+ # dkim_enabled: false,
1244
+ # dkim_verification_status: "NotStarted",
1245
+ # },
1246
+ # },
1247
+ # }
1248
+ #
1011
1249
  # @example Request syntax with placeholder values
1012
1250
  #
1013
1251
  # resp = client.get_identity_dkim_attributes({
@@ -1044,6 +1282,28 @@ module Aws::SES
1044
1282
  #
1045
1283
  # * {Types::GetIdentityMailFromDomainAttributesResponse#mail_from_domain_attributes #mail_from_domain_attributes} => Hash<String,Types::IdentityMailFromDomainAttributes>
1046
1284
  #
1285
+ #
1286
+ # @example Example: GetIdentityMailFromDomainAttributes
1287
+ #
1288
+ # # The following example returns the custom MAIL FROM attributes for an identity:
1289
+ #
1290
+ # resp = client.get_identity_mail_from_domain_attributes({
1291
+ # identities: [
1292
+ # "example.com",
1293
+ # ],
1294
+ # })
1295
+ #
1296
+ # resp.to_h outputs the following:
1297
+ # {
1298
+ # mail_from_domain_attributes: {
1299
+ # "example.com" => {
1300
+ # behavior_on_mx_failure: "UseDefaultValue",
1301
+ # mail_from_domain: "bounces.example.com",
1302
+ # mail_from_domain_status: "Success",
1303
+ # },
1304
+ # },
1305
+ # }
1306
+ #
1047
1307
  # @example Request syntax with placeholder values
1048
1308
  #
1049
1309
  # resp = client.get_identity_mail_from_domain_attributes({
@@ -1089,6 +1349,30 @@ module Aws::SES
1089
1349
  #
1090
1350
  # * {Types::GetIdentityNotificationAttributesResponse#notification_attributes #notification_attributes} => Hash<String,Types::IdentityNotificationAttributes>
1091
1351
  #
1352
+ #
1353
+ # @example Example: GetIdentityNotificationAttributes
1354
+ #
1355
+ # # The following example returns the notification attributes for an identity:
1356
+ #
1357
+ # resp = client.get_identity_notification_attributes({
1358
+ # identities: [
1359
+ # "example.com",
1360
+ # ],
1361
+ # })
1362
+ #
1363
+ # resp.to_h outputs the following:
1364
+ # {
1365
+ # notification_attributes: {
1366
+ # "example.com" => {
1367
+ # bounce_topic: "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
1368
+ # forwarding_enabled: true,
1369
+ # headers_in_bounce_notifications_enabled: false,
1370
+ # headers_in_complaint_notifications_enabled: false,
1371
+ # headers_in_delivery_notifications_enabled: false,
1372
+ # },
1373
+ # },
1374
+ # }
1375
+ #
1092
1376
  # @example Request syntax with placeholder values
1093
1377
  #
1094
1378
  # resp = client.get_identity_notification_attributes({
@@ -1153,6 +1437,25 @@ module Aws::SES
1153
1437
  #
1154
1438
  # * {Types::GetIdentityPoliciesResponse#policies #policies} => Hash<String,String>
1155
1439
  #
1440
+ #
1441
+ # @example Example: GetIdentityPolicies
1442
+ #
1443
+ # # The following example returns a sending authorization policy for an identity:
1444
+ #
1445
+ # resp = client.get_identity_policies({
1446
+ # identity: "example.com",
1447
+ # policy_names: [
1448
+ # "MyPolicy",
1449
+ # ],
1450
+ # })
1451
+ #
1452
+ # resp.to_h outputs the following:
1453
+ # {
1454
+ # policies: {
1455
+ # "MyPolicy" => "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}",
1456
+ # },
1457
+ # }
1458
+ #
1156
1459
  # @example Request syntax with placeholder values
1157
1460
  #
1158
1461
  # resp = client.get_identity_policies({
@@ -1188,6 +1491,27 @@ module Aws::SES
1188
1491
  #
1189
1492
  # * {Types::GetIdentityVerificationAttributesResponse#verification_attributes #verification_attributes} => Hash<String,Types::IdentityVerificationAttributes>
1190
1493
  #
1494
+ #
1495
+ # @example Example: GetIdentityVerificationAttributes
1496
+ #
1497
+ # # The following example returns the verification status and the verification token for a domain identity:
1498
+ #
1499
+ # resp = client.get_identity_verification_attributes({
1500
+ # identities: [
1501
+ # "example.com",
1502
+ # ],
1503
+ # })
1504
+ #
1505
+ # resp.to_h outputs the following:
1506
+ # {
1507
+ # verification_attributes: {
1508
+ # "example.com" => {
1509
+ # verification_status: "Success",
1510
+ # verification_token: "EXAMPLE3VYb9EDI2nTOQRi/Tf6MI/6bD6THIGiP1MVY=",
1511
+ # },
1512
+ # },
1513
+ # }
1514
+ #
1191
1515
  # @example Request syntax with placeholder values
1192
1516
  #
1193
1517
  # resp = client.get_identity_verification_attributes({
@@ -1219,6 +1543,21 @@ module Aws::SES
1219
1543
  # * {Types::GetSendQuotaResponse#max_send_rate #max_send_rate} => Float
1220
1544
  # * {Types::GetSendQuotaResponse#sent_last_24_hours #sent_last_24_hours} => Float
1221
1545
  #
1546
+ #
1547
+ # @example Example: GetSendQuota
1548
+ #
1549
+ # # The following example returns the Amazon SES sending limits for an AWS account:
1550
+ #
1551
+ # resp = client.get_send_quota({
1552
+ # })
1553
+ #
1554
+ # resp.to_h outputs the following:
1555
+ # {
1556
+ # max_24_hour_send: 200,
1557
+ # max_send_rate: 1,
1558
+ # sent_last_24_hours: 1,
1559
+ # }
1560
+ #
1222
1561
  # @example Response structure
1223
1562
  #
1224
1563
  # resp.max_24_hour_send #=> Float
@@ -1246,6 +1585,41 @@ module Aws::SES
1246
1585
  #
1247
1586
  # * {Types::GetSendStatisticsResponse#send_data_points #send_data_points} => Array<Types::SendDataPoint>
1248
1587
  #
1588
+ #
1589
+ # @example Example: GetSendStatistics
1590
+ #
1591
+ # # The following example returns Amazon SES sending statistics:
1592
+ #
1593
+ # resp = client.get_send_statistics({
1594
+ # })
1595
+ #
1596
+ # resp.to_h outputs the following:
1597
+ # {
1598
+ # send_data_points: [
1599
+ # {
1600
+ # bounces: 0,
1601
+ # complaints: 0,
1602
+ # delivery_attempts: 5,
1603
+ # rejects: 0,
1604
+ # timestamp: Time.parse("2016-07-13T22:43:00Z"),
1605
+ # },
1606
+ # {
1607
+ # bounces: 0,
1608
+ # complaints: 0,
1609
+ # delivery_attempts: 3,
1610
+ # rejects: 0,
1611
+ # timestamp: Time.parse("2016-07-13T23:13:00Z"),
1612
+ # },
1613
+ # {
1614
+ # bounces: 0,
1615
+ # complaints: 0,
1616
+ # delivery_attempts: 1,
1617
+ # rejects: 0,
1618
+ # timestamp: Time.parse("2016-07-13T21:13:00Z"),
1619
+ # },
1620
+ # ],
1621
+ # }
1622
+ #
1249
1623
  # @example Response structure
1250
1624
  #
1251
1625
  # resp.send_data_points #=> Array
@@ -1334,6 +1708,25 @@ module Aws::SES
1334
1708
  # * {Types::ListIdentitiesResponse#identities #identities} => Array<String>
1335
1709
  # * {Types::ListIdentitiesResponse#next_token #next_token} => String
1336
1710
  #
1711
+ #
1712
+ # @example Example: ListIdentities
1713
+ #
1714
+ # # The following example lists the email address identities that have been submitted for verification with Amazon SES:
1715
+ #
1716
+ # resp = client.list_identities({
1717
+ # identity_type: "EmailAddress",
1718
+ # max_items: 123,
1719
+ # next_token: "",
1720
+ # })
1721
+ #
1722
+ # resp.to_h outputs the following:
1723
+ # {
1724
+ # identities: [
1725
+ # "user@example.com",
1726
+ # ],
1727
+ # next_token: "",
1728
+ # }
1729
+ #
1337
1730
  # @example Request syntax with placeholder values
1338
1731
  #
1339
1732
  # resp = client.list_identities({
@@ -1390,6 +1783,22 @@ module Aws::SES
1390
1783
  #
1391
1784
  # * {Types::ListIdentityPoliciesResponse#policy_names #policy_names} => Array<String>
1392
1785
  #
1786
+ #
1787
+ # @example Example: ListIdentityPolicies
1788
+ #
1789
+ # # The following example returns a list of sending authorization policies that are attached to an identity:
1790
+ #
1791
+ # resp = client.list_identity_policies({
1792
+ # identity: "example.com",
1793
+ # })
1794
+ #
1795
+ # resp.to_h outputs the following:
1796
+ # {
1797
+ # policy_names: [
1798
+ # "MyPolicy",
1799
+ # ],
1800
+ # }
1801
+ #
1393
1802
  # @example Request syntax with placeholder values
1394
1803
  #
1395
1804
  # resp = client.list_identity_policies({
@@ -1425,6 +1834,27 @@ module Aws::SES
1425
1834
  #
1426
1835
  # * {Types::ListReceiptFiltersResponse#filters #filters} => Array<Types::ReceiptFilter>
1427
1836
  #
1837
+ #
1838
+ # @example Example: ListReceiptFilters
1839
+ #
1840
+ # # The following example lists the IP address filters that are associated with an AWS account:
1841
+ #
1842
+ # resp = client.list_receipt_filters({
1843
+ # })
1844
+ #
1845
+ # resp.to_h outputs the following:
1846
+ # {
1847
+ # filters: [
1848
+ # {
1849
+ # ip_filter: {
1850
+ # cidr: "1.2.3.4/24",
1851
+ # policy: "Block",
1852
+ # },
1853
+ # name: "MyFilter",
1854
+ # },
1855
+ # ],
1856
+ # }
1857
+ #
1428
1858
  # @example Response structure
1429
1859
  #
1430
1860
  # resp.filters #=> Array
@@ -1464,6 +1894,26 @@ module Aws::SES
1464
1894
  # * {Types::ListReceiptRuleSetsResponse#rule_sets #rule_sets} => Array<Types::ReceiptRuleSetMetadata>
1465
1895
  # * {Types::ListReceiptRuleSetsResponse#next_token #next_token} => String
1466
1896
  #
1897
+ #
1898
+ # @example Example: ListReceiptRuleSets
1899
+ #
1900
+ # # The following example lists the receipt rule sets that exist under an AWS account:
1901
+ #
1902
+ # resp = client.list_receipt_rule_sets({
1903
+ # next_token: "",
1904
+ # })
1905
+ #
1906
+ # resp.to_h outputs the following:
1907
+ # {
1908
+ # next_token: "",
1909
+ # rule_sets: [
1910
+ # {
1911
+ # created_timestamp: Time.parse("2016-07-15T16:25:59.607Z"),
1912
+ # name: "MyRuleSet",
1913
+ # },
1914
+ # ],
1915
+ # }
1916
+ #
1467
1917
  # @example Request syntax with placeholder values
1468
1918
  #
1469
1919
  # resp = client.list_receipt_rule_sets({
@@ -1499,6 +1949,22 @@ module Aws::SES
1499
1949
  #
1500
1950
  # * {Types::ListVerifiedEmailAddressesResponse#verified_email_addresses #verified_email_addresses} => Array<String>
1501
1951
  #
1952
+ #
1953
+ # @example Example: ListVerifiedEmailAddresses
1954
+ #
1955
+ # # The following example lists all email addresses that have been submitted for verification with Amazon SES:
1956
+ #
1957
+ # resp = client.list_verified_email_addresses({
1958
+ # })
1959
+ #
1960
+ # resp.to_h outputs the following:
1961
+ # {
1962
+ # verified_email_addresses: [
1963
+ # "user1@example.com",
1964
+ # "user2@example.com",
1965
+ # ],
1966
+ # }
1967
+ #
1502
1968
  # @example Response structure
1503
1969
  #
1504
1970
  # resp.verified_email_addresses #=> Array
@@ -1557,6 +2023,17 @@ module Aws::SES
1557
2023
  #
1558
2024
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1559
2025
  #
2026
+ #
2027
+ # @example Example: PutIdentityPolicy
2028
+ #
2029
+ # # The following example adds a sending authorization policy to an identity:
2030
+ #
2031
+ # resp = client.put_identity_policy({
2032
+ # identity: "example.com",
2033
+ # policy: "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}",
2034
+ # policy_name: "MyPolicy",
2035
+ # })
2036
+ #
1560
2037
  # @example Request syntax with placeholder values
1561
2038
  #
1562
2039
  # resp = client.put_identity_policy({
@@ -1600,6 +2077,19 @@ module Aws::SES
1600
2077
  #
1601
2078
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1602
2079
  #
2080
+ #
2081
+ # @example Example: ReorderReceiptRuleSet
2082
+ #
2083
+ # # The following example reorders the receipt rules within a receipt rule set:
2084
+ #
2085
+ # resp = client.reorder_receipt_rule_set({
2086
+ # rule_names: [
2087
+ # "MyRule",
2088
+ # "MyOtherRule",
2089
+ # ],
2090
+ # rule_set_name: "MyRuleSet",
2091
+ # })
2092
+ #
1603
2093
  # @example Request syntax with placeholder values
1604
2094
  #
1605
2095
  # resp = client.reorder_receipt_rule_set({
@@ -1854,6 +2344,52 @@ module Aws::SES
1854
2344
  #
1855
2345
  # * {Types::SendEmailResponse#message_id #message_id} => String
1856
2346
  #
2347
+ #
2348
+ # @example Example: SendEmail
2349
+ #
2350
+ # # The following example sends a formatted email:
2351
+ #
2352
+ # resp = client.send_email({
2353
+ # destination: {
2354
+ # bcc_addresses: [
2355
+ # ],
2356
+ # cc_addresses: [
2357
+ # "recipient3@example.com",
2358
+ # ],
2359
+ # to_addresses: [
2360
+ # "recipient1@example.com",
2361
+ # "recipient2@example.com",
2362
+ # ],
2363
+ # },
2364
+ # message: {
2365
+ # body: {
2366
+ # html: {
2367
+ # charset: "UTF-8",
2368
+ # data: "This message body contains HTML formatting. It can, for example, contain links like this one: <a class=\"ulink\" href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide\" target=\"_blank\">Amazon SES Developer Guide</a>.",
2369
+ # },
2370
+ # text: {
2371
+ # charset: "UTF-8",
2372
+ # data: "This is the message body in text format.",
2373
+ # },
2374
+ # },
2375
+ # subject: {
2376
+ # charset: "UTF-8",
2377
+ # data: "Test email",
2378
+ # },
2379
+ # },
2380
+ # reply_to_addresses: [
2381
+ # ],
2382
+ # return_path: "",
2383
+ # return_path_arn: "",
2384
+ # source: "sender@example.com",
2385
+ # source_arn: "",
2386
+ # })
2387
+ #
2388
+ # resp.to_h outputs the following:
2389
+ # {
2390
+ # message_id: "EXAMPLE78603177f-7a5433e7-8edb-42ae-af10-f0181f34d6ee-000000",
2391
+ # }
2392
+ #
1857
2393
  # @example Request syntax with placeholder values
1858
2394
  #
1859
2395
  # resp = client.send_email({
@@ -2108,6 +2644,28 @@ module Aws::SES
2108
2644
  #
2109
2645
  # * {Types::SendRawEmailResponse#message_id #message_id} => String
2110
2646
  #
2647
+ #
2648
+ # @example Example: SendRawEmail
2649
+ #
2650
+ # # The following example sends an email with an attachment:
2651
+ #
2652
+ # resp = client.send_raw_email({
2653
+ # destinations: [
2654
+ # ],
2655
+ # from_arn: "",
2656
+ # raw_message: {
2657
+ # data: "From: sender@example.com\\nTo: recipient@example.com\\nSubject: Test email (contains an attachment)\\nMIME-Version: 1.0\\nContent-type: Multipart/Mixed; boundary=\"NextPart\"\\n\\n--NextPart\\nContent-Type: text/plain\\n\\nThis is the message body.\\n\\n--NextPart\\nContent-Type: text/plain;\\nContent-Disposition: attachment; filename=\"attachment.txt\"\\n\\nThis is the text in the attachment.\\n\\n--NextPart--",
2658
+ # },
2659
+ # return_path_arn: "",
2660
+ # source: "",
2661
+ # source_arn: "",
2662
+ # })
2663
+ #
2664
+ # resp.to_h outputs the following:
2665
+ # {
2666
+ # message_id: "EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000",
2667
+ # }
2668
+ #
2111
2669
  # @example Request syntax with placeholder values
2112
2670
  #
2113
2671
  # resp = client.send_raw_email({
@@ -2163,6 +2721,15 @@ module Aws::SES
2163
2721
  #
2164
2722
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2165
2723
  #
2724
+ #
2725
+ # @example Example: SetActiveReceiptRuleSet
2726
+ #
2727
+ # # The following example sets the active receipt rule set:
2728
+ #
2729
+ # resp = client.set_active_receipt_rule_set({
2730
+ # rule_set_name: "RuleSetToActivate",
2731
+ # })
2732
+ #
2166
2733
  # @example Request syntax with placeholder values
2167
2734
  #
2168
2735
  # resp = client.set_active_receipt_rule_set({
@@ -2210,6 +2777,16 @@ module Aws::SES
2210
2777
  #
2211
2778
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2212
2779
  #
2780
+ #
2781
+ # @example Example: SetIdentityDkimEnabled
2782
+ #
2783
+ # # The following example configures Amazon SES to Easy DKIM-sign the email sent from an identity:
2784
+ #
2785
+ # resp = client.set_identity_dkim_enabled({
2786
+ # dkim_enabled: true,
2787
+ # identity: "user@example.com",
2788
+ # })
2789
+ #
2213
2790
  # @example Request syntax with placeholder values
2214
2791
  #
2215
2792
  # resp = client.set_identity_dkim_enabled({
@@ -2262,6 +2839,16 @@ module Aws::SES
2262
2839
  #
2263
2840
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2264
2841
  #
2842
+ #
2843
+ # @example Example: SetIdentityFeedbackForwardingEnabled
2844
+ #
2845
+ # # The following example configures Amazon SES to forward an identity's bounces and complaints via email:
2846
+ #
2847
+ # resp = client.set_identity_feedback_forwarding_enabled({
2848
+ # forwarding_enabled: true,
2849
+ # identity: "user@example.com",
2850
+ # })
2851
+ #
2265
2852
  # @example Request syntax with placeholder values
2266
2853
  #
2267
2854
  # resp = client.set_identity_feedback_forwarding_enabled({
@@ -2311,6 +2898,17 @@ module Aws::SES
2311
2898
  #
2312
2899
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2313
2900
  #
2901
+ #
2902
+ # @example Example: SetIdentityHeadersInNotificationsEnabled
2903
+ #
2904
+ # # The following example configures Amazon SES to include the original email headers in the Amazon SNS bounce notifications for an identity:
2905
+ #
2906
+ # resp = client.set_identity_headers_in_notifications_enabled({
2907
+ # enabled: true,
2908
+ # identity: "user@example.com",
2909
+ # notification_type: "Bounce",
2910
+ # })
2911
+ #
2314
2912
  # @example Request syntax with placeholder values
2315
2913
  #
2316
2914
  # resp = client.set_identity_headers_in_notifications_enabled({
@@ -2374,6 +2972,17 @@ module Aws::SES
2374
2972
  #
2375
2973
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2376
2974
  #
2975
+ #
2976
+ # @example Example: SetIdentityMailFromDomain
2977
+ #
2978
+ # # The following example configures Amazon SES to use a custom MAIL FROM domain for an identity:
2979
+ #
2980
+ # resp = client.set_identity_mail_from_domain({
2981
+ # behavior_on_mx_failure: "UseDefaultValue",
2982
+ # identity: "user@example.com",
2983
+ # mail_from_domain: "bounces.example.com",
2984
+ # })
2985
+ #
2377
2986
  # @example Request syntax with placeholder values
2378
2987
  #
2379
2988
  # resp = client.set_identity_mail_from_domain({
@@ -2428,6 +3037,17 @@ module Aws::SES
2428
3037
  #
2429
3038
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2430
3039
  #
3040
+ #
3041
+ # @example Example: SetIdentityNotificationTopic
3042
+ #
3043
+ # # The following example sets the Amazon SNS topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with the specified identity as the Source:
3044
+ #
3045
+ # resp = client.set_identity_notification_topic({
3046
+ # identity: "user@example.com",
3047
+ # notification_type: "Bounce",
3048
+ # sns_topic: "arn:aws:sns:us-west-2:111122223333:MyTopic",
3049
+ # })
3050
+ #
2431
3051
  # @example Request syntax with placeholder values
2432
3052
  #
2433
3053
  # resp = client.set_identity_notification_topic({
@@ -2470,6 +3090,17 @@ module Aws::SES
2470
3090
  #
2471
3091
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2472
3092
  #
3093
+ #
3094
+ # @example Example: SetReceiptRulePosition
3095
+ #
3096
+ # # The following example sets the position of a receipt rule in a receipt rule set:
3097
+ #
3098
+ # resp = client.set_receipt_rule_position({
3099
+ # after: "PutRuleAfterThisRule",
3100
+ # rule_name: "RuleToReposition",
3101
+ # rule_set_name: "MyRuleSet",
3102
+ # })
3103
+ #
2473
3104
  # @example Request syntax with placeholder values
2474
3105
  #
2475
3106
  # resp = client.set_receipt_rule_position({
@@ -2567,6 +3198,29 @@ module Aws::SES
2567
3198
  #
2568
3199
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2569
3200
  #
3201
+ #
3202
+ # @example Example: UpdateReceiptRule
3203
+ #
3204
+ # # The following example updates a receipt rule to use an Amazon S3 action:
3205
+ #
3206
+ # resp = client.update_receipt_rule({
3207
+ # rule: {
3208
+ # actions: [
3209
+ # {
3210
+ # s3_action: {
3211
+ # bucket_name: "MyBucket",
3212
+ # object_key_prefix: "email",
3213
+ # },
3214
+ # },
3215
+ # ],
3216
+ # enabled: true,
3217
+ # name: "MyRule",
3218
+ # scan_enabled: true,
3219
+ # tls_policy: "Optional",
3220
+ # },
3221
+ # rule_set_name: "MyRuleSet",
3222
+ # })
3223
+ #
2570
3224
  # @example Request syntax with placeholder values
2571
3225
  #
2572
3226
  # resp = client.update_receipt_rule({
@@ -2654,6 +3308,24 @@ module Aws::SES
2654
3308
  #
2655
3309
  # * {Types::VerifyDomainDkimResponse#dkim_tokens #dkim_tokens} => Array&lt;String&gt;
2656
3310
  #
3311
+ #
3312
+ # @example Example: VerifyDomainDkim
3313
+ #
3314
+ # # The following example generates DKIM tokens for a domain that has been verified with Amazon SES:
3315
+ #
3316
+ # resp = client.verify_domain_dkim({
3317
+ # domain: "example.com",
3318
+ # })
3319
+ #
3320
+ # resp.to_h outputs the following:
3321
+ # {
3322
+ # dkim_tokens: [
3323
+ # "EXAMPLEq76owjnks3lnluwg65scbemvw",
3324
+ # "EXAMPLEi3dnsj67hstzaj673klariwx2",
3325
+ # "EXAMPLEwfbtcukvimehexktmdtaz6naj",
3326
+ # ],
3327
+ # }
3328
+ #
2657
3329
  # @example Request syntax with placeholder values
2658
3330
  #
2659
3331
  # resp = client.verify_domain_dkim({
@@ -2685,6 +3357,20 @@ module Aws::SES
2685
3357
  #
2686
3358
  # * {Types::VerifyDomainIdentityResponse#verification_token #verification_token} => String
2687
3359
  #
3360
+ #
3361
+ # @example Example: VerifyDomainIdentity
3362
+ #
3363
+ # # The following example starts the domain verification process with Amazon SES:
3364
+ #
3365
+ # resp = client.verify_domain_identity({
3366
+ # domain: "example.com",
3367
+ # })
3368
+ #
3369
+ # resp.to_h outputs the following:
3370
+ # {
3371
+ # verification_token: "eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE",
3372
+ # }
3373
+ #
2688
3374
  # @example Request syntax with placeholder values
2689
3375
  #
2690
3376
  # resp = client.verify_domain_identity({
@@ -2718,6 +3404,15 @@ module Aws::SES
2718
3404
  #
2719
3405
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2720
3406
  #
3407
+ #
3408
+ # @example Example: VerifyEmailAddress
3409
+ #
3410
+ # # The following example starts the email address verification process with Amazon SES:
3411
+ #
3412
+ # resp = client.verify_email_address({
3413
+ # email_address: "user@example.com",
3414
+ # })
3415
+ #
2721
3416
  # @example Request syntax with placeholder values
2722
3417
  #
2723
3418
  # resp = client.verify_email_address({
@@ -2743,6 +3438,15 @@ module Aws::SES
2743
3438
  #
2744
3439
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2745
3440
  #
3441
+ #
3442
+ # @example Example: VerifyEmailIdentity
3443
+ #
3444
+ # # The following example starts the email address verification process with Amazon SES:
3445
+ #
3446
+ # resp = client.verify_email_identity({
3447
+ # email_address: "user@example.com",
3448
+ # })
3449
+ #
2746
3450
  # @example Request syntax with placeholder values
2747
3451
  #
2748
3452
  # resp = client.verify_email_identity({
@@ -2771,7 +3475,7 @@ module Aws::SES
2771
3475
  params: params,
2772
3476
  config: config)
2773
3477
  context[:gem_name] = 'aws-sdk-ses'
2774
- context[:gem_version] = '1.0.0.rc5'
3478
+ context[:gem_version] = '1.0.0.rc6'
2775
3479
  Seahorse::Client::Request.new(handlers, context)
2776
3480
  end
2777
3481
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-ses
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0.rc5
4
+ version: 1.0.0.rc6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-05-23 00:00:00.000000000 Z
11
+ date: 2017-06-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: 3.0.0.rc12
19
+ version: 3.0.0.rc14
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: 3.0.0.rc12
26
+ version: 3.0.0.rc14
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: aws-sigv4
29
29
  requirement: !ruby/object:Gem::Requirement