aws-sdk-sesv2 1.28.0 → 1.30.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 +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sesv2/client.rb +221 -3
- data/lib/aws-sdk-sesv2/client_api.rb +190 -0
- data/lib/aws-sdk-sesv2/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-sesv2/endpoint_provider.rb +111 -0
- data/lib/aws-sdk-sesv2/endpoints.rb +1219 -0
- data/lib/aws-sdk-sesv2/errors.rb +11 -0
- data/lib/aws-sdk-sesv2/plugins/endpoints.rb +240 -0
- data/lib/aws-sdk-sesv2/types.rb +627 -3
- data/lib/aws-sdk-sesv2.rb +6 -2
- metadata +8 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fb6a66af748cc3bf77b5558c5613550f7e17f2582dc2290cbd4041b17bcd3a60
|
4
|
+
data.tar.gz: 55c0093734a0e50373ddc7629b517a7d434cd35a7b28f8e95e79ed4a68ae46ae
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6eb65dfbf5df13fdb27b46a2b17362db2d2814318d20c8a05eb607d668ab1b2ec5f9671e5256b3a9c8ec6c65df4c10ee73d941b4607d668f86f334aa72cffa55
|
7
|
+
data.tar.gz: c8618048273c0f3b96ef0d5d3ed4d76f5b32741194ccfd24e652249cae85fd4a8a89b7f30d31ac285c6f748e9c4f6d936f2fb78846afba6faff386bcc3b46e6c
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.30.0 (2022-10-31)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release includes support for interacting with the Virtual Deliverability Manager, allowing you to opt in/out of the feature and to retrieve recommendations and metric data.
|
8
|
+
|
9
|
+
1.29.0 (2022-10-25)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.28.0 (2022-10-18)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.30.0
|
data/lib/aws-sdk-sesv2/client.rb
CHANGED
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
30
|
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
-
require 'aws-sdk-core/plugins/
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
34
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
35
|
|
36
36
|
Aws::Plugins::GlobalConfiguration.add_identifier(:sesv2)
|
@@ -79,8 +79,9 @@ module Aws::SESV2
|
|
79
79
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
81
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
-
add_plugin(Aws::Plugins::
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
83
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::SESV2::Plugins::Endpoints)
|
84
85
|
|
85
86
|
# @overload initialize(options)
|
86
87
|
# @param [Hash] options
|
@@ -287,6 +288,19 @@ module Aws::SESV2
|
|
287
288
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
288
289
|
# requests are made, and retries are disabled.
|
289
290
|
#
|
291
|
+
# @option options [Aws::TokenProvider] :token_provider
|
292
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
293
|
+
# following classes:
|
294
|
+
#
|
295
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
296
|
+
# tokens.
|
297
|
+
#
|
298
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
299
|
+
# access token generated from `aws login`.
|
300
|
+
#
|
301
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
302
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
303
|
+
#
|
290
304
|
# @option options [Boolean] :use_dualstack_endpoint
|
291
305
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
306
|
# will be used if available.
|
@@ -300,6 +314,9 @@ module Aws::SESV2
|
|
300
314
|
# When `true`, request parameters are validated before
|
301
315
|
# sending the request.
|
302
316
|
#
|
317
|
+
# @option options [Aws::SESV2::EndpointProvider] :endpoint_provider
|
318
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SESV2::EndpointParameters`
|
319
|
+
#
|
303
320
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
304
321
|
# requests through. Formatted like 'http://proxy.com:123'.
|
305
322
|
#
|
@@ -351,6 +368,59 @@ module Aws::SESV2
|
|
351
368
|
|
352
369
|
# @!group API Operations
|
353
370
|
|
371
|
+
# Retrieves batches of metric data collected based on your sending
|
372
|
+
# activity.
|
373
|
+
#
|
374
|
+
# You can execute this operation no more than 16 times per second, and
|
375
|
+
# with at most 160 queries from the batches per second (cumulative).
|
376
|
+
#
|
377
|
+
# @option params [required, Array<Types::BatchGetMetricDataQuery>] :queries
|
378
|
+
# A list of queries for metrics to be retrieved.
|
379
|
+
#
|
380
|
+
# @return [Types::BatchGetMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
381
|
+
#
|
382
|
+
# * {Types::BatchGetMetricDataResponse#results #results} => Array<Types::MetricDataResult>
|
383
|
+
# * {Types::BatchGetMetricDataResponse#errors #errors} => Array<Types::MetricDataError>
|
384
|
+
#
|
385
|
+
# @example Request syntax with placeholder values
|
386
|
+
#
|
387
|
+
# resp = client.batch_get_metric_data({
|
388
|
+
# queries: [ # required
|
389
|
+
# {
|
390
|
+
# id: "QueryIdentifier", # required
|
391
|
+
# namespace: "VDM", # required, accepts VDM
|
392
|
+
# metric: "SEND", # required, accepts SEND, COMPLAINT, PERMANENT_BOUNCE, TRANSIENT_BOUNCE, OPEN, CLICK, DELIVERY, DELIVERY_OPEN, DELIVERY_CLICK, DELIVERY_COMPLAINT
|
393
|
+
# dimensions: {
|
394
|
+
# "EMAIL_IDENTITY" => "MetricDimensionValue",
|
395
|
+
# },
|
396
|
+
# start_date: Time.now, # required
|
397
|
+
# end_date: Time.now, # required
|
398
|
+
# },
|
399
|
+
# ],
|
400
|
+
# })
|
401
|
+
#
|
402
|
+
# @example Response structure
|
403
|
+
#
|
404
|
+
# resp.results #=> Array
|
405
|
+
# resp.results[0].id #=> String
|
406
|
+
# resp.results[0].timestamps #=> Array
|
407
|
+
# resp.results[0].timestamps[0] #=> Time
|
408
|
+
# resp.results[0].values #=> Array
|
409
|
+
# resp.results[0].values[0] #=> Integer
|
410
|
+
# resp.errors #=> Array
|
411
|
+
# resp.errors[0].id #=> String
|
412
|
+
# resp.errors[0].code #=> String, one of "INTERNAL_FAILURE", "ACCESS_DENIED"
|
413
|
+
# resp.errors[0].message #=> String
|
414
|
+
#
|
415
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/BatchGetMetricData AWS API Documentation
|
416
|
+
#
|
417
|
+
# @overload batch_get_metric_data(params = {})
|
418
|
+
# @param [Hash] params ({})
|
419
|
+
def batch_get_metric_data(params = {}, options = {})
|
420
|
+
req = build_request(:batch_get_metric_data, params)
|
421
|
+
req.send_request(options)
|
422
|
+
end
|
423
|
+
|
354
424
|
# Create a configuration set. *Configuration sets* are groups of rules
|
355
425
|
# that you can apply to the emails that you send. You apply a
|
356
426
|
# configuration set to an email by specifying the name of the
|
@@ -387,6 +457,10 @@ module Aws::SESV2
|
|
387
457
|
# An object that contains information about the suppression list
|
388
458
|
# preferences for your account.
|
389
459
|
#
|
460
|
+
# @option params [Types::VdmOptions] :vdm_options
|
461
|
+
# An object that defines the VDM options for emails that you send using
|
462
|
+
# the configuration set.
|
463
|
+
#
|
390
464
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
391
465
|
#
|
392
466
|
# @example Request syntax with placeholder values
|
@@ -416,6 +490,14 @@ module Aws::SESV2
|
|
416
490
|
# suppression_options: {
|
417
491
|
# suppressed_reasons: ["BOUNCE"], # accepts BOUNCE, COMPLAINT
|
418
492
|
# },
|
493
|
+
# vdm_options: {
|
494
|
+
# dashboard_options: {
|
495
|
+
# engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
|
496
|
+
# },
|
497
|
+
# guardian_options: {
|
498
|
+
# optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
|
499
|
+
# },
|
500
|
+
# },
|
419
501
|
# })
|
420
502
|
#
|
421
503
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateConfigurationSet AWS API Documentation
|
@@ -1310,6 +1392,7 @@ module Aws::SESV2
|
|
1310
1392
|
# * {Types::GetAccountResponse#sending_enabled #sending_enabled} => Boolean
|
1311
1393
|
# * {Types::GetAccountResponse#suppression_attributes #suppression_attributes} => Types::SuppressionAttributes
|
1312
1394
|
# * {Types::GetAccountResponse#details #details} => Types::AccountDetails
|
1395
|
+
# * {Types::GetAccountResponse#vdm_attributes #vdm_attributes} => Types::VdmAttributes
|
1313
1396
|
#
|
1314
1397
|
# @example Response structure
|
1315
1398
|
#
|
@@ -1330,6 +1413,9 @@ module Aws::SESV2
|
|
1330
1413
|
# resp.details.additional_contact_email_addresses[0] #=> String
|
1331
1414
|
# resp.details.review_details.status #=> String, one of "PENDING", "FAILED", "GRANTED", "DENIED"
|
1332
1415
|
# resp.details.review_details.case_id #=> String
|
1416
|
+
# resp.vdm_attributes.vdm_enabled #=> String, one of "ENABLED", "DISABLED"
|
1417
|
+
# resp.vdm_attributes.dashboard_attributes.engagement_metrics #=> String, one of "ENABLED", "DISABLED"
|
1418
|
+
# resp.vdm_attributes.guardian_attributes.optimized_shared_delivery #=> String, one of "ENABLED", "DISABLED"
|
1333
1419
|
#
|
1334
1420
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetAccount AWS API Documentation
|
1335
1421
|
#
|
@@ -1397,6 +1483,7 @@ module Aws::SESV2
|
|
1397
1483
|
# * {Types::GetConfigurationSetResponse#sending_options #sending_options} => Types::SendingOptions
|
1398
1484
|
# * {Types::GetConfigurationSetResponse#tags #tags} => Array<Types::Tag>
|
1399
1485
|
# * {Types::GetConfigurationSetResponse#suppression_options #suppression_options} => Types::SuppressionOptions
|
1486
|
+
# * {Types::GetConfigurationSetResponse#vdm_options #vdm_options} => Types::VdmOptions
|
1400
1487
|
#
|
1401
1488
|
# @example Request syntax with placeholder values
|
1402
1489
|
#
|
@@ -1418,6 +1505,8 @@ module Aws::SESV2
|
|
1418
1505
|
# resp.tags[0].value #=> String
|
1419
1506
|
# resp.suppression_options.suppressed_reasons #=> Array
|
1420
1507
|
# resp.suppression_options.suppressed_reasons[0] #=> String, one of "BOUNCE", "COMPLAINT"
|
1508
|
+
# resp.vdm_options.dashboard_options.engagement_metrics #=> String, one of "ENABLED", "DISABLED"
|
1509
|
+
# resp.vdm_options.guardian_options.optimized_shared_delivery #=> String, one of "ENABLED", "DISABLED"
|
1421
1510
|
#
|
1422
1511
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetConfigurationSet AWS API Documentation
|
1423
1512
|
#
|
@@ -2716,6 +2805,67 @@ module Aws::SESV2
|
|
2716
2805
|
req.send_request(options)
|
2717
2806
|
end
|
2718
2807
|
|
2808
|
+
# Lists the recommendations present in your Amazon SES account in the
|
2809
|
+
# current Amazon Web Services Region.
|
2810
|
+
#
|
2811
|
+
# You can execute this operation no more than once per second.
|
2812
|
+
#
|
2813
|
+
# @option params [Hash<String,String>] :filter
|
2814
|
+
# Filters applied when retrieving recommendations. Can eiter be an
|
2815
|
+
# individual filter, or combinations of `STATUS` and `IMPACT` or
|
2816
|
+
# `STATUS` and `TYPE`
|
2817
|
+
#
|
2818
|
+
# @option params [String] :next_token
|
2819
|
+
# A token returned from a previous call to `ListRecommendations` to
|
2820
|
+
# indicate the position in the list of recommendations.
|
2821
|
+
#
|
2822
|
+
# @option params [Integer] :page_size
|
2823
|
+
# The number of results to show in a single call to
|
2824
|
+
# `ListRecommendations`. If the number of results is larger than the
|
2825
|
+
# number you specified in this parameter, then the response includes a
|
2826
|
+
# `NextToken` element, which you can use to obtain additional results.
|
2827
|
+
#
|
2828
|
+
# The value you specify has to be at least 1, and can be no more than
|
2829
|
+
# 100.
|
2830
|
+
#
|
2831
|
+
# @return [Types::ListRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2832
|
+
#
|
2833
|
+
# * {Types::ListRecommendationsResponse#recommendations #recommendations} => Array<Types::Recommendation>
|
2834
|
+
# * {Types::ListRecommendationsResponse#next_token #next_token} => String
|
2835
|
+
#
|
2836
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2837
|
+
#
|
2838
|
+
# @example Request syntax with placeholder values
|
2839
|
+
#
|
2840
|
+
# resp = client.list_recommendations({
|
2841
|
+
# filter: {
|
2842
|
+
# "TYPE" => "ListRecommendationFilterValue",
|
2843
|
+
# },
|
2844
|
+
# next_token: "NextToken",
|
2845
|
+
# page_size: 1,
|
2846
|
+
# })
|
2847
|
+
#
|
2848
|
+
# @example Response structure
|
2849
|
+
#
|
2850
|
+
# resp.recommendations #=> Array
|
2851
|
+
# resp.recommendations[0].resource_arn #=> String
|
2852
|
+
# resp.recommendations[0].type #=> String, one of "DKIM", "DMARC", "SPF"
|
2853
|
+
# resp.recommendations[0].description #=> String
|
2854
|
+
# resp.recommendations[0].status #=> String, one of "OPEN", "FIXED"
|
2855
|
+
# resp.recommendations[0].created_timestamp #=> Time
|
2856
|
+
# resp.recommendations[0].last_updated_timestamp #=> Time
|
2857
|
+
# resp.recommendations[0].impact #=> String, one of "LOW", "HIGH"
|
2858
|
+
# resp.next_token #=> String
|
2859
|
+
#
|
2860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListRecommendations AWS API Documentation
|
2861
|
+
#
|
2862
|
+
# @overload list_recommendations(params = {})
|
2863
|
+
# @param [Hash] params ({})
|
2864
|
+
def list_recommendations(params = {}, options = {})
|
2865
|
+
req = build_request(:list_recommendations, params)
|
2866
|
+
req.send_request(options)
|
2867
|
+
end
|
2868
|
+
|
2719
2869
|
# Retrieves a list of email addresses that are on the suppression list
|
2720
2870
|
# for your account.
|
2721
2871
|
#
|
@@ -2956,6 +3106,38 @@ module Aws::SESV2
|
|
2956
3106
|
req.send_request(options)
|
2957
3107
|
end
|
2958
3108
|
|
3109
|
+
# Update your Amazon SES account VDM attributes.
|
3110
|
+
#
|
3111
|
+
# You can execute this operation no more than once per second.
|
3112
|
+
#
|
3113
|
+
# @option params [required, Types::VdmAttributes] :vdm_attributes
|
3114
|
+
# The VDM attributes that you wish to apply to your Amazon SES account.
|
3115
|
+
#
|
3116
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3117
|
+
#
|
3118
|
+
# @example Request syntax with placeholder values
|
3119
|
+
#
|
3120
|
+
# resp = client.put_account_vdm_attributes({
|
3121
|
+
# vdm_attributes: { # required
|
3122
|
+
# vdm_enabled: "ENABLED", # required, accepts ENABLED, DISABLED
|
3123
|
+
# dashboard_attributes: {
|
3124
|
+
# engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
|
3125
|
+
# },
|
3126
|
+
# guardian_attributes: {
|
3127
|
+
# optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
|
3128
|
+
# },
|
3129
|
+
# },
|
3130
|
+
# })
|
3131
|
+
#
|
3132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountVdmAttributes AWS API Documentation
|
3133
|
+
#
|
3134
|
+
# @overload put_account_vdm_attributes(params = {})
|
3135
|
+
# @param [Hash] params ({})
|
3136
|
+
def put_account_vdm_attributes(params = {}, options = {})
|
3137
|
+
req = build_request(:put_account_vdm_attributes, params)
|
3138
|
+
req.send_request(options)
|
3139
|
+
end
|
3140
|
+
|
2959
3141
|
# Associate a configuration set with a dedicated IP pool. You can use
|
2960
3142
|
# dedicated IP pools to create groups of dedicated IP addresses for
|
2961
3143
|
# sending specific types of email.
|
@@ -3118,6 +3300,42 @@ module Aws::SESV2
|
|
3118
3300
|
req.send_request(options)
|
3119
3301
|
end
|
3120
3302
|
|
3303
|
+
# Specify VDM preferences for email that you send using the
|
3304
|
+
# configuration set.
|
3305
|
+
#
|
3306
|
+
# You can execute this operation no more than once per second.
|
3307
|
+
#
|
3308
|
+
# @option params [required, String] :configuration_set_name
|
3309
|
+
# The name of the configuration set.
|
3310
|
+
#
|
3311
|
+
# @option params [Types::VdmOptions] :vdm_options
|
3312
|
+
# The VDM options to apply to the configuration set.
|
3313
|
+
#
|
3314
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3315
|
+
#
|
3316
|
+
# @example Request syntax with placeholder values
|
3317
|
+
#
|
3318
|
+
# resp = client.put_configuration_set_vdm_options({
|
3319
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
3320
|
+
# vdm_options: {
|
3321
|
+
# dashboard_options: {
|
3322
|
+
# engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
|
3323
|
+
# },
|
3324
|
+
# guardian_options: {
|
3325
|
+
# optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
|
3326
|
+
# },
|
3327
|
+
# },
|
3328
|
+
# })
|
3329
|
+
#
|
3330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetVdmOptions AWS API Documentation
|
3331
|
+
#
|
3332
|
+
# @overload put_configuration_set_vdm_options(params = {})
|
3333
|
+
# @param [Hash] params ({})
|
3334
|
+
def put_configuration_set_vdm_options(params = {}, options = {})
|
3335
|
+
req = build_request(:put_configuration_set_vdm_options, params)
|
3336
|
+
req.send_request(options)
|
3337
|
+
end
|
3338
|
+
|
3121
3339
|
# Move a dedicated IP address to an existing dedicated IP pool.
|
3122
3340
|
#
|
3123
3341
|
# <note markdown="1"> The dedicated IP address that you specify must already exist, and must
|
@@ -4269,7 +4487,7 @@ module Aws::SESV2
|
|
4269
4487
|
params: params,
|
4270
4488
|
config: config)
|
4271
4489
|
context[:gem_name] = 'aws-sdk-sesv2'
|
4272
|
-
context[:gem_version] = '1.
|
4490
|
+
context[:gem_version] = '1.30.0'
|
4273
4491
|
Seahorse::Client::Request.new(handlers, context)
|
4274
4492
|
end
|
4275
4493
|
|