aws-sdk-sesv2 1.1.0 → 1.2.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: e5546ebd009ad347c0bdc2c27708156ef89d67e2
4
- data.tar.gz: 32b5539035701be0f4604c1a6052811b923bd7c2
3
+ metadata.gz: 687465c13b7c7b2d474e8013715a81b434be92ec
4
+ data.tar.gz: 65fdd800a880ab66d1ff973823c407582aa61a78
5
5
  SHA512:
6
- metadata.gz: 732926fbaed8d753ada4876c08558275a5ff07a6e1740bfde12cdc4a8ebcf2b16283d41d2ed8deb6ba90535c3a8ad4069c188583fb40ba37bdcc5ee1259e9061
7
- data.tar.gz: 04f6e715cd46ec7ed57bcc96993c140a8ec653bf64fe0777caa3b03050739d429cebb077cd9d24b7888152f4467ce1a0555884ec1142bee9a83947e375e785c5
6
+ metadata.gz: 219c70243e9ff96bbaa71363b69076baba28c3c79f145997cfb33441138aedc4013aa19623218391f7a10887cfe430352c118584cb0bf8046e210c828f63e9b9
7
+ data.tar.gz: af3730d329afe2cc5352c753aba125bef6ad91d2dade895cf94d021fe341c672ae5d3a2b14766e3d640c55cc68b154ab414e1e9f604e55cf92a5c354dd43b29e
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-sesv2/customizations'
42
42
  # @service
43
43
  module Aws::SESV2
44
44
 
45
- GEM_VERSION = '1.1.0'
45
+ GEM_VERSION = '1.2.0'
46
46
 
47
47
  end
@@ -285,8 +285,8 @@ module Aws::SESV2
285
285
  # want to associate with the configuration set.
286
286
  #
287
287
  # @option params [Types::SuppressionOptions] :suppression_options
288
- # An object that contains information about your account's suppression
289
- # preferences.
288
+ # An object that contains information about the suppression list
289
+ # preferences for your account.
290
290
  #
291
291
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
292
292
  #
@@ -432,10 +432,10 @@ module Aws::SESV2
432
432
  # by various email providers around the world. When you perform a
433
433
  # predictive inbox placement test, you provide a sample message that
434
434
  # contains the content that you plan to send to your customers. Amazon
435
- # SES API v2 then sends that message to special email addresses spread
436
- # across several major email providers. After about 24 hours, the test
437
- # is complete, and you can use the `GetDeliverabilityTestReport`
438
- # operation to view the results of the test.
435
+ # SES then sends that message to special email addresses spread across
436
+ # several major email providers. After about 24 hours, the test is
437
+ # complete, and you can use the `GetDeliverabilityTestReport` operation
438
+ # to view the results of the test.
439
439
  #
440
440
  # @option params [String] :report_name
441
441
  # A unique name that helps you to identify the predictive inbox
@@ -521,12 +521,26 @@ module Aws::SESV2
521
521
  # address. Your email address is verified as soon as you follow the link
522
522
  # in the verification email.
523
523
  #
524
- # When you verify a domain, this operation provides a set of DKIM
525
- # tokens, which you can convert into CNAME tokens. You add these CNAME
526
- # tokens to the DNS configuration for your domain. Your domain is
524
+ # When you verify a domain without specifying the
525
+ # `DkimSigningAttributes` object, this operation provides a set of DKIM
526
+ # tokens. You can convert these tokens into CNAME records, which you
527
+ # then add to the DNS configuration for your domain. Your domain is
527
528
  # verified when Amazon SES detects these records in the DNS
528
- # configuration for your domain. For some DNS providers, it can take 72
529
- # hours or more to complete the domain verification process.
529
+ # configuration for your domain. This verification method is known as
530
+ # [Easy DKIM][1].
531
+ #
532
+ # Alternatively, you can perform the verification process by providing
533
+ # your own public-private key pair. This verification method is known as
534
+ # Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the
535
+ # `CreateEmailIdentity` operation has to include the
536
+ # `DkimSigningAttributes` object. When you specify this object, you
537
+ # provide a selector (a component of the DNS record name that identifies
538
+ # the public key that you want to use for DKIM authentication) and a
539
+ # private key.
540
+ #
541
+ #
542
+ #
543
+ # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
530
544
  #
531
545
  # @option params [required, String] :email_identity
532
546
  # The email address or domain that you want to verify.
@@ -535,6 +549,18 @@ module Aws::SESV2
535
549
  # An array of objects that define the tags (keys and values) that you
536
550
  # want to associate with the email identity.
537
551
  #
552
+ # @option params [Types::DkimSigningAttributes] :dkim_signing_attributes
553
+ # If your request includes this object, Amazon SES configures the
554
+ # identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication
555
+ # purposes, as opposed to the default method, [Easy DKIM][1].
556
+ #
557
+ # You can only specify this object if the email identity is a domain, as
558
+ # opposed to an address.
559
+ #
560
+ #
561
+ #
562
+ # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
563
+ #
538
564
  # @return [Types::CreateEmailIdentityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
539
565
  #
540
566
  # * {Types::CreateEmailIdentityResponse#identity_type #identity_type} => String
@@ -551,6 +577,10 @@ module Aws::SESV2
551
577
  # value: "TagValue", # required
552
578
  # },
553
579
  # ],
580
+ # dkim_signing_attributes: {
581
+ # domain_signing_selector: "Selector", # required
582
+ # domain_signing_private_key: "PrivateKey", # required
583
+ # },
554
584
  # })
555
585
  #
556
586
  # @example Response structure
@@ -561,6 +591,7 @@ module Aws::SESV2
561
591
  # resp.dkim_attributes.status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED"
562
592
  # resp.dkim_attributes.tokens #=> Array
563
593
  # resp.dkim_attributes.tokens[0] #=> String
594
+ # resp.dkim_attributes.signing_attributes_origin #=> String, one of "AWS_SES", "EXTERNAL"
564
595
  #
565
596
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailIdentity AWS API Documentation
566
597
  #
@@ -679,11 +710,11 @@ module Aws::SESV2
679
710
  req.send_request(options)
680
711
  end
681
712
 
682
- # Used to delete a suppressed email destination from your suppression
683
- # list.
713
+ # Removes an email address from the suppression list for your account.
684
714
  #
685
715
  # @option params [required, String] :email_address
686
- # The suppressed email destination to delete.
716
+ # The suppressed email destination to remove from the account
717
+ # suppression list.
687
718
  #
688
719
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
689
720
  #
@@ -965,11 +996,11 @@ module Aws::SESV2
965
996
  # subscription charge, in addition to any other fees that you accrue by
966
997
  # using Amazon SES and other AWS services. For more information about
967
998
  # the features and cost of a Deliverability dashboard subscription, see
968
- # [Amazon Pinpoint Pricing][1].
999
+ # [Amazon SES Pricing][1].
969
1000
  #
970
1001
  #
971
1002
  #
972
- # [1]: http://aws.amazon.com/pinpoint/pricing/
1003
+ # [1]: http://aws.amazon.com/ses/pricing/
973
1004
  #
974
1005
  # @return [Types::GetDeliverabilityDashboardOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
975
1006
  #
@@ -1199,6 +1230,7 @@ module Aws::SESV2
1199
1230
  # resp.dkim_attributes.status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED"
1200
1231
  # resp.dkim_attributes.tokens #=> Array
1201
1232
  # resp.dkim_attributes.tokens[0] #=> String
1233
+ # resp.dkim_attributes.signing_attributes_origin #=> String, one of "AWS_SES", "EXTERNAL"
1202
1234
  # resp.mail_from_attributes.mail_from_domain #=> String
1203
1235
  # resp.mail_from_attributes.mail_from_domain_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE"
1204
1236
  # resp.mail_from_attributes.behavior_on_mx_failure #=> String, one of "USE_DEFAULT_VALUE", "REJECT_MESSAGE"
@@ -1215,11 +1247,11 @@ module Aws::SESV2
1215
1247
  req.send_request(options)
