aws-sdk-sesv2 1.1.0 → 1.6.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-sesv2.rb +7 -4
- data/lib/aws-sdk-sesv2/client.rb +243 -61
- data/lib/aws-sdk-sesv2/client_api.rb +55 -0
- data/lib/aws-sdk-sesv2/errors.rb +143 -0
- data/lib/aws-sdk-sesv2/resource.rb +1 -0
- data/lib/aws-sdk-sesv2/types.rb +416 -118
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 8e09b8b8e2ac12dbf21a4404416e1d8f492dec9bd1b73681ad32a8ce1e2d134f
|
4
|
+
data.tar.gz: 07c8f3d8095edadb3028543d0859654437371a579221234c84051ffd8242c3f9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3e44777bd08dc58ed49fc2282206325dc95c841b23850423ef3a02ca7c93dc3585b0fddec0fec504177307da1159ac978b44e01bab5e827b54cabd5e60935c9a
|
7
|
+
data.tar.gz: 9227a185fcff628eb66279e5784c00e90b4aa5a0ed816b7030e9d37f274edd635f8e32bf9a2ab331af6899c0259d8265c006ea257e1df2ef23b15430769f12fd
|
data/lib/aws-sdk-sesv2.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-sesv2/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# sesv2 = Aws::SESV2::Client.new
|
28
|
+
# resp = sesv2.create_configuration_set(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from Amazon Simple Email Service
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from Amazon Simple Email Service are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::SESV2::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all Amazon Simple Email Service API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-sesv2/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::SESV2
|
44
47
|
|
45
|
-
GEM_VERSION = '1.1
|
48
|
+
GEM_VERSION = '1.6.1'
|
46
49
|
|
47
50
|
end
|
data/lib/aws-sdk-sesv2/client.rb
CHANGED
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
28
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
29
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
30
|
|
30
31
|
Aws::Plugins::GlobalConfiguration.add_identifier(:sesv2)
|
31
32
|
|
32
33
|
module Aws::SESV2
|
34
|
+
# An API client for SESV2. To construct a client, you need to configure a `:region` and `:credentials`.
|
35
|
+
#
|
36
|
+
# client = Aws::SESV2::Client.new(
|
37
|
+
# region: region_name,
|
38
|
+
# credentials: credentials,
|
39
|
+
# # ...
|
40
|
+
# )
|
41
|
+
#
|
42
|
+
# For details on configuring region and credentials see
|
43
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
44
|
+
#
|
45
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
46
|
class Client < Seahorse::Client::Base
|
34
47
|
|
35
48
|
include Aws::ClientStubs
|
@@ -57,6 +70,7 @@ module Aws::SESV2
|
|
57
70
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
58
71
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
59
72
|
add_plugin(Aws::Plugins::TransferEncoding)
|
73
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
60
74
|
add_plugin(Aws::Plugins::SignatureV4)
|
61
75
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
62
76
|
|
@@ -93,7 +107,7 @@ module Aws::SESV2
|
|
93
107
|
# @option options [required, String] :region
|
94
108
|
# The AWS region to connect to. The configured `:region` is
|
95
109
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
97
111
|
#
|
98
112
|
# * `Aws.config[:region]`
|
99
113
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +122,12 @@ module Aws::SESV2
|
|
108
122
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
123
|
# the background every 60 secs (default). Defaults to `false`.
|
110
124
|
#
|
125
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
126
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
127
|
+
# until there is sufficent client side capacity to retry the request.
|
128
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
129
|
+
# not retry instead of sleeping.
|
130
|
+
#
|
111
131
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
132
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
133
|
# this client.
|
@@ -132,6 +152,10 @@ module Aws::SESV2
|
|
132
152
|
# When `true`, an attempt is made to coerce request parameters into
|
133
153
|
# the required types.
|
134
154
|
#
|
155
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
156
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
157
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
158
|
+
#
|
135
159
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
160
|
# Set to true to disable SDK automatically adding host prefix
|
137
161
|
# to default service endpoint when available.
|
@@ -139,7 +163,7 @@ module Aws::SESV2
|
|
139
163
|
# @option options [String] :endpoint
|
140
164
|
# The client endpoint is normally constructed from the `:region`
|
141
165
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
166
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
143
167
|
#
|
144
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +178,7 @@ module Aws::SESV2
|
|
154
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
179
|
#
|
156
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
182
|
#
|
159
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
184
|
# The log formatter.
|
@@ -166,15 +190,29 @@ module Aws::SESV2
|
|
166
190
|
# The Logger instance to send log messages to. If this option
|
167
191
|
# is not set, logging will be disabled.
|
168
192
|
#
|
193
|
+
# @option options [Integer] :max_attempts (3)
|
194
|
+
# An integer representing the maximum number attempts that will be made for
|
195
|
+
# a single request, including the initial attempt. For example,
|
196
|
+
# setting this value to 5 will result in a request being retried up to
|
197
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
198
|
+
#
|
169
199
|
# @option options [String] :profile ("default")
|
170
200
|
# Used when loading credentials from the shared credentials file
|
171
201
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
202
|
#
|
203
|
+
# @option options [Proc] :retry_backoff
|
204
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
205
|
+
# This option is only used in the `legacy` retry mode.
|
206
|
+
#
|
173
207
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
208
|
+
# The base delay in seconds used by the default backoff function. This option
|
209
|
+
# is only used in the `legacy` retry mode.
|
175
210
|
#
|
176
211
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
212
|
+
# A delay randomiser function used by the default backoff function.
|
213
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
214
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
215
|
+
# in the `legacy` retry mode.
|
178
216
|
#
|
179
217
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
218
|
#
|
@@ -182,11 +220,30 @@ module Aws::SESV2
|
|
182
220
|
# The maximum number of times to retry failed requests. Only
|
183
221
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
222
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
223
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
224
|
+
# endpoint discovery, and errors from expired credentials.
|
225
|
+
# This option is only used in the `legacy` retry mode.
|
187
226
|
#
|
188
227
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
228
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
229
|
+
# used by the default backoff function. This option is only used in the
|
230
|
+
# `legacy` retry mode.
|
231
|
+
#
|
232
|
+
# @option options [String] :retry_mode ("legacy")
|
233
|
+
# Specifies which retry algorithm to use. Values are:
|
234
|
+
#
|
235
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
236
|
+
# no retry mode is provided.
|
237
|
+
#
|
238
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
239
|
+
# This includes support for retry quotas, which limit the number of
|
240
|
+
# unsuccessful retries a client can make.
|
241
|
+
#
|
242
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
243
|
+
# functionality of `standard` mode along with automatic client side
|
244
|
+
# throttling. This is a provisional mode that may change behavior
|
245
|
+
# in the future.
|
246
|
+
#
|
190
247
|
#
|
191
248
|
# @option options [String] :secret_access_key
|
192
249
|
#
|
@@ -209,16 +266,15 @@ module Aws::SESV2
|
|
209
266
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
267
|
#
|
211
268
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
269
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
270
|
# `Timeout::Error`.
|
214
271
|
#
|
215
272
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
273
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
274
|
+
# safely be set per-request on the session.
|
219
275
|
#
|
220
276
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
277
|
+
# seconds a connection is allowed to sit idle before it is
|
222
278
|
# considered stale. Stale connections are closed and removed
|
223
279
|
# from the pool before making a request.
|
224
280
|
#
|
@@ -227,7 +283,7 @@ module Aws::SESV2
|
|
227
283
|
# request body. This option has no effect unless the request has
|
228
284
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
285
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
286
|
+
# request on the session.
|
231
287
|
#
|
232
288
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
289
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -285,8 +341,8 @@ module Aws::SESV2
|
|
285
341
|
# want to associate with the configuration set.
|
286
342
|
#
|
287
343
|
# @option params [Types::SuppressionOptions] :suppression_options
|
288
|
-
# An object that contains information about
|
289
|
-
# preferences.
|
344
|
+
# An object that contains information about the suppression list
|
345
|
+
# preferences for your account.
|
290
346
|
#
|
291
347
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
292
348
|
#
|
@@ -432,10 +488,10 @@ module Aws::SESV2
|
|
432
488
|
# by various email providers around the world. When you perform a
|
433
489
|
# predictive inbox placement test, you provide a sample message that
|
434
490
|
# contains the content that you plan to send to your customers. Amazon
|
435
|
-
# SES
|
436
|
-
#
|
437
|
-
#
|
438
|
-
#
|
491
|
+
# SES then sends that message to special email addresses spread across
|
492
|
+
# several major email providers. After about 24 hours, the test is
|
493
|
+
# complete, and you can use the `GetDeliverabilityTestReport` operation
|
494
|
+
# to view the results of the test.
|
439
495
|
#
|
440
496
|
# @option params [String] :report_name
|
441
497
|
# A unique name that helps you to identify the predictive inbox
|
@@ -521,12 +577,26 @@ module Aws::SESV2
|
|
521
577
|
# address. Your email address is verified as soon as you follow the link
|
522
578
|
# in the verification email.
|
523
579
|
#
|
524
|
-
# When you verify a domain
|
525
|
-
#
|
526
|
-
# tokens
|
580
|
+
# When you verify a domain without specifying the
|
581
|
+
# `DkimSigningAttributes` object, this operation provides a set of DKIM
|
582
|
+
# tokens. You can convert these tokens into CNAME records, which you
|
583
|
+
# then add to the DNS configuration for your domain. Your domain is
|
527
584
|
# verified when Amazon SES detects these records in the DNS
|
528
|
-
# configuration for your domain.
|
529
|
-
#
|
585
|
+
# configuration for your domain. This verification method is known as
|
586
|
+
# [Easy DKIM][1].
|
587
|
+
#
|
588
|
+
# Alternatively, you can perform the verification process by providing
|
589
|
+
# your own public-private key pair. This verification method is known as
|
590
|
+
# Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the
|
591
|
+
# `CreateEmailIdentity` operation has to include the
|
592
|
+
# `DkimSigningAttributes` object. When you specify this object, you
|
593
|
+
# provide a selector (a component of the DNS record name that identifies
|
594
|
+
# the public key that you want to use for DKIM authentication) and a
|
595
|
+
# private key.
|
596
|
+
#
|
597
|
+
#
|
598
|
+
#
|
599
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
|
530
600
|
#
|
531
601
|
# @option params [required, String] :email_identity
|
532
602
|
# The email address or domain that you want to verify.
|
@@ -535,6 +605,18 @@ module Aws::SESV2
|
|
535
605
|
# An array of objects that define the tags (keys and values) that you
|
536
606
|
# want to associate with the email identity.
|
537
607
|
#
|
608
|
+
# @option params [Types::DkimSigningAttributes] :dkim_signing_attributes
|
609
|
+
# If your request includes this object, Amazon SES configures the
|
610
|
+
# identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication
|
611
|
+
# purposes, as opposed to the default method, [Easy DKIM][1].
|
612
|
+
#
|
613
|
+
# You can only specify this object if the email identity is a domain, as
|
614
|
+
# opposed to an address.
|
615
|
+
#
|
616
|
+
#
|
617
|
+
#
|
618
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
|
619
|
+
#
|
538
620
|
# @return [Types::CreateEmailIdentityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
539
621
|
#
|
540
622
|
# * {Types::CreateEmailIdentityResponse#identity_type #identity_type} => String
|
@@ -551,6 +633,10 @@ module Aws::SESV2
|
|
551
633
|
# value: "TagValue", # required
|
552
634
|
# },
|
553
635
|
# ],
|
636
|
+
# dkim_signing_attributes: {
|
637
|
+
# domain_signing_selector: "Selector", # required
|
638
|
+
# domain_signing_private_key: "PrivateKey", # required
|
639
|
+
# },
|
554
640
|
# })
|
555
641
|
#
|
556
642
|
# @example Response structure
|
@@ -561,6 +647,7 @@ module Aws::SESV2
|
|
561
647
|
# resp.dkim_attributes.status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED"
|
562
648
|
# resp.dkim_attributes.tokens #=> Array
|
563
649
|
# resp.dkim_attributes.tokens[0] #=> String
|
650
|
+
# resp.dkim_attributes.signing_attributes_origin #=> String, one of "AWS_SES", "EXTERNAL"
|
564
651
|
#
|
565
652
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailIdentity AWS API Documentation
|
566
653
|
#
|
@@ -679,11 +766,11 @@ module Aws::SESV2
|
|
679
766
|
req.send_request(options)
|
680
767
|
end
|
681
768
|
|
682
|
-
#
|
683
|
-
# list.
|
769
|
+
# Removes an email address from the suppression list for your account.
|
684
770
|
#
|
685
771
|
# @option params [required, String] :email_address
|
686
|
-
# The suppressed email destination to
|
772
|
+
# The suppressed email destination to remove from the account
|
773
|
+
# suppression list.
|
687
774
|
#
|
688
775
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
689
776
|
#
|
@@ -929,6 +1016,8 @@ module Aws::SESV2
|
|
929
1016
|
# * {Types::GetDedicatedIpsResponse#dedicated_ips #dedicated_ips} => Array<Types::DedicatedIp>
|
930
1017
|
# * {Types::GetDedicatedIpsResponse#next_token #next_token} => String
|
931
1018
|
#
|
1019
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1020
|
+
#
|
932
1021
|
# @example Request syntax with placeholder values
|
933
1022
|
#
|
934
1023
|
# resp = client.get_dedicated_ips({
|
@@ -965,11 +1054,11 @@ module Aws::SESV2
|
|
965
1054
|
# subscription charge, in addition to any other fees that you accrue by
|
966
1055
|
# using Amazon SES and other AWS services. For more information about
|
967
1056
|
# the features and cost of a Deliverability dashboard subscription, see
|
968
|
-
# [Amazon
|
1057
|
+
# [Amazon SES Pricing][1].
|
969
1058
|
#
|
970
1059
|
#
|
971
1060
|
#
|
972
|
-
# [1]: http://aws.amazon.com/
|
1061
|
+
# [1]: http://aws.amazon.com/ses/pricing/
|
973
1062
|
#
|
974
1063
|
# @return [Types::GetDeliverabilityDashboardOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
975
1064
|
#
|
@@ -1199,6 +1288,7 @@ module Aws::SESV2
|
|
1199
1288
|
# resp.dkim_attributes.status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED"
|
1200
1289
|
# resp.dkim_attributes.tokens #=> Array
|
1201
1290
|
# resp.dkim_attributes.tokens[0] #=> String
|
1291
|
+
# resp.dkim_attributes.signing_attributes_origin #=> String, one of "AWS_SES", "EXTERNAL"
|
1202
1292
|
# resp.mail_from_attributes.mail_from_domain #=> String
|
1203
1293
|
# resp.mail_from_attributes.mail_from_domain_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE"
|
1204
1294
|
# resp.mail_from_attributes.behavior_on_mx_failure #=> String, one of "USE_DEFAULT_VALUE", "REJECT_MESSAGE"
|
@@ -1215,11 +1305,11 @@ module Aws::SESV2
|
|
1215
1305
|
req.send_request(options)
|
1216
1306
|
end
|
1217
1307
|
|
1218
|
-
#
|
1219
|
-
# suppression list.
|
1308
|
+
# Retrieves information about a specific email address that's on the
|
1309
|
+
# suppression list for your account.
|
1220
1310
|
#
|
1221
1311
|
# @option params [required, String] :email_address
|
1222
|
-
#
|
1312
|
+
# The email address that's on the account suppression list.
|
1223
1313
|
#
|
1224
1314
|
# @return [Types::GetSuppressedDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1225
1315
|
#
|
@@ -1272,6 +1362,8 @@ module Aws::SESV2
|
|
1272
1362
|
# * {Types::ListConfigurationSetsResponse#configuration_sets #configuration_sets} => Array<String>
|
1273
1363
|
# * {Types::ListConfigurationSetsResponse#next_token #next_token} => String
|
1274
1364
|
#
|
1365
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1366
|
+
#
|
1275
1367
|
# @example Request syntax with placeholder values
|
1276
1368
|
#
|
1277
1369
|
# resp = client.list_configuration_sets({
|
@@ -1312,6 +1404,8 @@ module Aws::SESV2
|
|
1312
1404
|
# * {Types::ListDedicatedIpPoolsResponse#dedicated_ip_pools #dedicated_ip_pools} => Array<String>
|
1313
1405
|
# * {Types::ListDedicatedIpPoolsResponse#next_token #next_token} => String
|
1314
1406
|
#
|
1407
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1408
|
+
#
|
1315
1409
|
# @example Request syntax with placeholder values
|
1316
1410
|
#
|
1317
1411
|
# resp = client.list_dedicated_ip_pools({
|
@@ -1359,6 +1453,8 @@ module Aws::SESV2
|
|
1359
1453
|
# * {Types::ListDeliverabilityTestReportsResponse#deliverability_test_reports #deliverability_test_reports} => Array<Types::DeliverabilityTestReport>
|
1360
1454
|
# * {Types::ListDeliverabilityTestReportsResponse#next_token #next_token} => String
|
1361
1455
|
#
|
1456
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1457
|
+
#
|
1362
1458
|
# @example Request syntax with placeholder values
|
1363
1459
|
#
|
1364
1460
|
# resp = client.list_deliverability_test_reports({
|
@@ -1420,6 +1516,8 @@ module Aws::SESV2
|
|
1420
1516
|
# * {Types::ListDomainDeliverabilityCampaignsResponse#domain_deliverability_campaigns #domain_deliverability_campaigns} => Array<Types::DomainDeliverabilityCampaign>
|
1421
1517
|
# * {Types::ListDomainDeliverabilityCampaignsResponse#next_token #next_token} => String
|
1422
1518
|
#
|
1519
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1520
|
+
#
|
1423
1521
|
# @example Request syntax with placeholder values
|
1424
1522
|
#
|
1425
1523
|
# resp = client.list_domain_deliverability_campaigns({
|
@@ -1484,6 +1582,8 @@ module Aws::SESV2
|
|
1484
1582
|
# * {Types::ListEmailIdentitiesResponse#email_identities #email_identities} => Array<Types::IdentityInfo>
|
1485
1583
|
# * {Types::ListEmailIdentitiesResponse#next_token #next_token} => String
|
1486
1584
|
#
|
1585
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1586
|
+
#
|
1487
1587
|
# @example Request syntax with placeholder values
|
1488
1588
|
#
|
1489
1589
|
# resp = client.list_email_identities({
|
@@ -1508,21 +1608,25 @@ module Aws::SESV2
|
|
1508
1608
|
req.send_request(options)
|
1509
1609
|
end
|
1510
1610
|
|
1511
|
-
#
|
1512
|
-
#
|
1611
|
+
# Retrieves a list of email addresses that are on the suppression list
|
1612
|
+
# for your account.
|
1513
1613
|
#
|
1514
1614
|
# @option params [Array<String>] :reasons
|
1515
|
-
#
|
1615
|
+
# The factors that caused the email address to be added to .
|
1516
1616
|
#
|
1517
1617
|
# @option params [Time,DateTime,Date,Integer,String] :start_date
|
1518
|
-
#
|
1618
|
+
# Used to filter the list of suppressed email destinations so that it
|
1619
|
+
# only includes addresses that were added to the list after a specific
|
1620
|
+
# date. The date that you specify should be in Unix time format.
|
1519
1621
|
#
|
1520
1622
|
# @option params [Time,DateTime,Date,Integer,String] :end_date
|
1521
|
-
#
|
1623
|
+
# Used to filter the list of suppressed email destinations so that it
|
1624
|
+
# only includes addresses that were added to the list before a specific
|
1625
|
+
# date. The date that you specify should be in Unix time format.
|
1522
1626
|
#
|
1523
1627
|
# @option params [String] :next_token
|
1524
1628
|
# A token returned from a previous call to `ListSuppressedDestinations`
|
1525
|
-
# to indicate the position in the list of suppressed email
|
1629
|
+
# to indicate the position in the list of suppressed email addresses.
|
1526
1630
|
#
|
1527
1631
|
# @option params [Integer] :page_size
|
1528
1632
|
# The number of results to show in a single call to
|
@@ -1535,6 +1639,8 @@ module Aws::SESV2
|
|
1535
1639
|
# * {Types::ListSuppressedDestinationsResponse#suppressed_destination_summaries #suppressed_destination_summaries} => Array<Types::SuppressedDestinationSummary>
|
1536
1640
|
# * {Types::ListSuppressedDestinationsResponse#next_token #next_token} => String
|
1537
1641
|
#
|
1642
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1643
|
+
#
|
1538
1644
|
# @example Request syntax with placeholder values
|
1539
1645
|
#
|
1540
1646
|
# resp = client.list_suppressed_destinations({
|
@@ -1653,17 +1759,20 @@ module Aws::SESV2
|
|
1653
1759
|
req.send_request(options)
|
1654
1760
|
end
|
1655
1761
|
|
1656
|
-
# Change
|
1762
|
+
# Change the settings for the account-level suppression list.
|
1657
1763
|
#
|
1658
1764
|
# @option params [Array<String>] :suppressed_reasons
|
1659
|
-
# A list
|
1660
|
-
#
|
1765
|
+
# A list that contains the reasons that email addresses will be
|
1766
|
+
# automatically added to the suppression list for your account. This
|
1767
|
+
# list can contain any or all of the following:
|
1661
1768
|
#
|
1662
|
-
# * `COMPLAINT` – Amazon SES
|
1663
|
-
#
|
1769
|
+
# * `COMPLAINT` – Amazon SES adds an email address to the suppression
|
1770
|
+
# list for your account when a message sent to that address results in
|
1771
|
+
# a complaint.
|
1664
1772
|
#
|
1665
|
-
# * `BOUNCE` – Amazon SES
|
1666
|
-
#
|
1773
|
+
# * `BOUNCE` – Amazon SES adds an email address to the suppression list
|
1774
|
+
# for your account when a message sent to that address results in a
|
1775
|
+
# hard bounce.
|
1667
1776
|
#
|
1668
1777
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1669
1778
|
#
|
@@ -1779,22 +1888,25 @@ module Aws::SESV2
|
|
1779
1888
|
req.send_request(options)
|
1780
1889
|
end
|
1781
1890
|
|
1782
|
-
# Specify
|
1891
|
+
# Specify the account suppression list preferences for a configuration
|
1783
1892
|
# set.
|
1784
1893
|
#
|
1785
1894
|
# @option params [required, String] :configuration_set_name
|
1786
|
-
# The name of the configuration set that you want to
|
1787
|
-
#
|
1895
|
+
# The name of the configuration set that you want to change the
|
1896
|
+
# suppression list preferences for.
|
1788
1897
|
#
|
1789
1898
|
# @option params [Array<String>] :suppressed_reasons
|
1790
|
-
# A list
|
1791
|
-
#
|
1899
|
+
# A list that contains the reasons that email addresses are
|
1900
|
+
# automatically added to the suppression list for your account. This
|
1901
|
+
# list can contain any or all of the following:
|
1792
1902
|
#
|
1793
|
-
# * `COMPLAINT` – Amazon SES
|
1794
|
-
#
|
1903
|
+
# * `COMPLAINT` – Amazon SES adds an email address to the suppression
|
1904
|
+
# list for your account when a message sent to that address results in
|
1905
|
+
# a complaint.
|
1795
1906
|
#
|
1796
|
-
# * `BOUNCE` – Amazon SES
|
1797
|
-
#
|
1907
|
+
# * `BOUNCE` – Amazon SES adds an email address to the suppression list
|
1908
|
+
# for your account when a message sent to that address results in a
|
1909
|
+
# hard bounce.
|
1798
1910
|
#
|
1799
1911
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1800
1912
|
#
|
@@ -1915,11 +2027,11 @@ module Aws::SESV2
|
|
1915
2027
|
# subscription charge, in addition to any other fees that you accrue by
|
1916
2028
|
# using Amazon SES and other AWS services. For more information about
|
1917
2029
|
# the features and cost of a Deliverability dashboard subscription, see
|
1918
|
-
# [Amazon
|
2030
|
+
# [Amazon SES Pricing][1].
|
1919
2031
|
#
|
1920
2032
|
#
|
1921
2033
|
#
|
1922
|
-
# [1]: http://aws.amazon.com/
|
2034
|
+
# [1]: http://aws.amazon.com/ses/pricing/
|
1923
2035
|
#
|
1924
2036
|
# @option params [required, Boolean] :dashboard_enabled
|
1925
2037
|
# Specifies whether to enable the Deliverability dashboard. To enable
|
@@ -1986,6 +2098,74 @@ module Aws::SESV2
|
|
1986
2098
|
req.send_request(options)
|
1987
2099
|
end
|
1988
2100
|
|
2101
|
+
# Used to configure or change the DKIM authentication settings for an
|
2102
|
+
# email domain identity. You can use this operation to do any of the
|
2103
|
+
# following:
|
2104
|
+
#
|
2105
|
+
# * Update the signing attributes for an identity that uses Bring Your
|
2106
|
+
# Own DKIM (BYODKIM).
|
2107
|
+
#
|
2108
|
+
# * Change from using no DKIM authentication to using Easy DKIM.
|
2109
|
+
#
|
2110
|
+
# * Change from using no DKIM authentication to using BYODKIM.
|
2111
|
+
#
|
2112
|
+
# * Change from using Easy DKIM to using BYODKIM.
|
2113
|
+
#
|
2114
|
+
# * Change from using BYODKIM to using Easy DKIM.
|
2115
|
+
#
|
2116
|
+
# @option params [required, String] :email_identity
|
2117
|
+
# The email identity that you want to configure DKIM for.
|
2118
|
+
#
|
2119
|
+
# @option params [required, String] :signing_attributes_origin
|
2120
|
+
# The method that you want to use to configure DKIM for the identity.
|
2121
|
+
# There are two possible values:
|
2122
|
+
#
|
2123
|
+
# * `AWS_SES` – Configure DKIM for the identity by using [Easy DKIM][1].
|
2124
|
+
#
|
2125
|
+
# * `EXTERNAL` – Configure DKIM for the identity by using Bring Your Own
|
2126
|
+
# DKIM (BYODKIM).
|
2127
|
+
#
|
2128
|
+
#
|
2129
|
+
#
|
2130
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
|
2131
|
+
#
|
2132
|
+
# @option params [Types::DkimSigningAttributes] :signing_attributes
|
2133
|
+
# An object that contains information about the private key and selector
|
2134
|
+
# that you want to use to configure DKIM for the identity. This object
|
2135
|
+
# is only required if you want to configure Bring Your Own DKIM
|
2136
|
+
# (BYODKIM) for the identity.
|
2137
|
+
#
|
2138
|
+
# @return [Types::PutEmailIdentityDkimSigningAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2139
|
+
#
|
2140
|
+
# * {Types::PutEmailIdentityDkimSigningAttributesResponse#dkim_status #dkim_status} => String
|
2141
|
+
# * {Types::PutEmailIdentityDkimSigningAttributesResponse#dkim_tokens #dkim_tokens} => Array<String>
|
2142
|
+
#
|
2143
|
+
# @example Request syntax with placeholder values
|
2144
|
+
#
|
2145
|
+
# resp = client.put_email_identity_dkim_signing_attributes({
|
2146
|
+
# email_identity: "Identity", # required
|
2147
|
+
# signing_attributes_origin: "AWS_SES", # required, accepts AWS_SES, EXTERNAL
|
2148
|
+
# signing_attributes: {
|
2149
|
+
# domain_signing_selector: "Selector", # required
|
2150
|
+
# domain_signing_private_key: "PrivateKey", # required
|
2151
|
+
# },
|
2152
|
+
# })
|
2153
|
+
#
|
2154
|
+
# @example Response structure
|
2155
|
+
#
|
2156
|
+
# resp.dkim_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED"
|
2157
|
+
# resp.dkim_tokens #=> Array
|
2158
|
+
# resp.dkim_tokens[0] #=> String
|
2159
|
+
#
|
2160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutEmailIdentityDkimSigningAttributes AWS API Documentation
|
2161
|
+
#
|
2162
|
+
# @overload put_email_identity_dkim_signing_attributes(params = {})
|
2163
|
+
# @param [Hash] params ({})
|
2164
|
+
def put_email_identity_dkim_signing_attributes(params = {}, options = {})
|
2165
|
+
req = build_request(:put_email_identity_dkim_signing_attributes, params)
|
2166
|
+
req.send_request(options)
|
2167
|
+
end
|
2168
|
+
|
1989
2169
|
# Used to enable or disable feedback forwarding for an identity. This
|
1990
2170
|
# setting determines what happens when an identity is used to send an
|
1991
2171
|
# email that results in a bounce or complaint event.
|
@@ -2084,13 +2264,15 @@ module Aws::SESV2
|
|
2084
2264
|
req.send_request(options)
|
2085
2265
|
end
|
2086
2266
|
|
2087
|
-
#
|
2267
|
+
# Adds an email address to the suppression list for your account.
|
2088
2268
|
#
|
2089
2269
|
# @option params [required, String] :email_address
|
2090
|
-
#
|
2270
|
+
# The email address that should be added to the suppression list for
|
2271
|
+
# your account.
|
2091
2272
|
#
|
2092
2273
|
# @option params [required, String] :reason
|
2093
|
-
#
|
2274
|
+
# The factors that should cause the email address to be added to the
|
2275
|
+
# suppression list for your account.
|
2094
2276
|
#
|
2095
2277
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2096
2278
|
#
|
@@ -2115,7 +2297,7 @@ module Aws::SESV2
|
|
2115
2297
|
#
|
2116
2298
|
# * **Simple** – A standard email message. When you create this type of
|
2117
2299
|
# message, you specify the sender, the recipient, and the message
|
2118
|
-
# body, and
|
2300
|
+
# body, and Amazon SES assembles the message for you.
|
2119
2301
|
#
|
2120
2302
|
# * **Raw** – A raw, MIME-formatted email message. When you send this
|
2121
2303
|
# type of email, you have to specify all of the message headers, as
|
@@ -2366,7 +2548,7 @@ module Aws::SESV2
|
|
2366
2548
|
params: params,
|
2367
2549
|
config: config)
|
2368
2550
|
context[:gem_name] = 'aws-sdk-sesv2'
|
2369
|
-
context[:gem_version] = '1.1
|
2551
|
+
context[:gem_version] = '1.6.1'
|
2370
2552
|
Seahorse::Client::Request.new(handlers, context)
|
2371
2553
|
end
|
2372
2554
|
|