aws-sdk-sesv2 1.105.0 → 1.106.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sesv2/client.rb +36 -14
- data/lib/aws-sdk-sesv2/client_api.rb +11 -0
- data/lib/aws-sdk-sesv2/types.rb +127 -15
- data/lib/aws-sdk-sesv2.rb +1 -1
- data/sig/client.rbs +13 -1
- data/sig/types.rbs +13 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7f13ef709d7e1ec0a249d10c13cabe08307e4cf74313091763ac55d9517a0594
|
|
4
|
+
data.tar.gz: 790f51d2cc3acea699575829656e6eca9131afeaaf1d93b78148e71d5bb870fe
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f005e2f143b6cd1a04a4adb013345fd1d1cc225226f3e9baf8857722a305ceefc2fb83d439a317fc81767b76ac87ade4d6f4ea613b8da4978f332a399bde13cb
|
|
7
|
+
data.tar.gz: 9967ca4751d276e9936906d7b4f77e6f2133c8847b158f58d7ede42f9fcae7e1a171b0adfd6e3ad8c39584e140036ee2ce6ba7c7650a852ff2243d0c684d8656
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.106.0 (2026-08-20)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Amazon SES now supports per-message tracking overrides. You can use the new ConfigurationOverrides parameter in SendEmail and SendBulkEmail to enable or disable open and click tracking for individual messages without changing your account-level or configuration set settings.
|
|
8
|
+
|
|
4
9
|
1.105.0 (2026-07-22)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.106.0
|
data/lib/aws-sdk-sesv2/client.rb
CHANGED
|
@@ -4534,25 +4534,24 @@ module Aws::SESV2
|
|
|
4534
4534
|
req.send_request(options)
|
|
4535
4535
|
end
|
|
4536
4536
|
|
|
4537
|
-
# Set the pricing plan for your Amazon SES account.
|
|
4538
|
-
# to choose a billing plan that packages multiple Amazon SES features at
|
|
4539
|
-
# a single rate.
|
|
4537
|
+
# Set the pricing plan for your Amazon SES account.
|
|
4540
4538
|
#
|
|
4541
4539
|
# @option params [required, String] :plan
|
|
4542
|
-
# The pricing plan to apply to your Amazon SES account.
|
|
4543
|
-
# the
|
|
4540
|
+
# The pricing plan to apply to your Amazon SES account. For details
|
|
4541
|
+
# about each plan, see [Amazon SES Pricing][1]. Can be one of the
|
|
4542
|
+
# following:
|
|
4544
4543
|
#
|
|
4545
|
-
# * `NONE`
|
|
4546
|
-
# pricing.
|
|
4544
|
+
# * `NONE`
|
|
4547
4545
|
#
|
|
4548
|
-
# * `ESSENTIALS`
|
|
4549
|
-
# features.
|
|
4546
|
+
# * `ESSENTIALS`
|
|
4550
4547
|
#
|
|
4551
|
-
# * `PRO`
|
|
4552
|
-
# features for growing senders.
|
|
4548
|
+
# * `PRO`
|
|
4553
4549
|
#
|
|
4554
|
-
# * `ENTERPRISE`
|
|
4555
|
-
#
|
|
4550
|
+
# * `ENTERPRISE`
|
|
4551
|
+
#
|
|
4552
|
+
#
|
|
4553
|
+
#
|
|
4554
|
+
# [1]: http://aws.amazon.com/ses/pricing/
|
|
4556
4555
|
#
|
|
4557
4556
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
4558
4557
|
#
|
|
@@ -5524,6 +5523,12 @@ module Aws::SESV2
|
|
|
5524
5523
|
#
|
|
5525
5524
|
# </note>
|
|
5526
5525
|
#
|
|
5526
|
+
# @option params [Types::ConfigurationOverrides] :configuration_overrides
|
|
5527
|
+
# An object that overrides, for the messages in this request only,
|
|
5528
|
+
# settings that would otherwise apply to them. The overrides apply to
|
|
5529
|
+
# every message in the request. Each setting that you don't override
|
|
5530
|
+
# keeps the value that already applies.
|
|
5531
|
+
#
|
|
5527
5532
|
# @return [Types::SendBulkEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5528
5533
|
#
|
|
5529
5534
|
# * {Types::SendBulkEmailResponse#bulk_email_entry_results #bulk_email_entry_results} => Array<Types::BulkEmailEntryResult>
|
|
@@ -5600,6 +5605,12 @@ module Aws::SESV2
|
|
|
5600
5605
|
# configuration_set_name: "ConfigurationSetName",
|
|
5601
5606
|
# endpoint_id: "EndpointId",
|
|
5602
5607
|
# tenant_name: "TenantName",
|
|
5608
|
+
# configuration_overrides: {
|
|
5609
|
+
# tracking: {
|
|
5610
|
+
# open_tracking_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
|
5611
|
+
# click_tracking_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
|
5612
|
+
# },
|
|
5613
|
+
# },
|
|
5603
5614
|
# })
|
|
5604
5615
|
#
|
|
5605
5616
|
# @example Response structure
|
|
@@ -5775,6 +5786,11 @@ module Aws::SESV2
|
|
|
5775
5786
|
# An object used to specify a list or topic to which an email belongs,
|
|
5776
5787
|
# which will be used when a contact chooses to unsubscribe.
|
|
5777
5788
|
#
|
|
5789
|
+
# @option params [Types::ConfigurationOverrides] :configuration_overrides
|
|
5790
|
+
# An object that overrides, for this message only, settings that would
|
|
5791
|
+
# otherwise apply to it. Each setting that you don't override keeps the
|
|
5792
|
+
# value that already applies.
|
|
5793
|
+
#
|
|
5778
5794
|
# @return [Types::SendEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5779
5795
|
#
|
|
5780
5796
|
# * {Types::SendEmailResponse#message_id #message_id} => String
|
|
@@ -5870,6 +5886,12 @@ module Aws::SESV2
|
|
|
5870
5886
|
# contact_list_name: "ContactListName", # required
|
|
5871
5887
|
# topic_name: "TopicName",
|
|
5872
5888
|
# },
|
|
5889
|
+
# configuration_overrides: {
|
|
5890
|
+
# tracking: {
|
|
5891
|
+
# open_tracking_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
|
5892
|
+
# click_tracking_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
|
5893
|
+
# },
|
|
5894
|
+
# },
|
|
5873
5895
|
# })
|
|
5874
5896
|
#
|
|
5875
5897
|
# @example Response structure
|
|
@@ -6424,7 +6446,7 @@ module Aws::SESV2
|
|
|
6424
6446
|
tracer: tracer
|
|
6425
6447
|
)
|
|
6426
6448
|
context[:gem_name] = 'aws-sdk-sesv2'
|
|
6427
|
-
context[:gem_version] = '1.
|
|
6449
|
+
context[:gem_version] = '1.106.0'
|
|
6428
6450
|
Seahorse::Client::Request.new(handlers, context)
|
|
6429
6451
|
end
|
|
6430
6452
|
|
|
@@ -66,6 +66,7 @@ module Aws::SESV2
|
|
|
66
66
|
ComplaintFeedbackType = Shapes::StringShape.new(name: 'ComplaintFeedbackType')
|
|
67
67
|
ComplaintSubType = Shapes::StringShape.new(name: 'ComplaintSubType')
|
|
68
68
|
ConcurrentModificationException = Shapes::StructureShape.new(name: 'ConcurrentModificationException')
|
|
69
|
+
ConfigurationOverrides = Shapes::StructureShape.new(name: 'ConfigurationOverrides')
|
|
69
70
|
ConfigurationSetName = Shapes::StringShape.new(name: 'ConfigurationSetName')
|
|
70
71
|
ConfigurationSetNameList = Shapes::ListShape.new(name: 'ConfigurationSetNameList')
|
|
71
72
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
|
@@ -572,6 +573,7 @@ module Aws::SESV2
|
|
|
572
573
|
TopicPreference = Shapes::StructureShape.new(name: 'TopicPreference')
|
|
573
574
|
TopicPreferenceList = Shapes::ListShape.new(name: 'TopicPreferenceList')
|
|
574
575
|
Topics = Shapes::ListShape.new(name: 'Topics')
|
|
576
|
+
TrackingConfigurationOverrides = Shapes::StructureShape.new(name: 'TrackingConfigurationOverrides')
|
|
575
577
|
TrackingOptions = Shapes::StructureShape.new(name: 'TrackingOptions')
|
|
576
578
|
UnsubscribeAll = Shapes::BooleanShape.new(name: 'UnsubscribeAll')
|
|
577
579
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
|
@@ -711,6 +713,9 @@ module Aws::SESV2
|
|
|
711
713
|
|
|
712
714
|
ConcurrentModificationException.struct_class = Types::ConcurrentModificationException
|
|
713
715
|
|
|
716
|
+
ConfigurationOverrides.add_member(:tracking, Shapes::ShapeRef.new(shape: TrackingConfigurationOverrides, location_name: "Tracking"))
|
|
717
|
+
ConfigurationOverrides.struct_class = Types::ConfigurationOverrides
|
|
718
|
+
|
|
714
719
|
ConfigurationSetNameList.member = Shapes::ShapeRef.new(shape: ConfigurationSetName)
|
|
715
720
|
|
|
716
721
|
ConflictException.struct_class = Types::ConflictException
|
|
@@ -1986,6 +1991,7 @@ module Aws::SESV2
|
|
|
1986
1991
|
SendBulkEmailRequest.add_member(:configuration_set_name, Shapes::ShapeRef.new(shape: ConfigurationSetName, location_name: "ConfigurationSetName"))
|
|
1987
1992
|
SendBulkEmailRequest.add_member(:endpoint_id, Shapes::ShapeRef.new(shape: EndpointId, location_name: "EndpointId", metadata: {"contextParam" => {"name" => "EndpointId"}}))
|
|
1988
1993
|
SendBulkEmailRequest.add_member(:tenant_name, Shapes::ShapeRef.new(shape: TenantName, location_name: "TenantName"))
|
|
1994
|
+
SendBulkEmailRequest.add_member(:configuration_overrides, Shapes::ShapeRef.new(shape: ConfigurationOverrides, location_name: "ConfigurationOverrides"))
|
|
1989
1995
|
SendBulkEmailRequest.struct_class = Types::SendBulkEmailRequest
|
|
1990
1996
|
|
|
1991
1997
|
SendBulkEmailResponse.add_member(:bulk_email_entry_results, Shapes::ShapeRef.new(shape: BulkEmailEntryResultList, required: true, location_name: "BulkEmailEntryResults"))
|
|
@@ -2011,6 +2017,7 @@ module Aws::SESV2
|
|
|
2011
2017
|
SendEmailRequest.add_member(:endpoint_id, Shapes::ShapeRef.new(shape: EndpointId, location_name: "EndpointId", metadata: {"contextParam" => {"name" => "EndpointId"}}))
|
|
2012
2018
|
SendEmailRequest.add_member(:tenant_name, Shapes::ShapeRef.new(shape: TenantName, location_name: "TenantName"))
|
|
2013
2019
|
SendEmailRequest.add_member(:list_management_options, Shapes::ShapeRef.new(shape: ListManagementOptions, location_name: "ListManagementOptions"))
|
|
2020
|
+
SendEmailRequest.add_member(:configuration_overrides, Shapes::ShapeRef.new(shape: ConfigurationOverrides, location_name: "ConfigurationOverrides"))
|
|
2014
2021
|
SendEmailRequest.struct_class = Types::SendEmailRequest
|
|
2015
2022
|
|
|
2016
2023
|
SendEmailResponse.add_member(:message_id, Shapes::ShapeRef.new(shape: OutboundMessageId, location_name: "MessageId"))
|
|
@@ -2157,6 +2164,10 @@ module Aws::SESV2
|
|
|
2157
2164
|
|
|
2158
2165
|
Topics.member = Shapes::ShapeRef.new(shape: Topic)
|
|
2159
2166
|
|
|
2167
|
+
TrackingConfigurationOverrides.add_member(:open_tracking_enabled, Shapes::ShapeRef.new(shape: FeatureStatus, location_name: "OpenTrackingEnabled"))
|
|
2168
|
+
TrackingConfigurationOverrides.add_member(:click_tracking_enabled, Shapes::ShapeRef.new(shape: FeatureStatus, location_name: "ClickTrackingEnabled"))
|
|
2169
|
+
TrackingConfigurationOverrides.struct_class = Types::TrackingConfigurationOverrides
|
|
2170
|
+
|
|
2160
2171
|
TrackingOptions.add_member(:custom_redirect_domain, Shapes::ShapeRef.new(shape: CustomRedirectDomain, required: true, location_name: "CustomRedirectDomain"))
|
|
2161
2172
|
TrackingOptions.add_member(:https_policy, Shapes::ShapeRef.new(shape: HttpsPolicy, location_name: "HttpsPolicy"))
|
|
2162
2173
|
TrackingOptions.struct_class = Types::TrackingOptions
|
data/lib/aws-sdk-sesv2/types.rb
CHANGED
|
@@ -623,6 +623,29 @@ module Aws::SESV2
|
|
|
623
623
|
#
|
|
624
624
|
class ConcurrentModificationException < Aws::EmptyStructure; end
|
|
625
625
|
|
|
626
|
+
# An object that overrides settings for a single email sending request.
|
|
627
|
+
# An override applies only to the message or messages in the request
|
|
628
|
+
# that contains it. It doesn't change your account-level settings, and
|
|
629
|
+
# it doesn't change the configuration set that the request uses.
|
|
630
|
+
#
|
|
631
|
+
# A setting that you don't override keeps the value that would
|
|
632
|
+
# otherwise apply to the message. Depending on the setting, that value
|
|
633
|
+
# comes from the configuration set that the message uses, from your
|
|
634
|
+
# account-level settings, or from the Amazon SES default.
|
|
635
|
+
#
|
|
636
|
+
# @!attribute [rw] tracking
|
|
637
|
+
# An object that overrides the open and click tracking settings that
|
|
638
|
+
# would otherwise apply to the message.
|
|
639
|
+
# @return [Types::TrackingConfigurationOverrides]
|
|
640
|
+
#
|
|
641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ConfigurationOverrides AWS API Documentation
|
|
642
|
+
#
|
|
643
|
+
class ConfigurationOverrides < Struct.new(
|
|
644
|
+
:tracking)
|
|
645
|
+
SENSITIVE = []
|
|
646
|
+
include Aws::Structure
|
|
647
|
+
end
|
|
648
|
+
|
|
626
649
|
# If there is already an ongoing account details update under review.
|
|
627
650
|
#
|
|
628
651
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ConflictException AWS API Documentation
|
|
@@ -6586,8 +6609,7 @@ module Aws::SESV2
|
|
|
6586
6609
|
end
|
|
6587
6610
|
|
|
6588
6611
|
# The pricing attributes that apply to your Amazon SES account,
|
|
6589
|
-
# including the currently active pricing plan and any scheduled change
|
|
6590
|
-
# for the next billing cycle.
|
|
6612
|
+
# including the currently active pricing plan and any scheduled change.
|
|
6591
6613
|
#
|
|
6592
6614
|
# @!attribute [rw] current_plan
|
|
6593
6615
|
# The pricing plan that is currently active on your Amazon SES
|
|
@@ -6596,7 +6618,7 @@ module Aws::SESV2
|
|
|
6596
6618
|
#
|
|
6597
6619
|
# @!attribute [rw] next_plan
|
|
6598
6620
|
# The pricing plan that will become active at the start of the next
|
|
6599
|
-
#
|
|
6621
|
+
# monthly cycle, if a scheduled change has been requested. This field
|
|
6600
6622
|
# is empty when no scheduled change is pending.
|
|
6601
6623
|
# @return [String]
|
|
6602
6624
|
#
|
|
@@ -6695,20 +6717,21 @@ module Aws::SESV2
|
|
|
6695
6717
|
# A request to set the pricing plan for your Amazon SES account.
|
|
6696
6718
|
#
|
|
6697
6719
|
# @!attribute [rw] plan
|
|
6698
|
-
# The pricing plan to apply to your Amazon SES account.
|
|
6699
|
-
# the
|
|
6720
|
+
# The pricing plan to apply to your Amazon SES account. For details
|
|
6721
|
+
# about each plan, see [Amazon SES Pricing][1]. Can be one of the
|
|
6722
|
+
# following:
|
|
6723
|
+
#
|
|
6724
|
+
# * `NONE`
|
|
6700
6725
|
#
|
|
6701
|
-
# * `
|
|
6702
|
-
# pricing.
|
|
6726
|
+
# * `ESSENTIALS`
|
|
6703
6727
|
#
|
|
6704
|
-
# * `
|
|
6705
|
-
# features.
|
|
6728
|
+
# * `PRO`
|
|
6706
6729
|
#
|
|
6707
|
-
# * `
|
|
6708
|
-
# premium features for growing senders.
|
|
6730
|
+
# * `ENTERPRISE`
|
|
6709
6731
|
#
|
|
6710
|
-
#
|
|
6711
|
-
#
|
|
6732
|
+
#
|
|
6733
|
+
#
|
|
6734
|
+
# [1]: http://aws.amazon.com/ses/pricing/
|
|
6712
6735
|
# @return [String]
|
|
6713
6736
|
#
|
|
6714
6737
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountPricingAttributesRequest AWS API Documentation
|
|
@@ -7985,6 +8008,13 @@ module Aws::SESV2
|
|
|
7985
8008
|
# </note>
|
|
7986
8009
|
# @return [String]
|
|
7987
8010
|
#
|
|
8011
|
+
# @!attribute [rw] configuration_overrides
|
|
8012
|
+
# An object that overrides, for the messages in this request only,
|
|
8013
|
+
# settings that would otherwise apply to them. The overrides apply to
|
|
8014
|
+
# every message in the request. Each setting that you don't override
|
|
8015
|
+
# keeps the value that already applies.
|
|
8016
|
+
# @return [Types::ConfigurationOverrides]
|
|
8017
|
+
#
|
|
7988
8018
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendBulkEmailRequest AWS API Documentation
|
|
7989
8019
|
#
|
|
7990
8020
|
class SendBulkEmailRequest < Struct.new(
|
|
@@ -7998,7 +8028,8 @@ module Aws::SESV2
|
|
|
7998
8028
|
:bulk_email_entries,
|
|
7999
8029
|
:configuration_set_name,
|
|
8000
8030
|
:endpoint_id,
|
|
8001
|
-
:tenant_name
|
|
8031
|
+
:tenant_name,
|
|
8032
|
+
:configuration_overrides)
|
|
8002
8033
|
SENSITIVE = []
|
|
8003
8034
|
include Aws::Structure
|
|
8004
8035
|
end
|
|
@@ -8167,6 +8198,12 @@ module Aws::SESV2
|
|
|
8167
8198
|
# which will be used when a contact chooses to unsubscribe.
|
|
8168
8199
|
# @return [Types::ListManagementOptions]
|
|
8169
8200
|
#
|
|
8201
|
+
# @!attribute [rw] configuration_overrides
|
|
8202
|
+
# An object that overrides, for this message only, settings that would
|
|
8203
|
+
# otherwise apply to it. Each setting that you don't override keeps
|
|
8204
|
+
# the value that already applies.
|
|
8205
|
+
# @return [Types::ConfigurationOverrides]
|
|
8206
|
+
#
|
|
8170
8207
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendEmailRequest AWS API Documentation
|
|
8171
8208
|
#
|
|
8172
8209
|
class SendEmailRequest < Struct.new(
|
|
@@ -8181,7 +8218,8 @@ module Aws::SESV2
|
|
|
8181
8218
|
:configuration_set_name,
|
|
8182
8219
|
:endpoint_id,
|
|
8183
8220
|
:tenant_name,
|
|
8184
|
-
:list_management_options
|
|
8221
|
+
:list_management_options,
|
|
8222
|
+
:configuration_overrides)
|
|
8185
8223
|
SENSITIVE = []
|
|
8186
8224
|
include Aws::Structure
|
|
8187
8225
|
end
|
|
@@ -8968,6 +9006,80 @@ module Aws::SESV2
|
|
|
8968
9006
|
include Aws::Structure
|
|
8969
9007
|
end
|
|
8970
9008
|
|
|
9009
|
+
# An object that overrides, for a single email sending request, the
|
|
9010
|
+
# engagement tracking settings that would otherwise apply. Use these
|
|
9011
|
+
# overrides to turn open tracking or click tracking on or off for an
|
|
9012
|
+
# individual message, for example to suppress tracking in a
|
|
9013
|
+
# transactional message that you send from an account or a configuration
|
|
9014
|
+
# set that has tracking enabled.
|
|
9015
|
+
#
|
|
9016
|
+
# Without an override, engagement tracking is determined by your
|
|
9017
|
+
# account-level `EngagementMetrics` setting, which you configure using
|
|
9018
|
+
# the `PutAccountVdmAttributes` operation, by the `EngagementMetrics`
|
|
9019
|
+
# setting of the configuration set that the message uses, which you
|
|
9020
|
+
# configure using the `PutConfigurationSetVdmOptions` operation, and by
|
|
9021
|
+
# whether that configuration set has an event destination whose
|
|
9022
|
+
# `MatchingEventTypes` include the `OPEN` or `CLICK` event types.
|
|
9023
|
+
#
|
|
9024
|
+
# For more information about tracking open and click events, see the
|
|
9025
|
+
# [Amazon SES Developer Guide][1].
|
|
9026
|
+
#
|
|
9027
|
+
#
|
|
9028
|
+
#
|
|
9029
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/event-publishing.html
|
|
9030
|
+
#
|
|
9031
|
+
# @!attribute [rw] open_tracking_enabled
|
|
9032
|
+
# Specifies whether Amazon SES tracks when the recipient opens this
|
|
9033
|
+
# message. Can be one of the following:
|
|
9034
|
+
#
|
|
9035
|
+
# * `ENABLED` – Amazon SES tracks opens for this message, even when
|
|
9036
|
+
# your account-level and configuration set settings don't enable
|
|
9037
|
+
# open tracking.
|
|
9038
|
+
#
|
|
9039
|
+
# * `DISABLED` – Amazon SES doesn't track opens for this message,
|
|
9040
|
+
# even when your account-level or configuration set settings enable
|
|
9041
|
+
# open tracking. Amazon SES doesn't add the tracking image to the
|
|
9042
|
+
# message.
|
|
9043
|
+
#
|
|
9044
|
+
# If you don't specify this value, Amazon SES uses the open tracking
|
|
9045
|
+
# setting that would otherwise apply to the message.
|
|
9046
|
+
# @return [String]
|
|
9047
|
+
#
|
|
9048
|
+
# @!attribute [rw] click_tracking_enabled
|
|
9049
|
+
# Specifies whether Amazon SES tracks when the recipient clicks a link
|
|
9050
|
+
# in this message. Can be one of the following:
|
|
9051
|
+
#
|
|
9052
|
+
# * `ENABLED` – Amazon SES tracks clicks for this message, even when
|
|
9053
|
+
# your account-level and configuration set settings don't enable
|
|
9054
|
+
# click tracking.
|
|
9055
|
+
#
|
|
9056
|
+
# * `DISABLED` – Amazon SES doesn't track clicks for this message,
|
|
9057
|
+
# even when your account-level or configuration set settings enable
|
|
9058
|
+
# click tracking. Amazon SES doesn't rewrite the links in the
|
|
9059
|
+
# message.
|
|
9060
|
+
#
|
|
9061
|
+
# If you don't specify this value, Amazon SES uses the click tracking
|
|
9062
|
+
# setting that would otherwise apply to the message.
|
|
9063
|
+
#
|
|
9064
|
+
# <note markdown="1"> Enabling open or click tracking with an override doesn't create an
|
|
9065
|
+
# event destination. Amazon SES records the resulting open and click
|
|
9066
|
+
# events in VDM, where you can review them using VDM metrics and
|
|
9067
|
+
# Message Insights. To also receive these events at a destination that
|
|
9068
|
+
# you own, the configuration set that the message uses must have an
|
|
9069
|
+
# event destination that publishes open and click events.
|
|
9070
|
+
#
|
|
9071
|
+
# </note>
|
|
9072
|
+
# @return [String]
|
|
9073
|
+
#
|
|
9074
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TrackingConfigurationOverrides AWS API Documentation
|
|
9075
|
+
#
|
|
9076
|
+
class TrackingConfigurationOverrides < Struct.new(
|
|
9077
|
+
:open_tracking_enabled,
|
|
9078
|
+
:click_tracking_enabled)
|
|
9079
|
+
SENSITIVE = []
|
|
9080
|
+
include Aws::Structure
|
|
9081
|
+
end
|
|
9082
|
+
|
|
8971
9083
|
# An object that defines the tracking options for a configuration set.
|
|
8972
9084
|
# When you use the Amazon SES API v2 to send an email, it contains an
|
|
8973
9085
|
# invisible image that's used to track when recipients open your email.
|
data/lib/aws-sdk-sesv2.rb
CHANGED
data/sig/client.rbs
CHANGED
|
@@ -1463,7 +1463,13 @@ module Aws
|
|
|
1463
1463
|
],
|
|
1464
1464
|
?configuration_set_name: ::String,
|
|
1465
1465
|
?endpoint_id: ::String,
|
|
1466
|
-
?tenant_name: ::String
|
|
1466
|
+
?tenant_name: ::String,
|
|
1467
|
+
?configuration_overrides: {
|
|
1468
|
+
tracking: {
|
|
1469
|
+
open_tracking_enabled: ("ENABLED" | "DISABLED")?,
|
|
1470
|
+
click_tracking_enabled: ("ENABLED" | "DISABLED")?
|
|
1471
|
+
}?
|
|
1472
|
+
}
|
|
1467
1473
|
) -> _SendBulkEmailResponseSuccess
|
|
1468
1474
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendBulkEmailResponseSuccess
|
|
1469
1475
|
|
|
@@ -1508,6 +1514,12 @@ module Aws
|
|
|
1508
1514
|
?list_management_options: {
|
|
1509
1515
|
contact_list_name: ::String,
|
|
1510
1516
|
topic_name: ::String?
|
|
1517
|
+
},
|
|
1518
|
+
?configuration_overrides: {
|
|
1519
|
+
tracking: {
|
|
1520
|
+
open_tracking_enabled: ("ENABLED" | "DISABLED")?,
|
|
1521
|
+
click_tracking_enabled: ("ENABLED" | "DISABLED")?
|
|
1522
|
+
}?
|
|
1511
1523
|
}
|
|
1512
1524
|
) -> _SendEmailResponseSuccess
|
|
1513
1525
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendEmailResponseSuccess
|
data/sig/types.rbs
CHANGED
|
@@ -133,6 +133,11 @@ module Aws::SESV2
|
|
|
133
133
|
class ConcurrentModificationException < Aws::EmptyStructure
|
|
134
134
|
end
|
|
135
135
|
|
|
136
|
+
class ConfigurationOverrides
|
|
137
|
+
attr_accessor tracking: Types::TrackingConfigurationOverrides
|
|
138
|
+
SENSITIVE: []
|
|
139
|
+
end
|
|
140
|
+
|
|
136
141
|
class ConflictException < Aws::EmptyStructure
|
|
137
142
|
end
|
|
138
143
|
|
|
@@ -1794,6 +1799,7 @@ module Aws::SESV2
|
|
|
1794
1799
|
attr_accessor configuration_set_name: ::String
|
|
1795
1800
|
attr_accessor endpoint_id: ::String
|
|
1796
1801
|
attr_accessor tenant_name: ::String
|
|
1802
|
+
attr_accessor configuration_overrides: Types::ConfigurationOverrides
|
|
1797
1803
|
SENSITIVE: []
|
|
1798
1804
|
end
|
|
1799
1805
|
|
|
@@ -1827,6 +1833,7 @@ module Aws::SESV2
|
|
|
1827
1833
|
attr_accessor endpoint_id: ::String
|
|
1828
1834
|
attr_accessor tenant_name: ::String
|
|
1829
1835
|
attr_accessor list_management_options: Types::ListManagementOptions
|
|
1836
|
+
attr_accessor configuration_overrides: Types::ConfigurationOverrides
|
|
1830
1837
|
SENSITIVE: []
|
|
1831
1838
|
end
|
|
1832
1839
|
|
|
@@ -2013,6 +2020,12 @@ module Aws::SESV2
|
|
|
2013
2020
|
SENSITIVE: []
|
|
2014
2021
|
end
|
|
2015
2022
|
|
|
2023
|
+
class TrackingConfigurationOverrides
|
|
2024
|
+
attr_accessor open_tracking_enabled: ("ENABLED" | "DISABLED")
|
|
2025
|
+
attr_accessor click_tracking_enabled: ("ENABLED" | "DISABLED")
|
|
2026
|
+
SENSITIVE: []
|
|
2027
|
+
end
|
|
2028
|
+
|
|
2016
2029
|
class TrackingOptions
|
|
2017
2030
|
attr_accessor custom_redirect_domain: ::String
|
|
2018
2031
|
attr_accessor https_policy: ("REQUIRE" | "REQUIRE_OPEN_ONLY" | "OPTIONAL")
|