1216
1248
  end
1217
1249
 
1218
- # Used to fetch a single suppressed email destination from your
1219
- # suppression list.
1250
+ # Retrieves information about a specific email address that's on the
1251
+ # suppression list for your account.
1220
1252
  #
1221
1253
  # @option params [required, String] :email_address
1222
- # Email destination to fetch from the suppression list.
1254
+ # The email address that's on the account suppression list.
1223
1255
  #
1224
1256
  # @return [Types::GetSuppressedDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1225
1257
  #
@@ -1508,21 +1540,25 @@ module Aws::SESV2
1508
1540
  req.send_request(options)
1509
1541
  end
1510
1542
 
1511
- # Used to fetch a list suppressed email destinations from your
1512
- # suppression list.
1543
+ # Retrieves a list of email addresses that are on the suppression list
1544
+ # for your account.
1513
1545
  #
1514
1546
  # @option params [Array<String>] :reasons
1515
- # Filters email destinations suppressed by the given reasons.
1547
+ # The factors that caused the email address to be added to .
1516
1548
  #
1517
1549
  # @option params [Time,DateTime,Date,Integer,String] :start_date
1518
- # Filters email destinations suppressed before the given time.
1550
+ # Used to filter the list of suppressed email destinations so that it
1551
+ # only includes addresses that were added to the list after a specific
1552
+ # date. The date that you specify should be in Unix time format.
1519
1553
  #
1520
1554
  # @option params [Time,DateTime,Date,Integer,String] :end_date
1521
- # Filters email destinations suppressed after the given time.
1555
+ # Used to filter the list of suppressed email destinations so that it
1556
+ # only includes addresses that were added to the list before a specific
1557
+ # date. The date that you specify should be in Unix time format.
1522
1558
  #
1523
1559
  # @option params [String] :next_token
1524
1560
  # A token returned from a previous call to `ListSuppressedDestinations`
1525
- # to indicate the position in the list of suppressed email destinations.
1561
+ # to indicate the position in the list of suppressed email addresses.
1526
1562
  #
1527
1563
  # @option params [Integer] :page_size
1528
1564
  # The number of results to show in a single call to
@@ -1653,17 +1689,20 @@ module Aws::SESV2
1653
1689
  req.send_request(options)
1654
1690
  end
1655
1691
 
1656
- # Change your account's suppression preferences for your account.
1692
+ # Change the settings for the account-level suppression list.
1657
1693
  #
1658
1694
  # @option params [Array<String>] :suppressed_reasons
1659
- # A list of reasons to suppress email addresses. The only valid reasons
1660
- # are:
1695
+ # A list that contains the reasons that email addresses will be
1696
+ # automatically added to the suppression list for your account. This
1697
+ # list can contain any or all of the following:
1661
1698
  #
1662
- # * `COMPLAINT` – Amazon SES will suppress an email address that
1663
- # receives a complaint.
1699
+ # * `COMPLAINT` – Amazon SES adds an email address to the suppression
1700
+ # list for your account when a message sent to that address results in
1701
+ # a complaint.
1664
1702
  #
1665
- # * `BOUNCE` – Amazon SES will suppress an email address that hard
1666
- # bounces.
1703
+ # * `BOUNCE` – Amazon SES adds an email address to the suppression list
1704
+ # for your account when a message sent to that address results in a
1705
+ # hard bounce.
1667
1706
  #
1668
1707
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1669
1708
  #
@@ -1779,22 +1818,25 @@ module Aws::SESV2
1779
1818
  req.send_request(options)
1780
1819
  end
1781
1820
 
1782
- # Specify your account's suppression preferences for a configuration
1821
+ # Specify the account suppression list preferences for a configuration
1783
1822
  # set.
1784
1823
  #
1785
1824
  # @option params [required, String] :configuration_set_name
1786
- # The name of the configuration set that you want to enable or disable
1787
- # email sending for.
1825
+ # The name of the configuration set that you want to change the
1826
+ # suppression list preferences for.
1788
1827
  #
1789
1828
  # @option params [Array<String>] :suppressed_reasons
1790
- # A list of reasons to suppress email addresses. The only valid reasons
1791
- # are:
1829
+ # A list that contains the reasons that email addresses are
1830
+ # automatically added to the suppression list for your account. This
1831
+ # list can contain any or all of the following:
1792
1832
  #
1793
- # * `COMPLAINT` – Amazon SES will suppress an email address that
1794
- # receives a complaint.
1833
+ # * `COMPLAINT` – Amazon SES adds an email address to the suppression
1834
+ # list for your account when a message sent to that address results in
1835
+ # a complaint.
1795
1836
  #
1796
- # * `BOUNCE` – Amazon SES will suppress an email address that hard
1797
- # bounces.
1837
+ # * `BOUNCE` – Amazon SES adds an email address to the suppression list
1838
+ # for your account when a message sent to that address results in a
1839
+ # hard bounce.
1798
1840
  #
1799
1841
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1800
1842
  #
@@ -1915,11 +1957,11 @@ module Aws::SESV2
1915
1957
  # subscription charge, in addition to any other fees that you accrue by
1916
1958
  # using Amazon SES and other AWS services. For more information about
1917
1959
  # the features and cost of a Deliverability dashboard subscription, see
1918
- # [Amazon Pinpoint Pricing][1].
1960
+ # [Amazon SES Pricing][1].
1919
1961
  #
1920
1962
  #
1921
1963
  #
1922
- # [1]: http://aws.amazon.com/pinpoint/pricing/
1964
+ # [1]: http://aws.amazon.com/ses/pricing/
1923
1965
  #
1924
1966
  # @option params [required, Boolean] :dashboard_enabled
1925
1967
  # Specifies whether to enable the Deliverability dashboard. To enable
@@ -1986,6 +2028,74 @@ module Aws::SESV2
1986
2028
  req.send_request(options)
1987
2029
  end
1988
2030
 
2031
+ # Used to configure or change the DKIM authentication settings for an
2032
+ # email domain identity. You can use this operation to do any of the
2033
+ # following:
2034
+ #
2035
+ # * Update the signing attributes for an identity that uses Bring Your
2036
+ # Own DKIM (BYODKIM).
2037
+ #
2038
+ # * Change from using no DKIM authentication to using Easy DKIM.
2039
+ #
2040
+ # * Change from using no DKIM authentication to using BYODKIM.
2041
+ #
2042
+ # * Change from using Easy DKIM to using BYODKIM.
2043
+ #
2044
+ # * Change from using BYODKIM to using Easy DKIM.
2045
+ #
2046
+ # @option params [required, String] :email_identity
2047
+ # The email identity that you want to configure DKIM for.
2048
+ #
2049
+ # @option params [required, String] :signing_attributes_origin
2050
+ # The method that you want to use to configure DKIM for the identity.
2051
+ # There are two possible values:
2052
+ #
2053
+ # * `AWS_SES` – Configure DKIM for the identity by using [Easy DKIM][1].
2054
+ #
2055
+ # * `EXTERNAL` – Configure DKIM for the identity by using Bring Your Own
2056
+ # DKIM (BYODKIM).
2057
+ #
2058
+ #
2059
+ #
2060
+ # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
2061
+ #
2062
+ # @option params [Types::DkimSigningAttributes] :signing_attributes
2063
+ # An object that contains information about the private key and selector
2064
+ # that you want to use to configure DKIM for the identity. This object
2065
+ # is only required if you want to configure Bring Your Own DKIM
2066
+ # (BYODKIM) for the identity.
2067
+ #
2068
+ # @return [Types::PutEmailIdentityDkimSigningAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2069
+ #
2070
+ # * {Types::PutEmailIdentityDkimSigningAttributesResponse#dkim_status #dkim_status} => String
2071
+ # * {Types::PutEmailIdentityDkimSigningAttributesResponse#dkim_tokens #dkim_tokens} => Array&lt;String&gt;
2072
+ #
2073
+ # @example Request syntax with placeholder values
2074
+ #
2075
+ # resp = client.put_email_identity_dkim_signing_attributes({
2076
+ # email_identity: "Identity", # required
2077
+ # signing_attributes_origin: "AWS_SES", # required, accepts AWS_SES, EXTERNAL
2078
+ # signing_attributes: {
2079
+ # domain_signing_selector: "Selector", # required
2080
+ # domain_signing_private_key: "PrivateKey", # required
2081
+ # },
2082
+ # })
2083
+ #
2084
+ # @example Response structure
2085
+ #
2086
+ # resp.dkim_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED"
2087
+ # resp.dkim_tokens #=> Array
2088
+ # resp.dkim_tokens[0] #=> String
2089
+ #
2090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutEmailIdentityDkimSigningAttributes AWS API Documentation
2091
+ #
2092
+ # @overload put_email_identity_dkim_signing_attributes(params = {})
2093
+ # @param [Hash] params ({})
2094
+ def put_email_identity_dkim_signing_attributes(params = {}, options = {})
2095
+ req = build_request(:put_email_identity_dkim_signing_attributes, params)
2096
+ req.send_request(options)
2097
+ end
2098
+
1989
2099
  # Used to enable or disable feedback forwarding for an identity. This
