aws-sdk-sesv2 1.28.0 → 1.30.0
Sign up to get free protection for your applications and to get access to all the features.
- 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
data/lib/aws-sdk-sesv2/types.rb
CHANGED
@@ -78,6 +78,158 @@ module Aws::SESV2
|
|
78
78
|
#
|
79
79
|
class BadRequestException < Aws::EmptyStructure; end
|
80
80
|
|
81
|
+
# Represents a single metric data query to include in a batch.
|
82
|
+
#
|
83
|
+
# @note When making an API call, you may pass BatchGetMetricDataQuery
|
84
|
+
# data as a hash:
|
85
|
+
#
|
86
|
+
# {
|
87
|
+
# id: "QueryIdentifier", # required
|
88
|
+
# namespace: "VDM", # required, accepts VDM
|
89
|
+
# metric: "SEND", # required, accepts SEND, COMPLAINT, PERMANENT_BOUNCE, TRANSIENT_BOUNCE, OPEN, CLICK, DELIVERY, DELIVERY_OPEN, DELIVERY_CLICK, DELIVERY_COMPLAINT
|
90
|
+
# dimensions: {
|
91
|
+
# "EMAIL_IDENTITY" => "MetricDimensionValue",
|
92
|
+
# },
|
93
|
+
# start_date: Time.now, # required
|
94
|
+
# end_date: Time.now, # required
|
95
|
+
# }
|
96
|
+
#
|
97
|
+
# @!attribute [rw] id
|
98
|
+
# The query identifier.
|
99
|
+
# @return [String]
|
100
|
+
#
|
101
|
+
# @!attribute [rw] namespace
|
102
|
+
# The query namespace - e.g. `VDM`
|
103
|
+
# @return [String]
|
104
|
+
#
|
105
|
+
# @!attribute [rw] metric
|
106
|
+
# The queried metric. This can be one of the following:
|
107
|
+
#
|
108
|
+
# * `SEND` – Emails sent eligible for tracking in the VDM dashboard.
|
109
|
+
# This excludes emails sent to the mailbox simulator and emails
|
110
|
+
# addressed to more than one recipient.
|
111
|
+
#
|
112
|
+
# * `COMPLAINT` – Complaints received for your account. This excludes
|
113
|
+
# complaints from the mailbox simulator, those originating from your
|
114
|
+
# account-level suppression list (if enabled), and those for emails
|
115
|
+
# addressed to more than one recipient
|
116
|
+
#
|
117
|
+
# * `PERMANENT_BOUNCE` – Permanent bounces - i.e. feedback received
|
118
|
+
# for emails sent to non-existent mailboxes. Excludes bounces from
|
119
|
+
# the mailbox simulator, those originating from your account-level
|
120
|
+
# suppression list (if enabled), and those for emails addressed to
|
121
|
+
# more than one recipient.
|
122
|
+
#
|
123
|
+
# * `TRANSIENT_BOUNCE` – Transient bounces - i.e. feedback received
|
124
|
+
# for delivery failures excluding issues with non-existent
|
125
|
+
# mailboxes. Excludes bounces from the mailbox simulator, and those
|
126
|
+
# for emails addressed to more than one recipient.
|
127
|
+
#
|
128
|
+
# * `OPEN` – Unique open events for emails including open trackers.
|
129
|
+
# Excludes opens for emails addressed to more than one recipient.
|
130
|
+
#
|
131
|
+
# * `CLICK` – Unique click events for emails including wrapped links.
|
132
|
+
# Excludes clicks for emails addressed to more than one recipient.
|
133
|
+
#
|
134
|
+
# * `DELIVERY` – Successful deliveries for email sending attempts.
|
135
|
+
# Excludes deliveries to the mailbox simulator and for emails
|
136
|
+
# addressed to more than one recipient.
|
137
|
+
#
|
138
|
+
# * `DELIVERY_OPEN` – Successful deliveries for email sending
|
139
|
+
# attempts. Excludes deliveries to the mailbox simulator, for emails
|
140
|
+
# addressed to more than one recipient, and emails without open
|
141
|
+
# trackers.
|
142
|
+
#
|
143
|
+
# * `DELIVERY_CLICK` – Successful deliveries for email sending
|
144
|
+
# attempts. Excludes deliveries to the mailbox simulator, for emails
|
145
|
+
# addressed to more than one recipient, and emails without click
|
146
|
+
# trackers.
|
147
|
+
#
|
148
|
+
# * `DELIVERY_COMPLAINT` – Successful deliveries for email sending
|
149
|
+
# attempts. Excludes deliveries to the mailbox simulator, for emails
|
150
|
+
# addressed to more than one recipient, and emails addressed to
|
151
|
+
# recipients hosted by ISPs with which Amazon SES does not have a
|
152
|
+
# feedback loop agreement.
|
153
|
+
# @return [String]
|
154
|
+
#
|
155
|
+
# @!attribute [rw] dimensions
|
156
|
+
# An object that contains mapping between `MetricDimensionName` and
|
157
|
+
# `MetricDimensionValue` to filter metrics by.
|
158
|
+
# @return [Hash<String,String>]
|
159
|
+
#
|
160
|
+
# @!attribute [rw] start_date
|
161
|
+
# Represents the start date for the query interval.
|
162
|
+
# @return [Time]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] end_date
|
165
|
+
# Represents the end date for the query interval.
|
166
|
+
# @return [Time]
|
167
|
+
#
|
168
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/BatchGetMetricDataQuery AWS API Documentation
|
169
|
+
#
|
170
|
+
class BatchGetMetricDataQuery < Struct.new(
|
171
|
+
:id,
|
172
|
+
:namespace,
|
173
|
+
:metric,
|
174
|
+
:dimensions,
|
175
|
+
:start_date,
|
176
|
+
:end_date)
|
177
|
+
SENSITIVE = []
|
178
|
+
include Aws::Structure
|
179
|
+
end
|
180
|
+
|
181
|
+
# Represents a request to retrieve a batch of metric data.
|
182
|
+
#
|
183
|
+
# @note When making an API call, you may pass BatchGetMetricDataRequest
|
184
|
+
# data as a hash:
|
185
|
+
#
|
186
|
+
# {
|
187
|
+
# queries: [ # required
|
188
|
+
# {
|
189
|
+
# id: "QueryIdentifier", # required
|
190
|
+
# namespace: "VDM", # required, accepts VDM
|
191
|
+
# metric: "SEND", # required, accepts SEND, COMPLAINT, PERMANENT_BOUNCE, TRANSIENT_BOUNCE, OPEN, CLICK, DELIVERY, DELIVERY_OPEN, DELIVERY_CLICK, DELIVERY_COMPLAINT
|
192
|
+
# dimensions: {
|
193
|
+
# "EMAIL_IDENTITY" => "MetricDimensionValue",
|
194
|
+
# },
|
195
|
+
# start_date: Time.now, # required
|
196
|
+
# end_date: Time.now, # required
|
197
|
+
# },
|
198
|
+
# ],
|
199
|
+
# }
|
200
|
+
#
|
201
|
+
# @!attribute [rw] queries
|
202
|
+
# A list of queries for metrics to be retrieved.
|
203
|
+
# @return [Array<Types::BatchGetMetricDataQuery>]
|
204
|
+
#
|
205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/BatchGetMetricDataRequest AWS API Documentation
|
206
|
+
#
|
207
|
+
class BatchGetMetricDataRequest < Struct.new(
|
208
|
+
:queries)
|
209
|
+
SENSITIVE = []
|
210
|
+
include Aws::Structure
|
211
|
+
end
|
212
|
+
|
213
|
+
# Represents the result of processing your metric data batch request
|
214
|
+
#
|
215
|
+
# @!attribute [rw] results
|
216
|
+
# A list of successfully retrieved `MetricDataResult`.
|
217
|
+
# @return [Array<Types::MetricDataResult>]
|
218
|
+
#
|
219
|
+
# @!attribute [rw] errors
|
220
|
+
# A list of `MetricDataError` encountered while processing your metric
|
221
|
+
# data batch request.
|
222
|
+
# @return [Array<Types::MetricDataError>]
|
223
|
+
#
|
224
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/BatchGetMetricDataResponse AWS API Documentation
|
225
|
+
#
|
226
|
+
class BatchGetMetricDataResponse < Struct.new(
|
227
|
+
:results,
|
228
|
+
:errors)
|
229
|
+
SENSITIVE = []
|
230
|
+
include Aws::Structure
|
231
|
+
end
|
232
|
+
|
81
233
|
# An object that contains information about a blacklisting event that
|
82
234
|
# impacts one of the dedicated IP addresses that is associated with your
|
83
235
|
# account.
|
@@ -621,6 +773,14 @@ module Aws::SESV2
|
|
621
773
|
# suppression_options: {
|
622
774
|
# suppressed_reasons: ["BOUNCE"], # accepts BOUNCE, COMPLAINT
|
623
775
|
# },
|
776
|
+
# vdm_options: {
|
777
|
+
# dashboard_options: {
|
778
|
+
# engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
|
779
|
+
# },
|
780
|
+
# guardian_options: {
|
781
|
+
# optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
|
782
|
+
# },
|
783
|
+
# },
|
624
784
|
# }
|
625
785
|
#
|
626
786
|
# @!attribute [rw] configuration_set_name
|
@@ -659,6 +819,11 @@ module Aws::SESV2
|
|
659
819
|
# preferences for your account.
|
660
820
|
# @return [Types::SuppressionOptions]
|
661
821
|
#
|
822
|
+
# @!attribute [rw] vdm_options
|
823
|
+
# An object that defines the VDM options for emails that you send
|
824
|
+
# using the configuration set.
|
825
|
+
# @return [Types::VdmOptions]
|
826
|
+
#
|
662
827
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateConfigurationSetRequest AWS API Documentation
|
663
828
|
#
|
664
829
|
class CreateConfigurationSetRequest < Struct.new(
|
@@ -668,7 +833,8 @@ module Aws::SESV2
|
|
668
833
|
:reputation_options,
|
669
834
|
:sending_options,
|
670
835
|
:tags,
|
671
|
-
:suppression_options
|
836
|
+
:suppression_options,
|
837
|
+
:vdm_options)
|
672
838
|
SENSITIVE = []
|
673
839
|
include Aws::Structure
|
674
840
|
end
|
@@ -1326,6 +1492,64 @@ module Aws::SESV2
|
|
1326
1492
|
include Aws::Structure
|
1327
1493
|
end
|
1328
1494
|
|
1495
|
+
# An object containing additional settings for your VDM configuration as
|
1496
|
+
# applicable to the Dashboard.
|
1497
|
+
#
|
1498
|
+
# @note When making an API call, you may pass DashboardAttributes
|
1499
|
+
# data as a hash:
|
1500
|
+
#
|
1501
|
+
# {
|
1502
|
+
# engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
|
1503
|
+
# }
|
1504
|
+
#
|
1505
|
+
# @!attribute [rw] engagement_metrics
|
1506
|
+
# Specifies the status of your VDM engagement metrics collection. Can
|
1507
|
+
# be one of the following:
|
1508
|
+
#
|
1509
|
+
# * `ENABLED` – Amazon SES enables engagement metrics for your
|
1510
|
+
# account.
|
1511
|
+
#
|
1512
|
+
# * `DISABLED` – Amazon SES disables engagement metrics for your
|
1513
|
+
# account.
|
1514
|
+
# @return [String]
|
1515
|
+
#
|
1516
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DashboardAttributes AWS API Documentation
|
1517
|
+
#
|
1518
|
+
class DashboardAttributes < Struct.new(
|
1519
|
+
:engagement_metrics)
|
1520
|
+
SENSITIVE = []
|
1521
|
+
include Aws::Structure
|
1522
|
+
end
|
1523
|
+
|
1524
|
+
# An object containing additional settings for your VDM configuration as
|
1525
|
+
# applicable to the Dashboard.
|
1526
|
+
#
|
1527
|
+
# @note When making an API call, you may pass DashboardOptions
|
1528
|
+
# data as a hash:
|
1529
|
+
#
|
1530
|
+
# {
|
1531
|
+
# engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
|
1532
|
+
# }
|
1533
|
+
#
|
1534
|
+
# @!attribute [rw] engagement_metrics
|
1535
|
+
# Specifies the status of your VDM engagement metrics collection. Can
|
1536
|
+
# be one of the following:
|
1537
|
+
#
|
1538
|
+
# * `ENABLED` – Amazon SES enables engagement metrics for the
|
1539
|
+
# configuration set.
|
1540
|
+
#
|
1541
|
+
# * `DISABLED` – Amazon SES disables engagement metrics for the
|
1542
|
+
# configuration set.
|
1543
|
+
# @return [String]
|
1544
|
+
#
|
1545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DashboardOptions AWS API Documentation
|
1546
|
+
#
|
1547
|
+
class DashboardOptions < Struct.new(
|
1548
|
+
:engagement_metrics)
|
1549
|
+
SENSITIVE = []
|
1550
|
+
include Aws::Structure
|
1551
|
+
end
|
1552
|
+
|
1329
1553
|
# Contains information about a dedicated IP address that is associated
|
1330
1554
|
# with your Amazon SES account.
|
1331
1555
|
#
|
@@ -2574,6 +2798,10 @@ module Aws::SESV2
|
|
2574
2798
|
# An object that defines your account details.
|
2575
2799
|
# @return [Types::AccountDetails]
|
2576
2800
|
#
|
2801
|
+
# @!attribute [rw] vdm_attributes
|
2802
|
+
# The VDM attributes that apply to your Amazon SES account.
|
2803
|
+
# @return [Types::VdmAttributes]
|
2804
|
+
#
|
2577
2805
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetAccountResponse AWS API Documentation
|
2578
2806
|
#
|
2579
2807
|
class GetAccountResponse < Struct.new(
|
@@ -2583,7 +2811,8 @@ module Aws::SESV2
|
|
2583
2811
|
:send_quota,
|
2584
2812
|
:sending_enabled,
|
2585
2813
|
:suppression_attributes,
|
2586
|
-
:details
|
2814
|
+
:details,
|
2815
|
+
:vdm_attributes)
|
2587
2816
|
SENSITIVE = []
|
2588
2817
|
include Aws::Structure
|
2589
2818
|
end
|
@@ -2722,6 +2951,11 @@ module Aws::SESV2
|
|
2722
2951
|
# preferences for your account.
|
2723
2952
|
# @return [Types::SuppressionOptions]
|
2724
2953
|
#
|
2954
|
+
# @!attribute [rw] vdm_options
|
2955
|
+
# An object that contains information about the VDM preferences for
|
2956
|
+
# your configuration set.
|
2957
|
+
# @return [Types::VdmOptions]
|
2958
|
+
#
|
2725
2959
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetConfigurationSetResponse AWS API Documentation
|
2726
2960
|
#
|
2727
2961
|
class GetConfigurationSetResponse < Struct.new(
|
@@ -2731,7 +2965,8 @@ module Aws::SESV2
|
|
2731
2965
|
:reputation_options,
|
2732
2966
|
:sending_options,
|
2733
2967
|
:tags,
|
2734
|
-
:suppression_options
|
2968
|
+
:suppression_options,
|
2969
|
+
:vdm_options)
|
2735
2970
|
SENSITIVE = []
|
2736
2971
|
include Aws::Structure
|
2737
2972
|
end
|
@@ -3605,6 +3840,64 @@ module Aws::SESV2
|
|
3605
3840
|
include Aws::Structure
|
3606
3841
|
end
|
3607
3842
|
|
3843
|
+
# An object containing additional settings for your VDM configuration as
|
3844
|
+
# applicable to the Guardian.
|
3845
|
+
#
|
3846
|
+
# @note When making an API call, you may pass GuardianAttributes
|
3847
|
+
# data as a hash:
|
3848
|
+
#
|
3849
|
+
# {
|
3850
|
+
# optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
|
3851
|
+
# }
|
3852
|
+
#
|
3853
|
+
# @!attribute [rw] optimized_shared_delivery
|
3854
|
+
# Specifies the status of your VDM optimized shared delivery. Can be
|
3855
|
+
# one of the following:
|
3856
|
+
#
|
3857
|
+
# * `ENABLED` – Amazon SES enables optimized shared delivery for your
|
3858
|
+
# account.
|
3859
|
+
#
|
3860
|
+
# * `DISABLED` – Amazon SES disables optimized shared delivery for
|
3861
|
+
# your account.
|
3862
|
+
# @return [String]
|
3863
|
+
#
|
3864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GuardianAttributes AWS API Documentation
|
3865
|
+
#
|
3866
|
+
class GuardianAttributes < Struct.new(
|
3867
|
+
:optimized_shared_delivery)
|
3868
|
+
SENSITIVE = []
|
3869
|
+
include Aws::Structure
|
3870
|
+
end
|
3871
|
+
|
3872
|
+
# An object containing additional settings for your VDM configuration as
|
3873
|
+
# applicable to the Guardian.
|
3874
|
+
#
|
3875
|
+
# @note When making an API call, you may pass GuardianOptions
|
3876
|
+
# data as a hash:
|
3877
|
+
#
|
3878
|
+
# {
|
3879
|
+
# optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
|
3880
|
+
# }
|
3881
|
+
#
|
3882
|
+
# @!attribute [rw] optimized_shared_delivery
|
3883
|
+
# Specifies the status of your VDM optimized shared delivery. Can be
|
3884
|
+
# one of the following:
|
3885
|
+
#
|
3886
|
+
# * `ENABLED` – Amazon SES enables optimized shared delivery for the
|
3887
|
+
# configuration set.
|
3888
|
+
#
|
3889
|
+
# * `DISABLED` – Amazon SES disables optimized shared delivery for the
|
3890
|
+
# configuration set.
|
3891
|
+
# @return [String]
|
3892
|
+
#
|
3893
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GuardianOptions AWS API Documentation
|
3894
|
+
#
|
3895
|
+
class GuardianOptions < Struct.new(
|
3896
|
+
:optimized_shared_delivery)
|
3897
|
+
SENSITIVE = []
|
3898
|
+
include Aws::Structure
|
3899
|
+
end
|
3900
|
+
|
3608
3901
|
# Information about an email identity.
|
3609
3902
|
#
|
3610
3903
|
# @!attribute [rw] identity_type
|
@@ -3791,6 +4084,13 @@ module Aws::SESV2
|
|
3791
4084
|
include Aws::Structure
|
3792
4085
|
end
|
3793
4086
|
|
4087
|
+
# The request couldn't be processed because an error occurred with the
|
4088
|
+
# Amazon SES API v2.
|
4089
|
+
#
|
4090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/InternalServiceErrorException AWS API Documentation
|
4091
|
+
#
|
4092
|
+
class InternalServiceErrorException < Aws::EmptyStructure; end
|
4093
|
+
|
3794
4094
|
# The specified request includes an invalid or expired token.
|
3795
4095
|
#
|
3796
4096
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/InvalidNextTokenException AWS API Documentation
|
@@ -4541,6 +4841,75 @@ module Aws::SESV2
|
|
4541
4841
|
include Aws::Structure
|
4542
4842
|
end
|
4543
4843
|
|
4844
|
+
# Represents a request to list the existing recommendations for your
|
4845
|
+
# account.
|
4846
|
+
#
|
4847
|
+
# @note When making an API call, you may pass ListRecommendationsRequest
|
4848
|
+
# data as a hash:
|
4849
|
+
#
|
4850
|
+
# {
|
4851
|
+
# filter: {
|
4852
|
+
# "TYPE" => "ListRecommendationFilterValue",
|
4853
|
+
# },
|
4854
|
+
# next_token: "NextToken",
|
4855
|
+
# page_size: 1,
|
4856
|
+
# }
|
4857
|
+
#
|
4858
|
+
# @!attribute [rw] filter
|
4859
|
+
# Filters applied when retrieving recommendations. Can eiter be an
|
4860
|
+
# individual filter, or combinations of `STATUS` and `IMPACT` or
|
4861
|
+
# `STATUS` and `TYPE`
|
4862
|
+
# @return [Hash<String,String>]
|
4863
|
+
#
|
4864
|
+
# @!attribute [rw] next_token
|
4865
|
+
# A token returned from a previous call to `ListRecommendations` to
|
4866
|
+
# indicate the position in the list of recommendations.
|
4867
|
+
# @return [String]
|
4868
|
+
#
|
4869
|
+
# @!attribute [rw] page_size
|
4870
|
+
# The number of results to show in a single call to
|
4871
|
+
# `ListRecommendations`. If the number of results is larger than the
|
4872
|
+
# number you specified in this parameter, then the response includes a
|
4873
|
+
# `NextToken` element, which you can use to obtain additional results.
|
4874
|
+
#
|
4875
|
+
# The value you specify has to be at least 1, and can be no more than
|
4876
|
+
# 100.
|
4877
|
+
# @return [Integer]
|
4878
|
+
#
|
4879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListRecommendationsRequest AWS API Documentation
|
4880
|
+
#
|
4881
|
+
class ListRecommendationsRequest < Struct.new(
|
4882
|
+
:filter,
|
4883
|
+
:next_token,
|
4884
|
+
:page_size)
|
4885
|
+
SENSITIVE = []
|
4886
|
+
include Aws::Structure
|
4887
|
+
end
|
4888
|
+
|
4889
|
+
# Contains the response to your request to retrieve the list of
|
4890
|
+
# recommendations for your account.
|
4891
|
+
#
|
4892
|
+
# @!attribute [rw] recommendations
|
4893
|
+
# The recommendations applicable to your account.
|
4894
|
+
# @return [Array<Types::Recommendation>]
|
4895
|
+
#
|
4896
|
+
# @!attribute [rw] next_token
|
4897
|
+
# A string token indicating that there might be additional
|
4898
|
+
# recommendations available to be listed. Use the token provided in
|
4899
|
+
# the `ListRecommendationsResponse` to use in the subsequent call to
|
4900
|
+
# `ListRecommendations` with the same parameters to retrieve the next
|
4901
|
+
# page of recommendations.
|
4902
|
+
# @return [String]
|
4903
|
+
#
|
4904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListRecommendationsResponse AWS API Documentation
|
4905
|
+
#
|
4906
|
+
class ListRecommendationsResponse < Struct.new(
|
4907
|
+
:recommendations,
|
4908
|
+
:next_token)
|
4909
|
+
SENSITIVE = []
|
4910
|
+
include Aws::Structure
|
4911
|
+
end
|
4912
|
+
|
4544
4913
|
# A request to obtain a list of email destinations that are on the
|
4545
4914
|
# suppression list for your account.
|
4546
4915
|
#
|
@@ -4801,6 +5170,61 @@ module Aws::SESV2
|
|
4801
5170
|
include Aws::Structure
|
4802
5171
|
end
|
4803
5172
|
|
5173
|
+
# An error corresponding to the unsuccessful processing of a single
|
5174
|
+
# metric data query.
|
5175
|
+
#
|
5176
|
+
# @!attribute [rw] id
|
5177
|
+
# The query identifier.
|
5178
|
+
# @return [String]
|
5179
|
+
#
|
5180
|
+
# @!attribute [rw] code
|
5181
|
+
# The query error code. Can be one of:
|
5182
|
+
#
|
5183
|
+
# * `INTERNAL_FAILURE` – Amazon SES has failed to process one of the
|
5184
|
+
# queries.
|
5185
|
+
#
|
5186
|
+
# * `ACCESS_DENIED` – You have insufficient access to retrieve metrics
|
5187
|
+
# based on the given query.
|
5188
|
+
# @return [String]
|
5189
|
+
#
|
5190
|
+
# @!attribute [rw] message
|
5191
|
+
# The error message associated with the current query error.
|
5192
|
+
# @return [String]
|
5193
|
+
#
|
5194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/MetricDataError AWS API Documentation
|
5195
|
+
#
|
5196
|
+
class MetricDataError < Struct.new(
|
5197
|
+
:id,
|
5198
|
+
:code,
|
5199
|
+
:message)
|
5200
|
+
SENSITIVE = []
|
5201
|
+
include Aws::Structure
|
5202
|
+
end
|
5203
|
+
|
5204
|
+
# The result of a single metric data query.
|
5205
|
+
#
|
5206
|
+
# @!attribute [rw] id
|
5207
|
+
# The query identifier.
|
5208
|
+
# @return [String]
|
5209
|
+
#
|
5210
|
+
# @!attribute [rw] timestamps
|
5211
|
+
# A list of timestamps for the metric data results.
|
5212
|
+
# @return [Array<Time>]
|
5213
|
+
#
|
5214
|
+
# @!attribute [rw] values
|
5215
|
+
# A list of values (cumulative / sum) for the metric data results.
|
5216
|
+
# @return [Array<Integer>]
|
5217
|
+
#
|
5218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/MetricDataResult AWS API Documentation
|
5219
|
+
#
|
5220
|
+
class MetricDataResult < Struct.new(
|
5221
|
+
:id,
|
5222
|
+
:timestamps,
|
5223
|
+
:values)
|
5224
|
+
SENSITIVE = []
|
5225
|
+
include Aws::Structure
|
5226
|
+
end
|
5227
|
+
|
4804
5228
|
# The resource you attempted to access doesn't exist.
|
4805
5229
|
#
|
4806
5230
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/NotFoundException AWS API Documentation
|
@@ -5084,6 +5508,40 @@ module Aws::SESV2
|
|
5084
5508
|
#
|
5085
5509
|
class PutAccountSuppressionAttributesResponse < Aws::EmptyStructure; end
|
5086
5510
|
|
5511
|
+
# A request to submit new account VDM attributes.
|
5512
|
+
#
|
5513
|
+
# @note When making an API call, you may pass PutAccountVdmAttributesRequest
|
5514
|
+
# data as a hash:
|
5515
|
+
#
|
5516
|
+
# {
|
5517
|
+
# vdm_attributes: { # required
|
5518
|
+
# vdm_enabled: "ENABLED", # required, accepts ENABLED, DISABLED
|
5519
|
+
# dashboard_attributes: {
|
5520
|
+
# engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
|
5521
|
+
# },
|
5522
|
+
# guardian_attributes: {
|
5523
|
+
# optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
|
5524
|
+
# },
|
5525
|
+
# },
|
5526
|
+
# }
|
5527
|
+
#
|
5528
|
+
# @!attribute [rw] vdm_attributes
|
5529
|
+
# The VDM attributes that you wish to apply to your Amazon SES
|
5530
|
+
# account.
|
5531
|
+
# @return [Types::VdmAttributes]
|
5532
|
+
#
|
5533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountVdmAttributesRequest AWS API Documentation
|
5534
|
+
#
|
5535
|
+
class PutAccountVdmAttributesRequest < Struct.new(
|
5536
|
+
:vdm_attributes)
|
5537
|
+
SENSITIVE = []
|
5538
|
+
include Aws::Structure
|
5539
|
+
end
|
5540
|
+
|
5541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountVdmAttributesResponse AWS API Documentation
|
5542
|
+
#
|
5543
|
+
class PutAccountVdmAttributesResponse < Aws::EmptyStructure; end
|
5544
|
+
|
5087
5545
|
# A request to associate a configuration set with a dedicated IP pool.
|
5088
5546
|
#
|
5089
5547
|
# @note When making an API call, you may pass PutConfigurationSetDeliveryOptionsRequest
|
@@ -5285,6 +5743,47 @@ module Aws::SESV2
|
|
5285
5743
|
#
|
5286
5744
|
class PutConfigurationSetTrackingOptionsResponse < Aws::EmptyStructure; end
|
5287
5745
|
|
5746
|
+
# A request to add specific VDM settings to a configuration set.
|
5747
|
+
#
|
5748
|
+
# @note When making an API call, you may pass PutConfigurationSetVdmOptionsRequest
|
5749
|
+
# data as a hash:
|
5750
|
+
#
|
5751
|
+
# {
|
5752
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
5753
|
+
# vdm_options: {
|
5754
|
+
# dashboard_options: {
|
5755
|
+
# engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
|
5756
|
+
# },
|
5757
|
+
# guardian_options: {
|
5758
|
+
# optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
|
5759
|
+
# },
|
5760
|
+
# },
|
5761
|
+
# }
|
5762
|
+
#
|
5763
|
+
# @!attribute [rw] configuration_set_name
|
5764
|
+
# The name of the configuration set.
|
5765
|
+
# @return [String]
|
5766
|
+
#
|
5767
|
+
# @!attribute [rw] vdm_options
|
5768
|
+
# The VDM options to apply to the configuration set.
|
5769
|
+
# @return [Types::VdmOptions]
|
5770
|
+
#
|
5771
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetVdmOptionsRequest AWS API Documentation
|
5772
|
+
#
|
5773
|
+
class PutConfigurationSetVdmOptionsRequest < Struct.new(
|
5774
|
+
:configuration_set_name,
|
5775
|
+
:vdm_options)
|
5776
|
+
SENSITIVE = []
|
5777
|
+
include Aws::Structure
|
5778
|
+
end
|
5779
|
+
|
5780
|
+
# An HTTP 200 response if the request succeeds, or an error message if
|
5781
|
+
# the request fails.
|
5782
|
+
#
|
5783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetVdmOptionsResponse AWS API Documentation
|
5784
|
+
#
|
5785
|
+
class PutConfigurationSetVdmOptionsResponse < Aws::EmptyStructure; end
|
5786
|
+
|
5288
5787
|
# A request to move a dedicated IP address to a dedicated IP pool.
|
5289
5788
|
#
|
5290
5789
|
# @note When making an API call, you may pass PutDedicatedIpInPoolRequest
|
@@ -5804,6 +6303,53 @@ module Aws::SESV2
|
|
5804
6303
|
include Aws::Structure
|
5805
6304
|
end
|
5806
6305
|
|
6306
|
+
# A recommendation generated for your account.
|
6307
|
+
#
|
6308
|
+
# @!attribute [rw] resource_arn
|
6309
|
+
# The resource affected by the recommendation, with values like
|
6310
|
+
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`.
|
6311
|
+
# @return [String]
|
6312
|
+
#
|
6313
|
+
# @!attribute [rw] type
|
6314
|
+
# The recommendation type, with values like `DKIM`, `SPF` or `DMARC`.
|
6315
|
+
# @return [String]
|
6316
|
+
#
|
6317
|
+
# @!attribute [rw] description
|
6318
|
+
# The recommendation description / disambiguator - e.g. `DKIM1` and
|
6319
|
+
# `DKIM2` are different recommendations about your DKIM setup.
|
6320
|
+
# @return [String]
|
6321
|
+
#
|
6322
|
+
# @!attribute [rw] status
|
6323
|
+
# The recommendation status, with values like `OPEN` or `FIXED`.
|
6324
|
+
# @return [String]
|
6325
|
+
#
|
6326
|
+
# @!attribute [rw] created_timestamp
|
6327
|
+
# The first time this issue was encountered and the recommendation was
|
6328
|
+
# generated.
|
6329
|
+
# @return [Time]
|
6330
|
+
#
|
6331
|
+
# @!attribute [rw] last_updated_timestamp
|
6332
|
+
# The last time the recommendation was updated.
|
6333
|
+
# @return [Time]
|
6334
|
+
#
|
6335
|
+
# @!attribute [rw] impact
|
6336
|
+
# The recommendation impact, with values like `HIGH` or `LOW`.
|
6337
|
+
# @return [String]
|
6338
|
+
#
|
6339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/Recommendation AWS API Documentation
|
6340
|
+
#
|
6341
|
+
class Recommendation < Struct.new(
|
6342
|
+
:resource_arn,
|
6343
|
+
:type,
|
6344
|
+
:description,
|
6345
|
+
:status,
|
6346
|
+
:created_timestamp,
|
6347
|
+
:last_updated_timestamp,
|
6348
|
+
:impact)
|
6349
|
+
SENSITIVE = []
|
6350
|
+
include Aws::Structure
|
6351
|
+
end
|
6352
|
+
|
5807
6353
|
# The `ReplaceEmailContent` object to be used for a specific
|
5808
6354
|
# `BulkEmailEntry`. The `ReplacementTemplate` can be specified within
|
5809
6355
|
# this object.
|
@@ -7271,6 +7817,84 @@ module Aws::SESV2
|
|
7271
7817
|
#
|
7272
7818
|
class UpdateEmailTemplateResponse < Aws::EmptyStructure; end
|
7273
7819
|
|
7820
|
+
# The VDM attributes that apply to your Amazon SES account.
|
7821
|
+
#
|
7822
|
+
# @note When making an API call, you may pass VdmAttributes
|
7823
|
+
# data as a hash:
|
7824
|
+
#
|
7825
|
+
# {
|
7826
|
+
# vdm_enabled: "ENABLED", # required, accepts ENABLED, DISABLED
|
7827
|
+
# dashboard_attributes: {
|
7828
|
+
# engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
|
7829
|
+
# },
|
7830
|
+
# guardian_attributes: {
|
7831
|
+
# optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
|
7832
|
+
# },
|
7833
|
+
# }
|
7834
|
+
#
|
7835
|
+
# @!attribute [rw] vdm_enabled
|
7836
|
+
# Specifies the status of your VDM configuration. Can be one of the
|
7837
|
+
# following:
|
7838
|
+
#
|
7839
|
+
# * `ENABLED` – Amazon SES enables VDM for your account.
|
7840
|
+
#
|
7841
|
+
# * `DISABLED` – Amazon SES disables VDM for your account.
|
7842
|
+
# @return [String]
|
7843
|
+
#
|
7844
|
+
# @!attribute [rw] dashboard_attributes
|
7845
|
+
# Specifies additional settings for your VDM configuration as
|
7846
|
+
# applicable to the Dashboard.
|
7847
|
+
# @return [Types::DashboardAttributes]
|
7848
|
+
#
|
7849
|
+
# @!attribute [rw] guardian_attributes
|
7850
|
+
# Specifies additional settings for your VDM configuration as
|
7851
|
+
# applicable to the Guardian.
|
7852
|
+
# @return [Types::GuardianAttributes]
|
7853
|
+
#
|
7854
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/VdmAttributes AWS API Documentation
|
7855
|
+
#
|
7856
|
+
class VdmAttributes < Struct.new(
|
7857
|
+
:vdm_enabled,
|
7858
|
+
:dashboard_attributes,
|
7859
|
+
:guardian_attributes)
|
7860
|
+
SENSITIVE = []
|
7861
|
+
include Aws::Structure
|
7862
|
+
end
|
7863
|
+
|
7864
|
+
# An object that defines the VDM settings that apply to emails that you
|
7865
|
+
# send using the configuration set.
|
7866
|
+
#
|
7867
|
+
# @note When making an API call, you may pass VdmOptions
|
7868
|
+
# data as a hash:
|
7869
|
+
#
|
7870
|
+
# {
|
7871
|
+
# dashboard_options: {
|
7872
|
+
# engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
|
7873
|
+
# },
|
7874
|
+
# guardian_options: {
|
7875
|
+
# optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
|
7876
|
+
# },
|
7877
|
+
# }
|
7878
|
+
#
|
7879
|
+
# @!attribute [rw] dashboard_options
|
7880
|
+
# Specifies additional settings for your VDM configuration as
|
7881
|
+
# applicable to the Dashboard.
|
7882
|
+
# @return [Types::DashboardOptions]
|
7883
|
+
#
|
7884
|
+
# @!attribute [rw] guardian_options
|
7885
|
+
# Specifies additional settings for your VDM configuration as
|
7886
|
+
# applicable to the Guardian.
|
7887
|
+
# @return [Types::GuardianOptions]
|
7888
|
+
#
|
7889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/VdmOptions AWS API Documentation
|
7890
|
+
#
|
7891
|
+
class VdmOptions < Struct.new(
|
7892
|
+
:dashboard_options,
|
7893
|
+
:guardian_options)
|
7894
|
+
SENSITIVE = []
|
7895
|
+
include Aws::Structure
|
7896
|
+
end
|
7897
|
+
|
7274
7898
|
# An object that contains information about the amount of email that was
|
7275
7899
|
# delivered to recipients.
|
7276
7900
|
#
|