aws-sdk-pinpointemail 1.46.0 → 1.47.0

Sign up to get free protection for your applications and to get access to all the features.
data/sig/client.rbs ADDED
@@ -0,0 +1,697 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module PinpointEmail
10
+ class Client < ::Seahorse::Client::Base
11
+ include ::Aws::ClientStubs
12
+
13
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#initialize-instance_method
14
+ def self.new: (
15
+ ?credentials: untyped,
16
+ ?region: String,
17
+ ?access_key_id: String,
18
+ ?active_endpoint_cache: bool,
19
+ ?adaptive_retry_wait_to_fill: bool,
20
+ ?client_side_monitoring: bool,
21
+ ?client_side_monitoring_client_id: String,
22
+ ?client_side_monitoring_host: String,
23
+ ?client_side_monitoring_port: Integer,
24
+ ?client_side_monitoring_publisher: untyped,
25
+ ?convert_params: bool,
26
+ ?correct_clock_skew: bool,
27
+ ?defaults_mode: String,
28
+ ?disable_host_prefix_injection: bool,
29
+ ?disable_request_compression: bool,
30
+ ?endpoint: String,
31
+ ?endpoint_cache_max_entries: Integer,
32
+ ?endpoint_cache_max_threads: Integer,
33
+ ?endpoint_cache_poll_interval: Integer,
34
+ ?endpoint_discovery: bool,
35
+ ?ignore_configured_endpoint_urls: bool,
36
+ ?log_formatter: untyped,
37
+ ?log_level: Symbol,
38
+ ?logger: untyped,
39
+ ?max_attempts: Integer,
40
+ ?profile: String,
41
+ ?request_min_compression_size_bytes: Integer,
42
+ ?retry_backoff: Proc,
43
+ ?retry_base_delay: Float,
44
+ ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
45
+ ?retry_limit: Integer,
46
+ ?retry_max_delay: Integer,
47
+ ?retry_mode: ("legacy" | "standard" | "adaptive"),
48
+ ?sdk_ua_app_id: String,
49
+ ?secret_access_key: String,
50
+ ?session_token: String,
51
+ ?stub_responses: untyped,
52
+ ?token_provider: untyped,
53
+ ?use_dualstack_endpoint: bool,
54
+ ?use_fips_endpoint: bool,
55
+ ?validate_params: bool,
56
+ ?endpoint_provider: untyped,
57
+ ?http_proxy: String,
58
+ ?http_open_timeout: (Float | Integer),
59
+ ?http_read_timeout: (Float | Integer),
60
+ ?http_idle_timeout: (Float | Integer),
61
+ ?http_continue_timeout: (Float | Integer),
62
+ ?ssl_timeout: (Float | Integer | nil),
63
+ ?http_wire_trace: bool,
64
+ ?ssl_verify_peer: bool,
65
+ ?ssl_ca_bundle: String,
66
+ ?ssl_ca_directory: String,
67
+ ?ssl_ca_store: String,
68
+ ?on_chunk_received: Proc,
69
+ ?on_chunk_sent: Proc,
70
+ ?raise_response_errors: bool
71
+ ) -> instance
72
+ | (?Hash[Symbol, untyped]) -> instance
73
+
74
+
75
+ interface _CreateConfigurationSetResponseSuccess
76
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateConfigurationSetResponse]
77
+ end
78
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#create_configuration_set-instance_method
79
+ def create_configuration_set: (
80
+ configuration_set_name: ::String,
81
+ ?tracking_options: {
82
+ custom_redirect_domain: ::String
83
+ },
84
+ ?delivery_options: {
85
+ tls_policy: ("REQUIRE" | "OPTIONAL")?,
86
+ sending_pool_name: ::String?
87
+ },
88
+ ?reputation_options: {
89
+ reputation_metrics_enabled: bool?,
90
+ last_fresh_start: ::Time?
91
+ },
92
+ ?sending_options: {
93
+ sending_enabled: bool?
94
+ },
95
+ ?tags: Array[
96
+ {
97
+ key: ::String,
98
+ value: ::String
99
+ },
100
+ ]
101
+ ) -> _CreateConfigurationSetResponseSuccess
102
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateConfigurationSetResponseSuccess
103
+
104
+ interface _CreateConfigurationSetEventDestinationResponseSuccess
105
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateConfigurationSetEventDestinationResponse]
106
+ end
107
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#create_configuration_set_event_destination-instance_method
108
+ def create_configuration_set_event_destination: (
109
+ configuration_set_name: ::String,
110
+ event_destination_name: ::String,
111
+ event_destination: {
112
+ enabled: bool?,
113
+ matching_event_types: Array[("SEND" | "REJECT" | "BOUNCE" | "COMPLAINT" | "DELIVERY" | "OPEN" | "CLICK" | "RENDERING_FAILURE")]?,
114
+ kinesis_firehose_destination: {
115
+ iam_role_arn: ::String,
116
+ delivery_stream_arn: ::String
117
+ }?,
118
+ cloud_watch_destination: {
119
+ dimension_configurations: Array[
120
+ {
121
+ dimension_name: ::String,
122
+ dimension_value_source: ("MESSAGE_TAG" | "EMAIL_HEADER" | "LINK_TAG"),
123
+ default_dimension_value: ::String
124
+ },
125
+ ]
126
+ }?,
127
+ sns_destination: {
128
+ topic_arn: ::String
129
+ }?,
130
+ pinpoint_destination: {
131
+ application_arn: ::String?
132
+ }?
133
+ }
134
+ ) -> _CreateConfigurationSetEventDestinationResponseSuccess
135
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateConfigurationSetEventDestinationResponseSuccess
136
+
137
+ interface _CreateDedicatedIpPoolResponseSuccess
138
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateDedicatedIpPoolResponse]
139
+ end
140
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#create_dedicated_ip_pool-instance_method
141
+ def create_dedicated_ip_pool: (
142
+ pool_name: ::String,
143
+ ?tags: Array[
144
+ {
145
+ key: ::String,
146
+ value: ::String
147
+ },
148
+ ]
149
+ ) -> _CreateDedicatedIpPoolResponseSuccess
150
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateDedicatedIpPoolResponseSuccess
151
+
152
+ interface _CreateDeliverabilityTestReportResponseSuccess
153
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateDeliverabilityTestReportResponse]
154
+ def report_id: () -> ::String
155
+ def deliverability_test_status: () -> ("IN_PROGRESS" | "COMPLETED")
156
+ end
157
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#create_deliverability_test_report-instance_method
158
+ def create_deliverability_test_report: (
159
+ ?report_name: ::String,
160
+ from_email_address: ::String,
161
+ content: {
162
+ simple: {
163
+ subject: {
164
+ data: ::String,
165
+ charset: ::String?
166
+ },
167
+ body: {
168
+ text: {
169
+ data: ::String,
170
+ charset: ::String?
171
+ }?,
172
+ html: {
173
+ data: ::String,
174
+ charset: ::String?
175
+ }?
176
+ }
177
+ }?,
178
+ raw: {
179
+ data: ::String
180
+ }?,
181
+ template: {
182
+ template_arn: ::String?,
183
+ template_data: ::String?
184
+ }?
185
+ },
186
+ ?tags: Array[
187
+ {
188
+ key: ::String,
189
+ value: ::String
190
+ },
191
+ ]
192
+ ) -> _CreateDeliverabilityTestReportResponseSuccess
193
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateDeliverabilityTestReportResponseSuccess
194
+
195
+ interface _CreateEmailIdentityResponseSuccess
196
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateEmailIdentityResponse]
197
+ def identity_type: () -> ("EMAIL_ADDRESS" | "DOMAIN" | "MANAGED_DOMAIN")
198
+ def verified_for_sending_status: () -> bool
199
+ def dkim_attributes: () -> Types::DkimAttributes
200
+ end
201
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#create_email_identity-instance_method
202
+ def create_email_identity: (
203
+ email_identity: ::String,
204
+ ?tags: Array[
205
+ {
206
+ key: ::String,
207
+ value: ::String
208
+ },
209
+ ]
210
+ ) -> _CreateEmailIdentityResponseSuccess
211
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateEmailIdentityResponseSuccess
212
+
213
+ interface _DeleteConfigurationSetResponseSuccess
214
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteConfigurationSetResponse]
215
+ end
216
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#delete_configuration_set-instance_method
217
+ def delete_configuration_set: (
218
+ configuration_set_name: ::String
219
+ ) -> _DeleteConfigurationSetResponseSuccess
220
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteConfigurationSetResponseSuccess
221
+
222
+ interface _DeleteConfigurationSetEventDestinationResponseSuccess
223
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteConfigurationSetEventDestinationResponse]
224
+ end
225
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#delete_configuration_set_event_destination-instance_method
226
+ def delete_configuration_set_event_destination: (
227
+ configuration_set_name: ::String,
228
+ event_destination_name: ::String
229
+ ) -> _DeleteConfigurationSetEventDestinationResponseSuccess
230
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteConfigurationSetEventDestinationResponseSuccess
231
+
232
+ interface _DeleteDedicatedIpPoolResponseSuccess
233
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteDedicatedIpPoolResponse]
234
+ end
235
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#delete_dedicated_ip_pool-instance_method
236
+ def delete_dedicated_ip_pool: (
237
+ pool_name: ::String
238
+ ) -> _DeleteDedicatedIpPoolResponseSuccess
239
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteDedicatedIpPoolResponseSuccess
240
+
241
+ interface _DeleteEmailIdentityResponseSuccess
242
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteEmailIdentityResponse]
243
+ end
244
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#delete_email_identity-instance_method
245
+ def delete_email_identity: (
246
+ email_identity: ::String
247
+ ) -> _DeleteEmailIdentityResponseSuccess
248
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteEmailIdentityResponseSuccess
249
+
250
+ interface _GetAccountResponseSuccess
251
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetAccountResponse]
252
+ def send_quota: () -> Types::SendQuota
253
+ def sending_enabled: () -> bool
254
+ def dedicated_ip_auto_warmup_enabled: () -> bool
255
+ def enforcement_status: () -> ::String
256
+ def production_access_enabled: () -> bool
257
+ end
258
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#get_account-instance_method
259
+ def get_account: (
260
+ ) -> _GetAccountResponseSuccess
261
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAccountResponseSuccess
262
+
263
+ interface _GetBlacklistReportsResponseSuccess
264
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetBlacklistReportsResponse]
265
+ def blacklist_report: () -> ::Hash[::String, ::Array[Types::BlacklistEntry]]
266
+ end
267
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#get_blacklist_reports-instance_method
268
+ def get_blacklist_reports: (
269
+ blacklist_item_names: Array[::String]
270
+ ) -> _GetBlacklistReportsResponseSuccess
271
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetBlacklistReportsResponseSuccess
272
+
273
+ interface _GetConfigurationSetResponseSuccess
274
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetConfigurationSetResponse]
275
+ def configuration_set_name: () -> ::String
276
+ def tracking_options: () -> Types::TrackingOptions
277
+ def delivery_options: () -> Types::DeliveryOptions
278
+ def reputation_options: () -> Types::ReputationOptions
279
+ def sending_options: () -> Types::SendingOptions
280
+ def tags: () -> ::Array[Types::Tag]
281
+ end
282
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#get_configuration_set-instance_method
283
+ def get_configuration_set: (
284
+ configuration_set_name: ::String
285
+ ) -> _GetConfigurationSetResponseSuccess
286
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetConfigurationSetResponseSuccess
287
+
288
+ interface _GetConfigurationSetEventDestinationsResponseSuccess
289
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetConfigurationSetEventDestinationsResponse]
290
+ def event_destinations: () -> ::Array[Types::EventDestination]
291
+ end
292
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#get_configuration_set_event_destinations-instance_method
293
+ def get_configuration_set_event_destinations: (
294
+ configuration_set_name: ::String
295
+ ) -> _GetConfigurationSetEventDestinationsResponseSuccess
296
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetConfigurationSetEventDestinationsResponseSuccess
297
+
298
+ interface _GetDedicatedIpResponseSuccess
299
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetDedicatedIpResponse]
300
+ def dedicated_ip: () -> Types::DedicatedIp
301
+ end
302
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#get_dedicated_ip-instance_method
303
+ def get_dedicated_ip: (
304
+ ip: ::String
305
+ ) -> _GetDedicatedIpResponseSuccess
306
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDedicatedIpResponseSuccess
307
+
308
+ interface _GetDedicatedIpsResponseSuccess
309
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetDedicatedIpsResponse]
310
+ def dedicated_ips: () -> ::Array[Types::DedicatedIp]
311
+ def next_token: () -> ::String
312
+ end
313
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#get_dedicated_ips-instance_method
314
+ def get_dedicated_ips: (
315
+ ?pool_name: ::String,
316
+ ?next_token: ::String,
317
+ ?page_size: ::Integer
318
+ ) -> _GetDedicatedIpsResponseSuccess
319
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDedicatedIpsResponseSuccess
320
+
321
+ interface _GetDeliverabilityDashboardOptionsResponseSuccess
322
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetDeliverabilityDashboardOptionsResponse]
323
+ def dashboard_enabled: () -> bool
324
+ def subscription_expiry_date: () -> ::Time
325
+ def account_status: () -> ("ACTIVE" | "PENDING_EXPIRATION" | "DISABLED")
326
+ def active_subscribed_domains: () -> ::Array[Types::DomainDeliverabilityTrackingOption]
327
+ def pending_expiration_subscribed_domains: () -> ::Array[Types::DomainDeliverabilityTrackingOption]
328
+ end
329
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#get_deliverability_dashboard_options-instance_method
330
+ def get_deliverability_dashboard_options: (
331
+ ) -> _GetDeliverabilityDashboardOptionsResponseSuccess
332
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDeliverabilityDashboardOptionsResponseSuccess
333
+
334
+ interface _GetDeliverabilityTestReportResponseSuccess
335
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetDeliverabilityTestReportResponse]
336
+ def deliverability_test_report: () -> Types::DeliverabilityTestReport
337
+ def overall_placement: () -> Types::PlacementStatistics
338
+ def isp_placements: () -> ::Array[Types::IspPlacement]
339
+ def message: () -> ::String
340
+ def tags: () -> ::Array[Types::Tag]
341
+ end
342
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#get_deliverability_test_report-instance_method
343
+ def get_deliverability_test_report: (
344
+ report_id: ::String
345
+ ) -> _GetDeliverabilityTestReportResponseSuccess
346
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDeliverabilityTestReportResponseSuccess
347
+
348
+ interface _GetDomainDeliverabilityCampaignResponseSuccess
349
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetDomainDeliverabilityCampaignResponse]
350
+ def domain_deliverability_campaign: () -> Types::DomainDeliverabilityCampaign
351
+ end
352
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#get_domain_deliverability_campaign-instance_method
353
+ def get_domain_deliverability_campaign: (
354
+ campaign_id: ::String
355
+ ) -> _GetDomainDeliverabilityCampaignResponseSuccess
356
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDomainDeliverabilityCampaignResponseSuccess
357
+
358
+ interface _GetDomainStatisticsReportResponseSuccess
359
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetDomainStatisticsReportResponse]
360
+ def overall_volume: () -> Types::OverallVolume
361
+ def daily_volumes: () -> ::Array[Types::DailyVolume]
362
+ end
363
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#get_domain_statistics_report-instance_method
364
+ def get_domain_statistics_report: (
365
+ domain: ::String,
366
+ start_date: ::Time,
367
+ end_date: ::Time
368
+ ) -> _GetDomainStatisticsReportResponseSuccess
369
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDomainStatisticsReportResponseSuccess
370
+
371
+ interface _GetEmailIdentityResponseSuccess
372
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetEmailIdentityResponse]
373
+ def identity_type: () -> ("EMAIL_ADDRESS" | "DOMAIN" | "MANAGED_DOMAIN")
374
+ def feedback_forwarding_status: () -> bool
375
+ def verified_for_sending_status: () -> bool
376
+ def dkim_attributes: () -> Types::DkimAttributes
377
+ def mail_from_attributes: () -> Types::MailFromAttributes
378
+ def tags: () -> ::Array[Types::Tag]
379
+ end
380
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#get_email_identity-instance_method
381
+ def get_email_identity: (
382
+ email_identity: ::String
383
+ ) -> _GetEmailIdentityResponseSuccess
384
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetEmailIdentityResponseSuccess
385
+
386
+ interface _ListConfigurationSetsResponseSuccess
387
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListConfigurationSetsResponse]
388
+ def configuration_sets: () -> ::Array[::String]
389
+ def next_token: () -> ::String
390
+ end
391
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#list_configuration_sets-instance_method
392
+ def list_configuration_sets: (
393
+ ?next_token: ::String,
394
+ ?page_size: ::Integer
395
+ ) -> _ListConfigurationSetsResponseSuccess
396
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListConfigurationSetsResponseSuccess
397
+
398
+ interface _ListDedicatedIpPoolsResponseSuccess
399
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListDedicatedIpPoolsResponse]
400
+ def dedicated_ip_pools: () -> ::Array[::String]
401
+ def next_token: () -> ::String
402
+ end
403
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#list_dedicated_ip_pools-instance_method
404
+ def list_dedicated_ip_pools: (
405
+ ?next_token: ::String,
406
+ ?page_size: ::Integer
407
+ ) -> _ListDedicatedIpPoolsResponseSuccess
408
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDedicatedIpPoolsResponseSuccess
409
+
410
+ interface _ListDeliverabilityTestReportsResponseSuccess
411
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListDeliverabilityTestReportsResponse]
412
+ def deliverability_test_reports: () -> ::Array[Types::DeliverabilityTestReport]
413
+ def next_token: () -> ::String
414
+ end
415
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#list_deliverability_test_reports-instance_method
416
+ def list_deliverability_test_reports: (
417
+ ?next_token: ::String,
418
+ ?page_size: ::Integer
419
+ ) -> _ListDeliverabilityTestReportsResponseSuccess
420
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDeliverabilityTestReportsResponseSuccess
421
+
422
+ interface _ListDomainDeliverabilityCampaignsResponseSuccess
423
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListDomainDeliverabilityCampaignsResponse]
424
+ def domain_deliverability_campaigns: () -> ::Array[Types::DomainDeliverabilityCampaign]
425
+ def next_token: () -> ::String
426
+ end
427
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#list_domain_deliverability_campaigns-instance_method
428
+ def list_domain_deliverability_campaigns: (
429
+ start_date: ::Time,
430
+ end_date: ::Time,
431
+ subscribed_domain: ::String,
432
+ ?next_token: ::String,
433
+ ?page_size: ::Integer
434
+ ) -> _ListDomainDeliverabilityCampaignsResponseSuccess
435
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDomainDeliverabilityCampaignsResponseSuccess
436
+
437
+ interface _ListEmailIdentitiesResponseSuccess
438
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListEmailIdentitiesResponse]
439
+ def email_identities: () -> ::Array[Types::IdentityInfo]
440
+ def next_token: () -> ::String
441
+ end
442
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#list_email_identities-instance_method
443
+ def list_email_identities: (
444
+ ?next_token: ::String,
445
+ ?page_size: ::Integer
446
+ ) -> _ListEmailIdentitiesResponseSuccess
447
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListEmailIdentitiesResponseSuccess
448
+
449
+ interface _ListTagsForResourceResponseSuccess
450
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
451
+ def tags: () -> ::Array[Types::Tag]
452
+ end
453
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#list_tags_for_resource-instance_method
454
+ def list_tags_for_resource: (
455
+ resource_arn: ::String
456
+ ) -> _ListTagsForResourceResponseSuccess
457
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
458
+
459
+ interface _PutAccountDedicatedIpWarmupAttributesResponseSuccess
460
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutAccountDedicatedIpWarmupAttributesResponse]
461
+ end
462
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#put_account_dedicated_ip_warmup_attributes-instance_method
463
+ def put_account_dedicated_ip_warmup_attributes: (
464
+ ?auto_warmup_enabled: bool
465
+ ) -> _PutAccountDedicatedIpWarmupAttributesResponseSuccess
466
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutAccountDedicatedIpWarmupAttributesResponseSuccess
467
+
468
+ interface _PutAccountSendingAttributesResponseSuccess
469
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutAccountSendingAttributesResponse]
470
+ end
471
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#put_account_sending_attributes-instance_method
472
+ def put_account_sending_attributes: (
473
+ ?sending_enabled: bool
474
+ ) -> _PutAccountSendingAttributesResponseSuccess
475
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutAccountSendingAttributesResponseSuccess
476
+
477
+ interface _PutConfigurationSetDeliveryOptionsResponseSuccess
478
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutConfigurationSetDeliveryOptionsResponse]
479
+ end
480
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#put_configuration_set_delivery_options-instance_method
481
+ def put_configuration_set_delivery_options: (
482
+ configuration_set_name: ::String,
483
+ ?tls_policy: ("REQUIRE" | "OPTIONAL"),
484
+ ?sending_pool_name: ::String
485
+ ) -> _PutConfigurationSetDeliveryOptionsResponseSuccess
486
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutConfigurationSetDeliveryOptionsResponseSuccess
487
+
488
+ interface _PutConfigurationSetReputationOptionsResponseSuccess
489
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutConfigurationSetReputationOptionsResponse]
490
+ end
491
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#put_configuration_set_reputation_options-instance_method
492
+ def put_configuration_set_reputation_options: (
493
+ configuration_set_name: ::String,
494
+ ?reputation_metrics_enabled: bool
495
+ ) -> _PutConfigurationSetReputationOptionsResponseSuccess
496
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutConfigurationSetReputationOptionsResponseSuccess
497
+
498
+ interface _PutConfigurationSetSendingOptionsResponseSuccess
499
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutConfigurationSetSendingOptionsResponse]
500
+ end
501
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#put_configuration_set_sending_options-instance_method
502
+ def put_configuration_set_sending_options: (
503
+ configuration_set_name: ::String,
504
+ ?sending_enabled: bool
505
+ ) -> _PutConfigurationSetSendingOptionsResponseSuccess
506
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutConfigurationSetSendingOptionsResponseSuccess
507
+
508
+ interface _PutConfigurationSetTrackingOptionsResponseSuccess
509
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutConfigurationSetTrackingOptionsResponse]
510
+ end
511
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#put_configuration_set_tracking_options-instance_method
512
+ def put_configuration_set_tracking_options: (
513
+ configuration_set_name: ::String,
514
+ ?custom_redirect_domain: ::String
515
+ ) -> _PutConfigurationSetTrackingOptionsResponseSuccess
516
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutConfigurationSetTrackingOptionsResponseSuccess
517
+
518
+ interface _PutDedicatedIpInPoolResponseSuccess
519
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutDedicatedIpInPoolResponse]
520
+ end
521
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#put_dedicated_ip_in_pool-instance_method
522
+ def put_dedicated_ip_in_pool: (
523
+ ip: ::String,
524
+ destination_pool_name: ::String
525
+ ) -> _PutDedicatedIpInPoolResponseSuccess
526
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutDedicatedIpInPoolResponseSuccess
527
+
528
+ interface _PutDedicatedIpWarmupAttributesResponseSuccess
529
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutDedicatedIpWarmupAttributesResponse]
530
+ end
531
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#put_dedicated_ip_warmup_attributes-instance_method
532
+ def put_dedicated_ip_warmup_attributes: (
533
+ ip: ::String,
534
+ warmup_percentage: ::Integer
535
+ ) -> _PutDedicatedIpWarmupAttributesResponseSuccess
536
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutDedicatedIpWarmupAttributesResponseSuccess
537
+
538
+ interface _PutDeliverabilityDashboardOptionResponseSuccess
539
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutDeliverabilityDashboardOptionResponse]
540
+ end
541
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#put_deliverability_dashboard_option-instance_method
542
+ def put_deliverability_dashboard_option: (
543
+ dashboard_enabled: bool,
544
+ ?subscribed_domains: Array[
545
+ {
546
+ domain: ::String?,
547
+ subscription_start_date: ::Time?,
548
+ inbox_placement_tracking_option: {
549
+ global: bool?,
550
+ tracked_isps: Array[::String]?
551
+ }?
552
+ },
553
+ ]
554
+ ) -> _PutDeliverabilityDashboardOptionResponseSuccess
555
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutDeliverabilityDashboardOptionResponseSuccess
556
+
557
+ interface _PutEmailIdentityDkimAttributesResponseSuccess
558
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutEmailIdentityDkimAttributesResponse]
559
+ end
560
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#put_email_identity_dkim_attributes-instance_method
561
+ def put_email_identity_dkim_attributes: (
562
+ email_identity: ::String,
563
+ ?signing_enabled: bool
564
+ ) -> _PutEmailIdentityDkimAttributesResponseSuccess
565
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutEmailIdentityDkimAttributesResponseSuccess
566
+
567
+ interface _PutEmailIdentityFeedbackAttributesResponseSuccess
568
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutEmailIdentityFeedbackAttributesResponse]
569
+ end
570
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#put_email_identity_feedback_attributes-instance_method
571
+ def put_email_identity_feedback_attributes: (
572
+ email_identity: ::String,
573
+ ?email_forwarding_enabled: bool
574
+ ) -> _PutEmailIdentityFeedbackAttributesResponseSuccess
575
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutEmailIdentityFeedbackAttributesResponseSuccess
576
+
577
+ interface _PutEmailIdentityMailFromAttributesResponseSuccess
578
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutEmailIdentityMailFromAttributesResponse]
579
+ end
580
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#put_email_identity_mail_from_attributes-instance_method
581
+ def put_email_identity_mail_from_attributes: (
582
+ email_identity: ::String,
583
+ ?mail_from_domain: ::String,
584
+ ?behavior_on_mx_failure: ("USE_DEFAULT_VALUE" | "REJECT_MESSAGE")
585
+ ) -> _PutEmailIdentityMailFromAttributesResponseSuccess
586
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutEmailIdentityMailFromAttributesResponseSuccess
587
+
588
+ interface _SendEmailResponseSuccess
589
+ include ::Seahorse::Client::_ResponseSuccess[Types::SendEmailResponse]
590
+ def message_id: () -> ::String
591
+ end
592
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#send_email-instance_method
593
+ def send_email: (
594
+ ?from_email_address: ::String,
595
+ destination: {
596
+ to_addresses: Array[::String]?,
597
+ cc_addresses: Array[::String]?,
598
+ bcc_addresses: Array[::String]?
599
+ },
600
+ ?reply_to_addresses: Array[::String],
601
+ ?feedback_forwarding_email_address: ::String,
602
+ content: {
603
+ simple: {
604
+ subject: {
605
+ data: ::String,
606
+ charset: ::String?
607
+ },
608
+ body: {
609
+ text: {
610
+ data: ::String,
611
+ charset: ::String?
612
+ }?,
613
+ html: {
614
+ data: ::String,
615
+ charset: ::String?
616
+ }?
617
+ }
618
+ }?,
619
+ raw: {
620
+ data: ::String
621
+ }?,
622
+ template: {
623
+ template_arn: ::String?,
624
+ template_data: ::String?
625
+ }?
626
+ },
627
+ ?email_tags: Array[
628
+ {
629
+ name: ::String,
630
+ value: ::String
631
+ },
632
+ ],
633
+ ?configuration_set_name: ::String
634
+ ) -> _SendEmailResponseSuccess
635
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendEmailResponseSuccess
636
+
637
+ interface _TagResourceResponseSuccess
638
+ include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
639
+ end
640
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#tag_resource-instance_method
641
+ def tag_resource: (
642
+ resource_arn: ::String,
643
+ tags: Array[
644
+ {
645
+ key: ::String,
646
+ value: ::String
647
+ },
648
+ ]
649
+ ) -> _TagResourceResponseSuccess
650
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
651
+
652
+ interface _UntagResourceResponseSuccess
653
+ include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
654
+ end
655
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#untag_resource-instance_method
656
+ def untag_resource: (
657
+ resource_arn: ::String,
658
+ tag_keys: Array[::String]
659
+ ) -> _UntagResourceResponseSuccess
660
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
661
+
662
+ interface _UpdateConfigurationSetEventDestinationResponseSuccess
663
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateConfigurationSetEventDestinationResponse]
664
+ end
665
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointEmail/Client.html#update_configuration_set_event_destination-instance_method
666
+ def update_configuration_set_event_destination: (
667
+ configuration_set_name: ::String,
668
+ event_destination_name: ::String,
669
+ event_destination: {
670
+ enabled: bool?,
671
+ matching_event_types: Array[("SEND" | "REJECT" | "BOUNCE" | "COMPLAINT" | "DELIVERY" | "OPEN" | "CLICK" | "RENDERING_FAILURE")]?,
672
+ kinesis_firehose_destination: {
673
+ iam_role_arn: ::String,
674
+ delivery_stream_arn: ::String
675
+ }?,
676
+ cloud_watch_destination: {
677
+ dimension_configurations: Array[
678
+ {
679
+ dimension_name: ::String,
680
+ dimension_value_source: ("MESSAGE_TAG" | "EMAIL_HEADER" | "LINK_TAG"),
681
+ default_dimension_value: ::String
682
+ },
683
+ ]
684
+ }?,
685
+ sns_destination: {
686
+ topic_arn: ::String
687
+ }?,
688
+ pinpoint_destination: {
689
+ application_arn: ::String?
690
+ }?
691
+ }
692
+ ) -> _UpdateConfigurationSetEventDestinationResponseSuccess
693
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateConfigurationSetEventDestinationResponseSuccess
694
+ end
695
+ end
696
+ end
697
+