1990
2100
  # setting determines what happens when an identity is used to send an
1991
2101
  # email that results in a bounce or complaint event.
@@ -2084,13 +2194,15 @@ module Aws::SESV2
2084
2194
  req.send_request(options)
2085
2195
  end
2086
2196
 
2087
- # Puts (overwrites) an email destination in your suppression list.
2197
+ # Adds an email address to the suppression list for your account.
2088
2198
  #
2089
2199
  # @option params [required, String] :email_address
2090
- # Email destination to be suppressed.
2200
+ # The email address that should be added to the suppression list for
2201
+ # your account.
2091
2202
  #
2092
2203
  # @option params [required, String] :reason
2093
- # Reason for which the email destination is suppressed.
2204
+ # The factors that should cause the email address to be added to the
2205
+ # suppression list for your account.
2094
2206
  #
2095
2207
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2096
2208
  #
@@ -2115,7 +2227,7 @@ module Aws::SESV2
2115
2227
  #
2116
2228
  # * **Simple** – A standard email message. When you create this type of
2117
2229
  # message, you specify the sender, the recipient, and the message
2118
- # body, and the Amazon SES API v2 assembles the message for you.
2230
+ # body, and Amazon SES assembles the message for you.
2119
2231
  #
2120
2232
  # * **Raw** – A raw, MIME-formatted email message. When you send this
2121
2233
  # type of email, you have to specify all of the message headers, as
@@ -2366,7 +2478,7 @@ module Aws::SESV2
2366
2478
  params: params,
2367
2479
  config: config)
2368
2480
  context[:gem_name] = 'aws-sdk-sesv2'
2369
- context[:gem_version] = '1.1.0'
2481
+ context[:gem_version] = '1.2.0'
2370
2482
  Seahorse::Client::Request.new(handlers, context)
2371
2483
  end
2372
2484
 
@@ -68,6 +68,8 @@ module Aws::SESV2
68
68
  DimensionName = Shapes::StringShape.new(name: 'DimensionName')
69
69
  DimensionValueSource = Shapes::StringShape.new(name: 'DimensionValueSource')
70
70
  DkimAttributes = Shapes::StructureShape.new(name: 'DkimAttributes')
71
+ DkimSigningAttributes = Shapes::StructureShape.new(name: 'DkimSigningAttributes')
72
+ DkimSigningAttributesOrigin = Shapes::StringShape.new(name: 'DkimSigningAttributesOrigin')
71
73
  DkimStatus = Shapes::StringShape.new(name: 'DkimStatus')
72
74
  DnsToken = Shapes::StringShape.new(name: 'DnsToken')
73
75
  DnsTokenList = Shapes::ListShape.new(name: 'DnsTokenList')
@@ -171,6 +173,7 @@ module Aws::SESV2
171
173
  PinpointDestination = Shapes::StructureShape.new(name: 'PinpointDestination')
172
174
  PlacementStatistics = Shapes::StructureShape.new(name: 'PlacementStatistics')
173
175
  PoolName = Shapes::StringShape.new(name: 'PoolName')
176
+ PrivateKey = Shapes::StringShape.new(name: 'PrivateKey')
174
177
  PutAccountDedicatedIpWarmupAttributesRequest = Shapes::StructureShape.new(name: 'PutAccountDedicatedIpWarmupAttributesRequest')
175
178
  PutAccountDedicatedIpWarmupAttributesResponse = Shapes::StructureShape.new(name: 'PutAccountDedicatedIpWarmupAttributesResponse')
176
179
  PutAccountSendingAttributesRequest = Shapes::StructureShape.new(name: 'PutAccountSendingAttributesRequest')
@@ -195,6 +198,8 @@ module Aws::SESV2
195
198
  PutDeliverabilityDashboardOptionResponse = Shapes::StructureShape.new(name: 'PutDeliverabilityDashboardOptionResponse')
196
199
  PutEmailIdentityDkimAttributesRequest = Shapes::StructureShape.new(name: 'PutEmailIdentityDkimAttributesRequest')
197
200
  PutEmailIdentityDkimAttributesResponse = Shapes::StructureShape.new(name: 'PutEmailIdentityDkimAttributesResponse')
201
+ PutEmailIdentityDkimSigningAttributesRequest = Shapes::StructureShape.new(name: 'PutEmailIdentityDkimSigningAttributesRequest')
202
+ PutEmailIdentityDkimSigningAttributesResponse = Shapes::StructureShape.new(name: 'PutEmailIdentityDkimSigningAttributesResponse')
198
203
  PutEmailIdentityFeedbackAttributesRequest = Shapes::StructureShape.new(name: 'PutEmailIdentityFeedbackAttributesRequest')
199
204
  PutEmailIdentityFeedbackAttributesResponse = Shapes::StructureShape.new(name: 'PutEmailIdentityFeedbackAttributesResponse')
200
205
  PutEmailIdentityMailFromAttributesRequest = Shapes::StructureShape.new(name: 'PutEmailIdentityMailFromAttributesRequest')
@@ -207,6 +212,7 @@ module Aws::SESV2
207
212
  ReportId = Shapes::StringShape.new(name: 'ReportId')
208
213
  ReportName = Shapes::StringShape.new(name: 'ReportName')
209
214
  ReputationOptions = Shapes::StructureShape.new(name: 'ReputationOptions')
215
+ Selector = Shapes::StringShape.new(name: 'Selector')
210
216
  SendEmailRequest = Shapes::StructureShape.new(name: 'SendEmailRequest')
211
217
  SendEmailResponse = Shapes::StructureShape.new(name: 'SendEmailResponse')
212
218
  SendQuota = Shapes::StructureShape.new(name: 'SendQuota')
@@ -314,6 +320,7 @@ module Aws::SESV2
314
320
 
315
321
  CreateEmailIdentityRequest.add_member(:email_identity, Shapes::ShapeRef.new(shape: Identity, required: true, location_name: "EmailIdentity"))
316
322
  CreateEmailIdentityRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
323
+ CreateEmailIdentityRequest.add_member(:dkim_signing_attributes, Shapes::ShapeRef.new(shape: DkimSigningAttributes, location_name: "DkimSigningAttributes"))
317
324
  CreateEmailIdentityRequest.struct_class = Types::CreateEmailIdentityRequest
318
325
 
319
326
  CreateEmailIdentityResponse.add_member(:identity_type, Shapes::ShapeRef.new(shape: IdentityType, location_name: "IdentityType"))
@@ -384,8 +391,13 @@ module Aws::SESV2
384
391
  DkimAttributes.add_member(:signing_enabled, Shapes::ShapeRef.new(shape: Enabled, location_name: "SigningEnabled"))
385
392
  DkimAttributes.add_member(:status, Shapes::ShapeRef.new(shape: DkimStatus, location_name: "Status"))
386
393
  DkimAttributes.add_member(:tokens, Shapes::ShapeRef.new(shape: DnsTokenList, location_name: "Tokens"))
394
+ DkimAttributes.add_member(:signing_attributes_origin, Shapes::ShapeRef.new(shape: DkimSigningAttributesOrigin, location_name: "SigningAttributesOrigin"))
387
395
  DkimAttributes.struct_class = Types::DkimAttributes
388
396
 
397
+ DkimSigningAttributes.add_member(:domain_signing_selector, Shapes::ShapeRef.new(shape: Selector, required: true, location_name: "DomainSigningSelector"))
398
+ DkimSigningAttributes.add_member(:domain_signing_private_key, Shapes::ShapeRef.new(shape: PrivateKey, required: true, location_name: "DomainSigningPrivateKey"))
399
+ DkimSigningAttributes.struct_class = Types::DkimSigningAttributes
400
+
389
401
  DnsTokenList.member = Shapes::ShapeRef.new(shape: DnsToken)
390
402
 
391
403
  DomainDeliverabilityCampaign.add_member(:campaign_id, Shapes::ShapeRef.new(shape: CampaignId, location_name: "CampaignId"))
@@ -739,6 +751,15 @@ module Aws::SESV2
739
751
 
740
752
  PutEmailIdentityDkimAttributesResponse.struct_class = Types::PutEmailIdentityDkimAttributesResponse
741
753
 
754
+ PutEmailIdentityDkimSigningAttributesRequest.add_member(:email_identity, Shapes::ShapeRef.new(shape: Identity, required: true, location: "uri", location_name: "EmailIdentity"))
755
+ PutEmailIdentityDkimSigningAttributesRequest.add_member(:signing_attributes_origin, Shapes::ShapeRef.new(shape: DkimSigningAttributesOrigin, required: true, location_name: "SigningAttributesOrigin"))
756
+ PutEmailIdentityDkimSigningAttributesRequest.add_member(:signing_attributes, Shapes::ShapeRef.new(shape: DkimSigningAttributes, location_name: "SigningAttributes"))
757
+ PutEmailIdentityDkimSigningAttributesRequest.struct_class = Types::PutEmailIdentityDkimSigningAttributesRequest
758
+
759
+ PutEmailIdentityDkimSigningAttributesResponse.add_member(:dkim_status, Shapes::ShapeRef.new(shape: DkimStatus, location_name: "DkimStatus"))
760
+ PutEmailIdentityDkimSigningAttributesResponse.add_member(:dkim_tokens, Shapes::ShapeRef.new(shape: DnsTokenList, location_name: "DkimTokens"))
761
+ PutEmailIdentityDkimSigningAttributesResponse.struct_class = Types::PutEmailIdentityDkimSigningAttributesResponse
762
+
742
763
  PutEmailIdentityFeedbackAttributesRequest.add_member(:email_identity, Shapes::ShapeRef.new(shape: Identity, required: true, location: "uri", location_name: "EmailIdentity"))
743
764
  PutEmailIdentityFeedbackAttributesRequest.add_member(:email_forwarding_enabled, Shapes::ShapeRef.new(shape: Enabled, location_name: "EmailForwardingEnabled"))
744
765
  PutEmailIdentityFeedbackAttributesRequest.struct_class = Types::PutEmailIdentityFeedbackAttributesRequest
@@ -935,6 +956,7 @@ module Aws::SESV2
935
956
  o.http_request_uri = "/v2/email/identities"
936
957
  o.input = Shapes::ShapeRef.new(shape: CreateEmailIdentityRequest)
937
958
  o.output = Shapes::ShapeRef.new(shape: CreateEmailIdentityResponse)
959
+ o.errors << Shapes::ShapeRef.new(shape: AlreadyExistsException)
938
960
  o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
939
961
  o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
940
962
  o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
@@ -1377,6 +1399,17 @@ module Aws::SESV2
1377
1399
  o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
1378
1400
  end)
1379
1401
 
1402
+ api.add_operation(:put_email_identity_dkim_signing_attributes, Seahorse::Model::Operation.new.tap do |o|
1403
+ o.name = "PutEmailIdentityDkimSigningAttributes"
1404
+ o.http_method = "PUT"
1405
+ o.http_request_uri = "/v1/email/identities/{EmailIdentity}/dkim/signing"
1406
+ o.input = Shapes::ShapeRef.new(shape: PutEmailIdentityDkimSigningAttributesRequest)
1407
+ o.output = Shapes::ShapeRef.new(shape: PutEmailIdentityDkimSigningAttributesResponse)
1408
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
1409
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
1410
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
1411
+ end)
1412
+
1380
1413
  api.add_operation(:put_email_identity_feedback_attributes, Seahorse::Model::Operation.new.tap do |o|
1381
1414
  o.name = "PutEmailIdentityFeedbackAttributes"
1382
1415
  o.http_method = "PUT"
@@ -168,9 +168,9 @@ module Aws::SESV2
168
168
  #
169
169
  # @!attribute [rw] charset
170
170
  # The character set for the content. Because of the constraints of the
171
- # SMTP protocol, the Amazon SES API v2 uses 7-bit ASCII by default. If
172
- # the text includes characters outside of the ASCII range, you have to
173
- # specify a character set. For example, you could specify `UTF-8`,
171
+ # SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text
172
+ # includes characters outside of the ASCII range, you have to specify
173
+ # a character set. For example, you could specify `UTF-8`,
174
174
  # `ISO-8859-1`, or `Shift_JIS`.
175
175
  # @return [String]
176
176
  #
@@ -307,8 +307,8 @@ module Aws::SESV2
307
307
  # @return [Array<Types::Tag>]
308
308
  #
309
309
  # @!attribute [rw] suppression_options
310
- # An object that contains information about your account's
311
- # suppression preferences.
310
+ # An object that contains information about the suppression list
311
+ # preferences for your account.
312
312
  # @return [Types::SuppressionOptions]
313
313
  #
314
314
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateConfigurationSetRequest AWS API Documentation
@@ -488,6 +488,10 @@ module Aws::SESV2
488
488
  # value: "TagValue", # required
489
489
  # },
490
490
  # ],
491
+ # dkim_signing_attributes: {
492
+ # domain_signing_selector: "Selector", # required
493
+ # domain_signing_private_key: "PrivateKey", # required
494
+ # },
491
495
  # }
492
496
  #
493
497
  # @!attribute [rw] email_identity
@@ -499,18 +503,31 @@ module Aws::SESV2
499
503
  # want to associate with the email identity.
500
504
  # @return [Array<Types::Tag>]
501
505
  #
506
+ # @!attribute [rw] dkim_signing_attributes
507
+ # If your request includes this object, Amazon SES configures the
508
+ # identity to use Bring Your Own DKIM (BYODKIM) for DKIM
509
+ # authentication purposes, as opposed to the default method, [Easy
510
+ # DKIM][1].
511
+ #
512
+ # You can only specify this object if the email identity is a domain,
513
+ # as opposed to an address.
514
+ #
515
+ #
516
+ #
517
+ # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
518
+ # @return [Types::DkimSigningAttributes]
519
+ #
502
520
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailIdentityRequest AWS API Documentation
503
521
  #
504
522
  class CreateEmailIdentityRequest < Struct.new(
505
523
  :email_identity,
506
- :tags)
524
+ :tags,
525
+ :dkim_signing_attributes)
507
526
  include Aws::Structure
508
527
  end
509
528
 
510
- # If the email identity is a domain, this object contains tokens that
511
- # you can use to create a set of CNAME records. To sucessfully verify
512
- # your domain, you have to add these records to the DNS configuration
513
- # for your domain.
529
+ # If the email identity is a domain, this object contains information
530
+ # about the DKIM verification status for the domain.
514
531
  #
515
532
  # If the email identity is an email address, this object is empty.
516
533
  #
@@ -530,9 +547,7 @@ module Aws::SESV2
530
547
  #
531
548
  # @!attribute [rw] dkim_attributes
532
549
  # An object that contains information about the DKIM attributes for
533
- # the identity. This object includes the tokens that you use to create
534
- # the CNAME records that are required to complete the DKIM
535
- # verification process.
550
+ # the identity.
536
551
  # @return [Types::DkimAttributes]
537
552
  #
538
553
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailIdentityResponse AWS API Documentation
@@ -572,7 +587,7 @@ module Aws::SESV2
572
587
  end
573
588
 
574
589
  # Contains information about a dedicated IP address that is associated
575
- # with your Amazon SES API v2 account.
590
+ # with your Amazon SES account.
576
591
  #
577
592
  # To learn more about requesting dedicated IP addresses, see [Requesting
578
593
  # and Relinquishing Dedicated IP Addresses][1] in the *Amazon SES
@@ -737,7 +752,8 @@ module Aws::SESV2
737
752
  #
738
753
  class DeleteEmailIdentityResponse < Aws::EmptyStructure; end
739
754
 
740
- # A request to delete a suppressed email destination.
755
+ # A request to remove an email address from the suppression list for
756
+ # your account.
741
757
  #
742
758
  # @note When making an API call, you may pass DeleteSuppressedDestinationRequest
743
759
  # data as a hash:
@@ -747,7 +763,8 @@ module Aws::SESV2
747
763
  # }
748
764
  #
749
765
  # @!attribute [rw] email_address
750
- # The suppressed email destination to delete.
766
+ # The suppressed email destination to remove from the account
767
+ # suppression list.
751
768
  # @return [String]
752
769
  #
753
770
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteSuppressedDestinationRequest AWS API Documentation
@@ -878,8 +895,22 @@ module Aws::SESV2
878
895
  include Aws::Structure
879
896
  end
880
897
 
881
- # An object that contains information about the DKIM configuration for
882
- # an email identity.
898
+ # An object that contains information about the DKIM authentication
899
+ # status for an email identity.
900
+ #
901
+ # Amazon SES determines the authentication status by searching for
902
+ # specific records in the DNS configuration for the domain. If you used
903
+ # [Easy DKIM][1] to set up DKIM authentication, Amazon SES tries to find
904
+ # three unique CNAME records in the DNS configuration for your domain.
905
+ # If you provided a public key to perform DKIM authentication, Amazon
906
+ # SES tries to find a TXT record that uses the selector that you
907
+ # specified. The value of the TXT record must be a public key that's
908
+ # paired with the private key that you specified in the process of
909
+ # creating the identity
910
+ #
911
+ #
912
+ #
913
+ # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
883
914
  #
884
915
  # @!attribute [rw] signing_enabled
885
916
  # If the value is `true`, then the messages that you send from the
@@ -892,40 +923,97 @@ module Aws::SESV2
892
923
  # DKIM records in the DNS records for the domain. The status can be
893
924
  # one of the following:
894
925
  #
895
- # * `PENDING` – Amazon SES hasn't yet detected the DKIM records in
896
- # the DNS configuration for the domain, but will continue to attempt
897
- # to locate them.
926
+ # * `PENDING` – The verification process was initiated, but Amazon SES
927
+ # hasn't yet detected the DKIM records in the DNS configuration for
928
+ # the domain.
898
929
  #
899
- # * `SUCCESS` – Amazon SES located the DKIM records in the DNS
900
- # configuration for the domain and determined that they're correct.
901
- # You can now send DKIM-signed email from the identity.
930
+ # * `SUCCESS` – The verification process completed successfully.
902
931
  #
903
- # * `FAILED` – Amazon SES wasn't able to locate the DKIM records in
904
- # the DNS settings for the domain, and won't continue to search for
905
- # them.
932
+ # * `FAILED` – The verification process failed. This typically occurs
933
+ # when Amazon SES fails to find the DKIM records in the DNS
934
+ # configuration of the domain.
906
935
  #
907
- # * `TEMPORARY_FAILURE` – A temporary issue occurred, which prevented
908
- # Amazon SES from determining the DKIM status for the domain.
936
+ # * `TEMPORARY_FAILURE` – A temporary issue is preventing Amazon SES
937
+ # from determining the DKIM authentication status of the domain.
909
938
  #
910
- # * `NOT_STARTED` – Amazon SES hasn't yet started searching for the
911
- # DKIM records in the DKIM records for the domain.
939
+ # * `NOT_STARTED` – The DKIM verification process hasn't been
940
+ # initiated for the domain.
912
941
  # @return [String]
913
942
  #
914
943
  # @!attribute [rw] tokens
915
- # A set of unique strings that you use to create a set of CNAME
916
- # records that you add to the DNS configuration for your domain. When
917
- # Amazon SES detects these records in the DNS configuration for your
918
- # domain, the DKIM authentication process is complete. Amazon SES
919
- # usually detects these records within about 72 hours of adding them
920
- # to the DNS configuration for your domain.
944
+ # If you used [Easy DKIM][1] to configure DKIM authentication for the
945
+ # domain, then this object contains a set of unique strings that you
946
+ # use to create a set of CNAME records that you add to the DNS
947
+ # configuration for your domain. When Amazon SES detects these records
948
+ # in the DNS configuration for your domain, the DKIM authentication
949
+ # process is complete.
950
+ #
951
+ # If you configured DKIM authentication for the domain by providing
952
+ # your own public-private key pair, then this object contains the
953
+ # selector for the public key.
954
+ #
955
+ # Regardless of the DKIM authentication method you use, Amazon SES
956
+ # searches for the appropriate records in the DNS configuration of the
957
+ # domain for up to 72 hours.
958
+ #
959
+ #
960
+ #
961
+ # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
921
962
  # @return [Array<String>]
922
963
  #
964
+ # @!attribute [rw] signing_attributes_origin
965
+ # A string that indicates how DKIM was configured for the identity.
966
+ # There are two possible values:
967
+ #
968
+ # * `AWS_SES` – Indicates that DKIM was configured for the identity by
969
+ # using [Easy DKIM][1].
970
+ #
971
+ # * `EXTERNAL` – Indicates that DKIM was configured for the identity
972
+ # by using Bring Your Own DKIM (BYODKIM).
973
+ #
974
+ #
975
+ #
976
+ # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
977
+ # @return [String]
978
+ #
923
979
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DkimAttributes AWS API Documentation
924
980
  #
925
981
  class DkimAttributes < Struct.new(
926
982
  :signing_enabled,
927
983
  :status,
928
- :tokens)
984
+ :tokens,
985
+ :signing_attributes_origin)
986
+ include Aws::Structure
987
+ end
988
+
989
+ # An object that contains information about the tokens used for setting
990
+ # up Bring Your Own DKIM (BYODKIM).
991
+ #
992
+ # @note When making an API call, you may pass DkimSigningAttributes
993
+ # data as a hash:
994
+ #
995
+ # {
996
+ # domain_signing_selector: "Selector", # required
997
+ # domain_signing_private_key: "PrivateKey", # required
998
+ # }
999
+ #
1000
+ # @!attribute [rw] domain_signing_selector
1001
+ # A string that's used to identify a public key in the DNS
1002
+ # configuration for a domain.
1003
+ # @return [String]
1004
+ #
1005
+ # @!attribute [rw] domain_signing_private_key
1006
+ # A private key that's used to generate a DKIM signature.
1007
+ #
1008
+ # The private key must use 1024-bit RSA encryption, and must be
1009
+ # encoded using base64 encoding.
1010
+ # @return [String]
1011
+ #
1012
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DkimSigningAttributes AWS API Documentation
1013
+ #
1014
+ class DkimSigningAttributes < Struct.new(
1015
+ :domain_signing_selector,
1016
+ :domain_signing_private_key)
929
1017
  include Aws::Structure
930
1018
  end
931
1019
 
@@ -1422,8 +1510,8 @@ module Aws::SESV2
1422
1510
  # @return [Boolean]
1423
1511
  #
1424
1512
  # @!attribute [rw] suppression_attributes
1425
- # An object that contains information about your account's
1426
- # suppression preferences.
1513
+ # An object that contains information about the email address
1514
+ # suppression preferences for your account in the current AWS Region.
1427
1515
  # @return [Types::SuppressionAttributes]
1428
1516
  #
1429
1517
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetAccountResponse AWS API Documentation
@@ -1564,8 +1652,8 @@ module Aws::SESV2
1564
1652
  # @return [Array<Types::Tag>]
1565
1653
  #
1566
1654
  # @!attribute [rw] suppression_options
1567
- # An object that contains information about your account's
1568
- # suppression preferences.
1655
+ # An object that contains information about the suppression list
1656
+ # preferences for your account.
1569
1657
  # @return [Types::SuppressionOptions]
1570
1658
  #
1571
1659
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetConfigurationSetResponse AWS API Documentation
@@ -1958,9 +2046,7 @@ module Aws::SESV2
1958
2046
  #
1959
2047
  # @!attribute [rw] dkim_attributes
1960
2048
  # An object that contains information about the DKIM attributes for
1961
- # the identity. This object includes the tokens that you use to create
1962
- # the CNAME records that are required to complete the DKIM
1963
- # verification process.
2049
+ # the identity.
1964
2050
  # @return [Types::DkimAttributes]
1965
2051
  #
1966
2052
  # @!attribute [rw] mail_from_attributes
@@ -1985,7 +2071,8 @@ module Aws::SESV2
1985
2071
  include Aws::Structure
1986
2072
  end
1987
2073
 
1988
- # A request to get a suppressed email destination.
2074
+ # A request to retrieve information about an email address that's on
2075
+ # the suppression list for your account.
1989
2076
  #
1990
2077
  # @note When making an API call, you may pass GetSuppressedDestinationRequest
1991
2078
  # data as a hash:
@@ -1995,7 +2082,7 @@ module Aws::SESV2
1995
2082
  # }
1996
2083
  #
1997
2084
  # @!attribute [rw] email_address
1998
- # Email destination to fetch from the suppression list.
2085
+ # The email address that's on the account suppression list.
1999
2086
  # @return [String]
2000
2087
  #
2001
2088
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetSuppressedDestinationRequest AWS API Documentation
@@ -2005,11 +2092,10 @@ module Aws::SESV2
2005
2092
  include Aws::Structure
2006
2093
  end
2007
2094
 
2008
- # Information about the suppressed email destination.
2095
+ # Information about the suppressed email address.
2009
2096
  #
2010
2097
  # @!attribute [rw] suppressed_destination
2011
- # An object containing information about the suppressed email
2012
- # destination.
2098
+ # An object containing information about the suppressed email address.
2013
2099
  # @return [Types::SuppressedDestination]
2014
2100
  #
2015
2101
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetSuppressedDestinationResponse AWS API Documentation
@@ -2445,7 +2531,8 @@ module Aws::SESV2
2445
2531
  include Aws::Structure
2446
2532
  end
2447
2533
 
2448
- # A request to obtain a list of suppressed email destinations.
2534
+ # A request to obtain a list of email destinations that are on the
2535
+ # suppression list for your account.
2449
2536
  #
2450
2537
  # @note When making an API call, you may pass ListSuppressedDestinationsRequest
2451
2538
  # data as a hash:
@@ -2459,21 +2546,26 @@ module Aws::SESV2
2459
2546
  # }
2460
2547
  #
2461
2548
  # @!attribute [rw] reasons
2462
- # Filters email destinations suppressed by the given reasons.
2549
+ # The factors that caused the email address to be added to .
2463
2550
  # @return [Array<String>]
2464
2551
  #
2465
2552
  # @!attribute [rw] start_date
2466
- # Filters email destinations suppressed before the given time.
2553
+ # Used to filter the list of suppressed email destinations so that it
2554
+ # only includes addresses that were added to the list after a specific
2555
+ # date. The date that you specify should be in Unix time format.
2467
2556
  # @return [Time]
2468
2557
  #
2469
2558
  # @!attribute [rw] end_date
2470
- # Filters email destinations suppressed after the given time.
2559
+ # Used to filter the list of suppressed email destinations so that it
2560
+ # only includes addresses that were added to the list before a
2561
+ # specific date. The date that you specify should be in Unix time
2562
+ # format.
2471
2563
  # @return [Time]
2472
2564
  #
2473
2565
  # @!attribute [rw] next_token
2474
2566
  # A token returned from a previous call to
2475
2567
  # `ListSuppressedDestinations` to indicate the position in the list of
2476
- # suppressed email destinations.
2568
+ # suppressed email addresses.
2477
2569
  # @return [String]
2478
2570
  #
2479
2571
  # @!attribute [rw] page_size
@@ -2495,7 +2587,7 @@ module Aws::SESV2
2495
2587
  include Aws::Structure
2496
2588
  end
2497
2589
 
2498
- # A list of suppressed email destinations.
2590
+ # A list of suppressed email addresses.
2499
2591
  #
2500
2592
  # @!attribute [rw] suppressed_destination_summaries
2501
2593
  # A list of summaries, each containing a summary for a suppressed
@@ -2503,10 +2595,10 @@ module Aws::SESV2
2503
2595
  # @return [Array<Types::SuppressedDestinationSummary>]
2504
2596
  #
2505
2597
  # @!attribute [rw] next_token
2506
- # A token that indicates that there are additional suppressed
2507
- # destinations to list. To view additional suppressed destinations,
2508
- # issue another request to `ListSuppressedDestinations`, and pass this
2509
- # token in the `NextToken` parameter.
2598
+ # A token that indicates that there are additional email addresses on
2599
+ # the suppression list for your account. To view additional suppressed
2600
+ # addresses, issue another request to `ListSuppressedDestinations`,
2601
+ # and pass this token in the `NextToken` parameter.
2510
2602
  # @return [String]
2511
2603
  #
2512
2604
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListSuppressedDestinationsResponse AWS API Documentation
@@ -2851,14 +2943,17 @@ module Aws::SESV2
2851
2943
  # }
2852
2944
  #
2853
2945
  # @!attribute [rw] suppressed_reasons
2854
- # A list of reasons to suppress email addresses. The only valid
2855
- # reasons are:
2946
+ # A list that contains the reasons that email addresses will be
2947
+ # automatically added to the suppression list for your account. This
2948
+ # list can contain any or all of the following:
2856
2949
  #
2857
- # * `COMPLAINT` – Amazon SES will suppress an email address that
2858
- # receives a complaint.
2950
+ # * `COMPLAINT` – Amazon SES adds an email address to the suppression
2951
+ # list for your account when a message sent to that address results
2952
+ # in a complaint.
2859
2953
  #
2860
- # * `BOUNCE` – Amazon SES will suppress an email address that hard
2861
- # bounces.
2954
+ # * `BOUNCE` – Amazon SES adds an email address to the suppression
2955
+ # list for your account when a message sent to that address results
2956
+ # in a hard bounce.
2862
2957
  # @return [Array<String>]
2863
2958
  #
2864
2959
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountSuppressionAttributesRequest AWS API Documentation
@@ -2993,7 +3088,7 @@ module Aws::SESV2
2993
3088
  #
2994
3089
  class PutConfigurationSetSendingOptionsResponse < Aws::EmptyStructure; end
2995
3090
 
2996
- # A request to change your account's suppression preferences for an
3091
+ # A request to change the account suppression list preferences for a
2997
3092
  # specific configuration set.
2998
3093
  #
2999
3094
  # @note When making an API call, you may pass PutConfigurationSetSuppressionOptionsRequest
@@ -3005,19 +3100,22 @@ module Aws::SESV2
3005
3100
  # }
3006
3101
  #
3007
3102
  # @!attribute [rw] configuration_set_name
3008
- # The name of the configuration set that you want to enable or disable
3009
- # email sending for.
3103
+ # The name of the configuration set that you want to change the
3104
+ # suppression list preferences for.
3010
3105
  # @return [String]
3011
3106
  #
3012
3107
  # @!attribute [rw] suppressed_reasons
3013
- # A list of reasons to suppress email addresses. The only valid
3014
- # reasons are:
3108
+ # A list that contains the reasons that email addresses are
3109
+ # automatically added to the suppression list for your account. This
3110
+ # list can contain any or all of the following:
3015
3111
  #
3016
- # * `COMPLAINT` – Amazon SES will suppress an email address that
3017
- # receives a complaint.
3112
+ # * `COMPLAINT` – Amazon SES adds an email address to the suppression
3113
+ # list for your account when a message sent to that address results
3114
+ # in a complaint.
3018
3115
  #
3019
- # * `BOUNCE` – Amazon SES will suppress an email address that hard
3020
- # bounces.
3116
+ # * `BOUNCE` – Amazon SES adds an email address to the suppression
3117
+ # list for your account when a message sent to that address results
3118
+ # in a hard bounce.
3021
3119
  # @return [Array<String>]
3022
3120
  #
3023
3121
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetSuppressionOptionsRequest AWS API Documentation
@@ -3239,6 +3337,125 @@ module Aws::SESV2
3239
3337
  #
3240
3338
  class PutEmailIdentityDkimAttributesResponse < Aws::EmptyStructure; end
3241
3339
 
3340
+ # A request to change the DKIM attributes for an email identity.
3341
+ #
3342
+ # @note When making an API call, you may pass PutEmailIdentityDkimSigningAttributesRequest
3343
+ # data as a hash:
3344
+ #
3345
+ # {
3346
+ # email_identity: "Identity", # required
3347
+ # signing_attributes_origin: "AWS_SES", # required, accepts AWS_SES, EXTERNAL
3348
+ # signing_attributes: {
3349
+ # domain_signing_selector: "Selector", # required
3350
+ # domain_signing_private_key: "PrivateKey", # required
3351
+ # },
3352
+ # }
3353
+ #
3354
+ # @!attribute [rw] email_identity
3355
+ # The email identity that you want to configure DKIM for.
3356
+ # @return [String]
3357
+ #
3358
+ # @!attribute [rw] signing_attributes_origin
3359
+ # The method that you want to use to configure DKIM for the identity.
3360
+ # There are two possible values:
3361
+ #
3362
+ # * `AWS_SES` – Configure DKIM for the identity by using [Easy
3363
+ # DKIM][1].
3364
+ #
3365
+ # * `EXTERNAL` – Configure DKIM for the identity by using Bring Your
3366
+ # Own DKIM (BYODKIM).
3367
+ #
3368
+ #
3369
+ #
3370
+ # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
3371
+ # @return [String]
3372
+ #
3373
+ # @!attribute [rw] signing_attributes
3374
+ # An object that contains information about the private key and
3375
+ # selector that you want to use to configure DKIM for the identity.
3376
+ # This object is only required if you want to configure Bring Your Own
3377
+ # DKIM (BYODKIM) for the identity.
3378
+ # @return [Types::DkimSigningAttributes]
3379
+ #
3380
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutEmailIdentityDkimSigningAttributesRequest AWS API Documentation
3381
+ #
3382
+ class PutEmailIdentityDkimSigningAttributesRequest < Struct.new(
3383
+ :email_identity,
3384
+ :signing_attributes_origin,
3385
+ :signing_attributes)
3386
+ include Aws::Structure
3387
+ end
3388
+
3389
+ # If the action is successful, the service sends back an HTTP 200
3390
+ # response.
3391
+ #
3392
+ # The following data is returned in JSON format by the service.
3393
+ #
3394
+ # @!attribute [rw] dkim_status
3395
+ # The DKIM authentication status of the identity. Amazon SES
3396
+ # determines the authentication status by searching for specific
3397
+ # records in the DNS configuration for your domain. If you used [Easy
3398
+ # DKIM][1] to set up DKIM authentication, Amazon SES tries to find
3399
+ # three unique CNAME records in the DNS configuration for your domain.
3400
+ #
3401
+ # If you provided a public key to perform DKIM authentication, Amazon
3402
+ # SES tries to find a TXT record that uses the selector that you
3403
+ # specified. The value of the TXT record must be a public key that's
3404
+ # paired with the private key that you specified in the process of
3405
+ # creating the identity.
3406
+ #
3407
+ # The status can be one of the following:
3408
+ #
3409
+ # * `PENDING` – The verification process was initiated, but Amazon SES
3410
+ # hasn't yet detected the DKIM records in the DNS configuration for
3411
+ # the domain.
3412
+ #
3413
+ # * `SUCCESS` – The verification process completed successfully.
3414
+ #
3415
+ # * `FAILED` – The verification process failed. This typically occurs
3416
+ # when Amazon SES fails to find the DKIM records in the DNS
3417
+ # configuration of the domain.
3418
+ #
3419
+ # * `TEMPORARY_FAILURE` – A temporary issue is preventing Amazon SES
3420
+ # from determining the DKIM authentication status of the domain.
3421
+ #
3422
+ # * `NOT_STARTED` – The DKIM verification process hasn't been
3423
+ # initiated for the domain.
3424
+ #
3425
+ #
3426
+ #
3427
+ # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
3428
+ # @return [String]
3429
+ #
3430
+ # @!attribute [rw] dkim_tokens
3431
+ # If you used [Easy DKIM][1] to configure DKIM authentication for the
3432
+ # domain, then this object contains a set of unique strings that you
3433
+ # use to create a set of CNAME records that you add to the DNS
3434
+ # configuration for your domain. When Amazon SES detects these records
3435
+ # in the DNS configuration for your domain, the DKIM authentication
3436
+ # process is complete.
3437
+ #
3438
+ # If you configured DKIM authentication for the domain by providing
3439
+ # your own public-private key pair, then this object contains the
3440
+ # selector that's associated with your public key.
3441
+ #
3442
+ # Regardless of the DKIM authentication method you use, Amazon SES
3443
+ # searches for the appropriate records in the DNS configuration of the
3444
+ # domain for up to 72 hours.
3445
+ #
3446
+ #
3447
+ #
3448
+ # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
3449
+ # @return [Array<String>]
3450
+ #
3451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutEmailIdentityDkimSigningAttributesResponse AWS API Documentation
3452
+ #
3453
+ class PutEmailIdentityDkimSigningAttributesResponse < Struct.new(
3454
+ :dkim_status,
3455
+ :dkim_tokens)
3456
+ include Aws::Structure
3457
+ end
3458
+
3242
3459
  # A request to set the attributes that control how bounce and complaint
3243
3460
  # events are processed.
3244
3461
  #
@@ -3343,7 +3560,8 @@ module Aws::SESV2
3343
3560
  #
3344
3561
  class PutEmailIdentityMailFromAttributesResponse < Aws::EmptyStructure; end
3345
3562
 
3346
- # A request to suppress an email destination.
3563
+ # A request to add an email destination to the suppression list for your
3564
+ # account.
3347
3565
  #
3348
3566
  # @note When making an API call, you may pass PutSuppressedDestinationRequest
3349
3567
  # data as a hash:
@@ -3354,11 +3572,13 @@ module Aws::SESV2
3354
3572
  # }
3355
3573
  #
3356
3574
  # @!attribute [rw] email_address
3357
- # Email destination to be suppressed.
3575
+ # The email address that should be added to the suppression list for
3576
+ # your account.
3358
3577
  # @return [String]
3359
3578
  #
3360
3579
  # @!attribute [rw] reason
3361
- # Reason for which the email destination is suppressed.
3580
+ # The factors that should cause the email address to be added to the
3581
+ # suppression list for your account.
3362
3582
  # @return [String]
3363
3583
  #
3364
3584
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutSuppressedDestinationRequest AWS API Documentation
@@ -3376,7 +3596,7 @@ module Aws::SESV2
3376
3596
  #
3377
3597
  class PutSuppressedDestinationResponse < Aws::EmptyStructure; end
3378
3598
 
3379
- # The raw email message.
3599
+ # Represents the raw content of an email message.
3380
3600
  #
3381
3601
  # @note When making an API call, you may pass RawMessage
3382
3602
  # data as a hash:
@@ -3396,8 +3616,7 @@ module Aws::SESV2
3396
3616
  #
3397
3617
  # * Each part of a multipart MIME message must be formatted properly.
3398
3618
  #
3399
- # * Attachments must be in a file format that the Amazon SES API v2
3400
- # supports.
3619
+ # * Attachments must be in a file format that the Amazon SES supports.
3401
3620
  #
3402
3621
  # * The entire message must be Base64 encoded.
3403
3622
  #
@@ -3557,11 +3776,10 @@ module Aws::SESV2
3557
3776
  # A unique identifier for the message that is generated when the
3558
3777
  # message is accepted.
3559
3778
  #
3560
- # <note markdown="1"> It is possible for the Amazon SES API v2 to accept a message without
3561
- # sending it. This can happen when the message that you're trying to
3562
- # send has an attachment contains a virus, or when you send a
3563
- # templated email that contains invalid personalization content, for
3564
- # example.
3779
+ # <note markdown="1"> It's possible for Amazon SES to accept a message without sending
3780
+ # it. This can happen when the message that you're trying to send has
3781
+ # an attachment contains a virus, or when you send a templated email
3782
+ # that contains invalid personalization content, for example.
3565
3783
  #
3566
3784
  # </note>
3567
3785
  # @return [String]
@@ -3652,24 +3870,27 @@ module Aws::SESV2
3652
3870
  include Aws::Structure
3653
3871
  end
3654
3872
 
3655
- # An object containing information about the suppressed email
3656
- # destination.
3873
+ # An object that contains information about an email address that is on
3874
+ # the suppression list for your account.
3657
3875
  #
3658
3876
  # @!attribute [rw] email_address
3659
- # The suppressed email destination.
3877
+ # The email address that is on the suppression list for your account.
3660
3878
  # @return [String]
3661
3879
  #
3662
3880
  # @!attribute [rw] reason
3663
- # The reason for which the email destination is suppressed.
3881
+ # The reason that the address was added to the suppression list for
3882
+ # your account.
3664
3883
  # @return [String]
3665
3884
  #
3666
3885
  # @!attribute [rw] last_update_time
3667
- # The last time the suppressed destination was updated.
3886
+ # The date and time when the suppressed destination was last updated,
3887
+ # shown in Unix time format.
3668
3888
  # @return [Time]
3669
3889
  #
3670
3890
  # @!attribute [rw] attributes
3671
- # `Optional` value with information about the sources of the
3672
- # suppression.
3891
+ # An optional value that can contain additional information about the
3892
+ # reasons that the address was added to the suppression list for your
3893
+ # account.
3673
3894
  # @return [Types::SuppressedDestinationAttributes]
3674
3895
  #
3675
3896
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SuppressedDestination AWS API Documentation
@@ -3682,16 +3903,17 @@ module Aws::SESV2
3682
3903
  include Aws::Structure
3683
3904
  end
3684
3905
 
3685
- # An object containing additional attributes related to a suppressed
3686
- # destination.
3906
+ # An object that contains additional attributes that are related an
3907
+ # email address that is on the suppression list for your account.
3687
3908
  #
3688
3909
  # @!attribute [rw] message_id
3689
- # A unique identifier of the message that caused the suppression of
3690
- # the email destination.
3910
+ # The unique identifier of the email message that caused the email
3911
+ # address to be added to the suppression list for your account.
3691
3912
  # @return [String]
3692
3913
  #
3693
3914
  # @!attribute [rw] feedback_id
3694
- # A unique identifier of the suppression cause.
3915
+ # A unique identifier that's generated when an email address is added
3916
+ # to the suppression list for your account.
3695
3917
  # @return [String]
3696
3918
  #
3697
3919
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SuppressedDestinationAttributes AWS API Documentation
@@ -3702,18 +3924,20 @@ module Aws::SESV2
3702
3924
  include Aws::Structure
3703
3925
  end
3704
3926
 
3705
- # A summary for the suppressed email destination.
3927
+ # A summary that describes the suppressed email address.
3706
3928
  #
3707
3929
  # @!attribute [rw] email_address
3708
- # The suppressed email destination.
3930
+ # The email address that's on the suppression list for your account.
3709
3931
  # @return [String]
3710
3932
  #
3711
3933
  # @!attribute [rw] reason
3712
- # The reason for which the email destination is suppressed.
3934
+ # The reason that the address was added to the suppression list for
3935
+ # your account.
3713
3936
  # @return [String]
3714
3937
  #
3715
3938
  # @!attribute [rw] last_update_time
3716
- # The last time the suppressed destination was updated.
3939
+ # The date and time when the suppressed destination was last updated,
3940
+ # shown in Unix time format.
3717
3941
  # @return [Time]
3718
3942
  #
3719
3943
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SuppressedDestinationSummary AWS API Documentation
@@ -3725,18 +3949,21 @@ module Aws::SESV2
3725
3949
  include Aws::Structure
3726
3950
  end
3727
3951
 
3728
- # An object that contains information about your account's suppression
3729
- # preferences.
3952
+ # An object that contains information about the email address
3953
+ # suppression preferences for your account in the current AWS Region.
3730
3954
  #
3731
3955
  # @!attribute [rw] suppressed_reasons
3732
- # A list of reasons to suppress email addresses. The only valid
3733
- # reasons are:
3956
+ # A list that contains the reasons that email addresses will be
3957
+ # automatically added to the suppression list for your account. This
3958
+ # list can contain any or all of the following:
3734
3959
  #
3735
- # * `COMPLAINT` – Amazon SES will suppress an email address that
3736
- # receives a complaint.
3960
+ # * `COMPLAINT` – Amazon SES adds an email address to the suppression
3961
+ # list for your account when a message sent to that address results
3962
+ # in a complaint.
3737
3963
  #
3738
- # * `BOUNCE` – Amazon SES will suppress an email address that hard
3739
- # bounces.
3964
+ # * `BOUNCE` – Amazon SES adds an email address to the suppression
3965
+ # list for your account when a message sent to that address results
3966
+ # in a hard bounce.
3740
3967
  # @return [Array<String>]
3741
3968
  #
3742
3969
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SuppressionAttributes AWS API Documentation
@@ -3746,8 +3973,8 @@ module Aws::SESV2
3746
3973
  include Aws::Structure
3747
3974
  end
3748
3975
 
3749
- # An object that contains information about your account's suppression
3750
- # preferences.
3976
+ # An object that contains information about the suppression list
3977
+ # preferences for your account.
3751
3978
  #
3752
3979
  # @note When making an API call, you may pass SuppressionOptions
3753
3980
  # data as a hash:
@@ -3757,14 +3984,17 @@ module Aws::SESV2
3757
3984
  # }
3758
3985
  #
3759
3986
  # @!attribute [rw] suppressed_reasons
3760
- # A list of reasons to suppress email addresses. The only valid
3761
- # reasons are:
3987
+ # A list that contains the reasons that email addresses are
3988
+ # automatically added to the suppression list for your account. This
3989
+ # list can contain any or all of the following:
3762
3990
  #
3763
- # * `COMPLAINT` – Amazon SES will suppress an email address that
3764
- # receives a complaint.
3991
+ # * `COMPLAINT` – Amazon SES adds an email address to the suppression
3992
+ # list for your account when a message sent to that address results
3993
+ # in a complaint.
3765
3994
  #
3766
- # * `BOUNCE` – Amazon SES will suppress an email address that hard
3767
- # bounces.
3995
+ # * `BOUNCE` – Amazon SES adds an email address to the suppression
3996
+ # list for your account when a message sent to that address results
3997
+ # in a hard bounce.
3768
3998
  # @return [Array<String>]
3769
3999
  #
3770
4000
  # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SuppressionOptions AWS API Documentation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-sesv2
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.0
4
+ version: 1.2.0
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: 2019-11-25 00:00:00.000000000 Z
11
+ date: 2019-12-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core