aws-sdk-pinpoint 1.35.0 → 1.40.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-pinpoint.rb +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +151 -18
- data/lib/aws-sdk-pinpoint/client_api.rb +19 -0
- data/lib/aws-sdk-pinpoint/errors.rb +4 -15
- data/lib/aws-sdk-pinpoint/resource.rb +1 -7
- data/lib/aws-sdk-pinpoint/types.rb +339 -169
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 8cb8e4aee8ac2338f70c5cc0374ec5074cce60b7dbff3fa8e95fdec83a944a45
|
4
|
+
data.tar.gz: 85a346dd6d818a880195a5da5d1d644909d67ea59964e9d23f8b69023b6333b3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e1d9e3372693fa62e776493f879b4053200b2ac98ad636aa9b559e90f9a10aa26fcc60a0caf335e02f8a913a8fa443ed4aab1af906faeeb057301450056a06e5
|
7
|
+
data.tar.gz: afd5ab8d7193b1f1e6f4a1fd27d33c2973c8f63d08a7beaced42d913e9253ec8e1336d82794af07f96ce216723b88db7dfe039c57d7361c5b1757e0b294bc443
|
data/lib/aws-sdk-pinpoint.rb
CHANGED
@@ -30,14 +30,16 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:pinpoint)
|
31
31
|
|
32
32
|
module Aws::Pinpoint
|
33
|
-
# An API client for Pinpoint. To construct a client, you need to configure a
|
33
|
+
# An API client for Pinpoint. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
34
35
|
# client = Aws::Pinpoint::Client.new(
|
35
36
|
# region: region_name,
|
36
37
|
# credentials: credentials,
|
37
38
|
# # ...
|
38
39
|
# )
|
40
|
+
#
|
39
41
|
# For details on configuring region and credentials see
|
40
|
-
# the
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
41
43
|
#
|
42
44
|
# See {#initialize} for a full list of supported configuration options.
|
43
45
|
class Client < Seahorse::Client::Base
|
@@ -103,7 +105,7 @@ module Aws::Pinpoint
|
|
103
105
|
# @option options [required, String] :region
|
104
106
|
# The AWS region to connect to. The configured `:region` is
|
105
107
|
# used to determine the service `:endpoint`. When not passed,
|
106
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
107
109
|
#
|
108
110
|
# * `Aws.config[:region]`
|
109
111
|
# * `ENV['AWS_REGION']`
|
@@ -118,6 +120,12 @@ module Aws::Pinpoint
|
|
118
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
119
121
|
# the background every 60 secs (default). Defaults to `false`.
|
120
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
121
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
122
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
123
131
|
# this client.
|
@@ -142,6 +150,10 @@ module Aws::Pinpoint
|
|
142
150
|
# When `true`, an attempt is made to coerce request parameters into
|
143
151
|
# the required types.
|
144
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
145
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
146
158
|
# Set to true to disable SDK automatically adding host prefix
|
147
159
|
# to default service endpoint when available.
|
@@ -149,7 +161,7 @@ module Aws::Pinpoint
|
|
149
161
|
# @option options [String] :endpoint
|
150
162
|
# The client endpoint is normally constructed from the `:region`
|
151
163
|
# option. You should only configure an `:endpoint` when connecting
|
152
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
153
165
|
#
|
154
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
155
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -164,7 +176,7 @@ module Aws::Pinpoint
|
|
164
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
165
177
|
#
|
166
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
167
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
168
180
|
#
|
169
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
170
182
|
# The log formatter.
|
@@ -176,15 +188,29 @@ module Aws::Pinpoint
|
|
176
188
|
# The Logger instance to send log messages to. If this option
|
177
189
|
# is not set, logging will be disabled.
|
178
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
179
197
|
# @option options [String] :profile ("default")
|
180
198
|
# Used when loading credentials from the shared credentials file
|
181
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
182
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
183
205
|
# @option options [Float] :retry_base_delay (0.3)
|
184
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
185
208
|
#
|
186
209
|
# @option options [Symbol] :retry_jitter (:none)
|
187
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
188
214
|
#
|
189
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
190
216
|
#
|
@@ -192,11 +218,30 @@ module Aws::Pinpoint
|
|
192
218
|
# The maximum number of times to retry failed requests. Only
|
193
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
194
220
|
# are retried. Generally, these are throttling errors, data
|
195
|
-
# checksum errors, networking errors, timeout errors
|
196
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
197
224
|
#
|
198
225
|
# @option options [Integer] :retry_max_delay (0)
|
199
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
200
245
|
#
|
201
246
|
# @option options [String] :secret_access_key
|
202
247
|
#
|
@@ -224,8 +269,7 @@ module Aws::Pinpoint
|
|
224
269
|
#
|
225
270
|
# @option options [Integer] :http_read_timeout (60) The default
|
226
271
|
# number of seconds to wait for response data. This value can
|
227
|
-
# safely be set
|
228
|
-
# per-request on the session yielded by {#session_for}.
|
272
|
+
# safely be set per-request on the session.
|
229
273
|
#
|
230
274
|
# @option options [Float] :http_idle_timeout (5) The number of
|
231
275
|
# seconds a connection is allowed to sit idle before it is
|
@@ -237,7 +281,7 @@ module Aws::Pinpoint
|
|
237
281
|
# request body. This option has no effect unless the request has
|
238
282
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
239
283
|
# disables this behaviour. This value can safely be set per
|
240
|
-
# request on the session
|
284
|
+
# request on the session.
|
241
285
|
#
|
242
286
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
243
287
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -321,6 +365,10 @@ module Aws::Pinpoint
|
|
321
365
|
# write_campaign_request: { # required
|
322
366
|
# additional_treatments: [
|
323
367
|
# {
|
368
|
+
# custom_delivery_configuration: {
|
369
|
+
# delivery_uri: "__string", # required
|
370
|
+
# endpoint_types: ["GCM"], # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
|
371
|
+
# },
|
324
372
|
# message_configuration: {
|
325
373
|
# adm_message: {
|
326
374
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -364,6 +412,9 @@ module Aws::Pinpoint
|
|
364
412
|
# title: "__string",
|
365
413
|
# url: "__string",
|
366
414
|
# },
|
415
|
+
# custom_message: {
|
416
|
+
# data: "__string",
|
417
|
+
# },
|
367
418
|
# default_message: {
|
368
419
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
369
420
|
# body: "__string",
|
@@ -459,6 +510,10 @@ module Aws::Pinpoint
|
|
459
510
|
# treatment_name: "__string",
|
460
511
|
# },
|
461
512
|
# ],
|
513
|
+
# custom_delivery_configuration: {
|
514
|
+
# delivery_uri: "__string", # required
|
515
|
+
# endpoint_types: ["GCM"], # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
|
516
|
+
# },
|
462
517
|
# description: "__string",
|
463
518
|
# holdout_percent: 1,
|
464
519
|
# hook: {
|
@@ -516,6 +571,9 @@ module Aws::Pinpoint
|
|
516
571
|
# title: "__string",
|
517
572
|
# url: "__string",
|
518
573
|
# },
|
574
|
+
# custom_message: {
|
575
|
+
# data: "__string",
|
576
|
+
# },
|
519
577
|
# default_message: {
|
520
578
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
521
579
|
# body: "__string",
|
@@ -620,6 +678,9 @@ module Aws::Pinpoint
|
|
620
678
|
# @example Response structure
|
621
679
|
#
|
622
680
|
# resp.campaign_response.additional_treatments #=> Array
|
681
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.delivery_uri #=> String
|
682
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
|
683
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
623
684
|
# resp.campaign_response.additional_treatments[0].id #=> String
|
624
685
|
# resp.campaign_response.additional_treatments[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
625
686
|
# resp.campaign_response.additional_treatments[0].message_configuration.adm_message.body #=> String
|
@@ -657,6 +718,7 @@ module Aws::Pinpoint
|
|
657
718
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.time_to_live #=> Integer
|
658
719
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.title #=> String
|
659
720
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.url #=> String
|
721
|
+
# resp.campaign_response.additional_treatments[0].message_configuration.custom_message.data #=> String
|
660
722
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
661
723
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
|
662
724
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
|
@@ -721,6 +783,9 @@ module Aws::Pinpoint
|
|
721
783
|
# resp.campaign_response.application_id #=> String
|
722
784
|
# resp.campaign_response.arn #=> String
|
723
785
|
# resp.campaign_response.creation_date #=> String
|
786
|
+
# resp.campaign_response.custom_delivery_configuration.delivery_uri #=> String
|
787
|
+
# resp.campaign_response.custom_delivery_configuration.endpoint_types #=> Array
|
788
|
+
# resp.campaign_response.custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
724
789
|
# resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
725
790
|
# resp.campaign_response.description #=> String
|
726
791
|
# resp.campaign_response.holdout_percent #=> Integer
|
@@ -770,6 +835,7 @@ module Aws::Pinpoint
|
|
770
835
|
# resp.campaign_response.message_configuration.baidu_message.time_to_live #=> Integer
|
771
836
|
# resp.campaign_response.message_configuration.baidu_message.title #=> String
|
772
837
|
# resp.campaign_response.message_configuration.baidu_message.url #=> String
|
838
|
+
# resp.campaign_response.message_configuration.custom_message.data #=> String
|
773
839
|
# resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
774
840
|
# resp.campaign_response.message_configuration.default_message.body #=> String
|
775
841
|
# resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
|
@@ -2244,6 +2310,9 @@ module Aws::Pinpoint
|
|
2244
2310
|
# @example Response structure
|
2245
2311
|
#
|
2246
2312
|
# resp.campaign_response.additional_treatments #=> Array
|
2313
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.delivery_uri #=> String
|
2314
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
|
2315
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
2247
2316
|
# resp.campaign_response.additional_treatments[0].id #=> String
|
2248
2317
|
# resp.campaign_response.additional_treatments[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
2249
2318
|
# resp.campaign_response.additional_treatments[0].message_configuration.adm_message.body #=> String
|
@@ -2281,6 +2350,7 @@ module Aws::Pinpoint
|
|
2281
2350
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.time_to_live #=> Integer
|
2282
2351
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.title #=> String
|
2283
2352
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.url #=> String
|
2353
|
+
# resp.campaign_response.additional_treatments[0].message_configuration.custom_message.data #=> String
|
2284
2354
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
2285
2355
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
|
2286
2356
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
|
@@ -2345,6 +2415,9 @@ module Aws::Pinpoint
|
|
2345
2415
|
# resp.campaign_response.application_id #=> String
|
2346
2416
|
# resp.campaign_response.arn #=> String
|
2347
2417
|
# resp.campaign_response.creation_date #=> String
|
2418
|
+
# resp.campaign_response.custom_delivery_configuration.delivery_uri #=> String
|
2419
|
+
# resp.campaign_response.custom_delivery_configuration.endpoint_types #=> Array
|
2420
|
+
# resp.campaign_response.custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
2348
2421
|
# resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
2349
2422
|
# resp.campaign_response.description #=> String
|
2350
2423
|
# resp.campaign_response.holdout_percent #=> Integer
|
@@ -2394,6 +2467,7 @@ module Aws::Pinpoint
|
|
2394
2467
|
# resp.campaign_response.message_configuration.baidu_message.time_to_live #=> Integer
|
2395
2468
|
# resp.campaign_response.message_configuration.baidu_message.title #=> String
|
2396
2469
|
# resp.campaign_response.message_configuration.baidu_message.url #=> String
|
2470
|
+
# resp.campaign_response.message_configuration.custom_message.data #=> String
|
2397
2471
|
# resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
2398
2472
|
# resp.campaign_response.message_configuration.default_message.body #=> String
|
2399
2473
|
# resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
|
@@ -3666,6 +3740,9 @@ module Aws::Pinpoint
|
|
3666
3740
|
# @example Response structure
|
3667
3741
|
#
|
3668
3742
|
# resp.campaign_response.additional_treatments #=> Array
|
3743
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.delivery_uri #=> String
|
3744
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
|
3745
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
3669
3746
|
# resp.campaign_response.additional_treatments[0].id #=> String
|
3670
3747
|
# resp.campaign_response.additional_treatments[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
3671
3748
|
# resp.campaign_response.additional_treatments[0].message_configuration.adm_message.body #=> String
|
@@ -3703,6 +3780,7 @@ module Aws::Pinpoint
|
|
3703
3780
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.time_to_live #=> Integer
|
3704
3781
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.title #=> String
|
3705
3782
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.url #=> String
|
3783
|
+
# resp.campaign_response.additional_treatments[0].message_configuration.custom_message.data #=> String
|
3706
3784
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
3707
3785
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
|
3708
3786
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
|
@@ -3767,6 +3845,9 @@ module Aws::Pinpoint
|
|
3767
3845
|
# resp.campaign_response.application_id #=> String
|
3768
3846
|
# resp.campaign_response.arn #=> String
|
3769
3847
|
# resp.campaign_response.creation_date #=> String
|
3848
|
+
# resp.campaign_response.custom_delivery_configuration.delivery_uri #=> String
|
3849
|
+
# resp.campaign_response.custom_delivery_configuration.endpoint_types #=> Array
|
3850
|
+
# resp.campaign_response.custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
3770
3851
|
# resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
3771
3852
|
# resp.campaign_response.description #=> String
|
3772
3853
|
# resp.campaign_response.holdout_percent #=> Integer
|
@@ -3816,6 +3897,7 @@ module Aws::Pinpoint
|
|
3816
3897
|
# resp.campaign_response.message_configuration.baidu_message.time_to_live #=> Integer
|
3817
3898
|
# resp.campaign_response.message_configuration.baidu_message.title #=> String
|
3818
3899
|
# resp.campaign_response.message_configuration.baidu_message.url #=> String
|
3900
|
+
# resp.campaign_response.message_configuration.custom_message.data #=> String
|
3819
3901
|
# resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
3820
3902
|
# resp.campaign_response.message_configuration.default_message.body #=> String
|
3821
3903
|
# resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
|
@@ -4026,6 +4108,9 @@ module Aws::Pinpoint
|
|
4026
4108
|
# @example Response structure
|
4027
4109
|
#
|
4028
4110
|
# resp.campaign_response.additional_treatments #=> Array
|
4111
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.delivery_uri #=> String
|
4112
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
|
4113
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
4029
4114
|
# resp.campaign_response.additional_treatments[0].id #=> String
|
4030
4115
|
# resp.campaign_response.additional_treatments[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4031
4116
|
# resp.campaign_response.additional_treatments[0].message_configuration.adm_message.body #=> String
|
@@ -4063,6 +4148,7 @@ module Aws::Pinpoint
|
|
4063
4148
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.time_to_live #=> Integer
|
4064
4149
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.title #=> String
|
4065
4150
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.url #=> String
|
4151
|
+
# resp.campaign_response.additional_treatments[0].message_configuration.custom_message.data #=> String
|
4066
4152
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4067
4153
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
|
4068
4154
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
|
@@ -4127,6 +4213,9 @@ module Aws::Pinpoint
|
|
4127
4213
|
# resp.campaign_response.application_id #=> String
|
4128
4214
|
# resp.campaign_response.arn #=> String
|
4129
4215
|
# resp.campaign_response.creation_date #=> String
|
4216
|
+
# resp.campaign_response.custom_delivery_configuration.delivery_uri #=> String
|
4217
|
+
# resp.campaign_response.custom_delivery_configuration.endpoint_types #=> Array
|
4218
|
+
# resp.campaign_response.custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
4130
4219
|
# resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
4131
4220
|
# resp.campaign_response.description #=> String
|
4132
4221
|
# resp.campaign_response.holdout_percent #=> Integer
|
@@ -4176,6 +4265,7 @@ module Aws::Pinpoint
|
|
4176
4265
|
# resp.campaign_response.message_configuration.baidu_message.time_to_live #=> Integer
|
4177
4266
|
# resp.campaign_response.message_configuration.baidu_message.title #=> String
|
4178
4267
|
# resp.campaign_response.message_configuration.baidu_message.url #=> String
|
4268
|
+
# resp.campaign_response.message_configuration.custom_message.data #=> String
|
4179
4269
|
# resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4180
4270
|
# resp.campaign_response.message_configuration.default_message.body #=> String
|
4181
4271
|
# resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
|
@@ -4280,6 +4370,9 @@ module Aws::Pinpoint
|
|
4280
4370
|
#
|
4281
4371
|
# resp.campaigns_response.item #=> Array
|
4282
4372
|
# resp.campaigns_response.item[0].additional_treatments #=> Array
|
4373
|
+
# resp.campaigns_response.item[0].additional_treatments[0].custom_delivery_configuration.delivery_uri #=> String
|
4374
|
+
# resp.campaigns_response.item[0].additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
|
4375
|
+
# resp.campaigns_response.item[0].additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
4283
4376
|
# resp.campaigns_response.item[0].additional_treatments[0].id #=> String
|
4284
4377
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4285
4378
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.body #=> String
|
@@ -4317,6 +4410,7 @@ module Aws::Pinpoint
|
|
4317
4410
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.time_to_live #=> Integer
|
4318
4411
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.title #=> String
|
4319
4412
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.url #=> String
|
4413
|
+
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.custom_message.data #=> String
|
4320
4414
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4321
4415
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.body #=> String
|
4322
4416
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
|
@@ -4381,6 +4475,9 @@ module Aws::Pinpoint
|
|
4381
4475
|
# resp.campaigns_response.item[0].application_id #=> String
|
4382
4476
|
# resp.campaigns_response.item[0].arn #=> String
|
4383
4477
|
# resp.campaigns_response.item[0].creation_date #=> String
|
4478
|
+
# resp.campaigns_response.item[0].custom_delivery_configuration.delivery_uri #=> String
|
4479
|
+
# resp.campaigns_response.item[0].custom_delivery_configuration.endpoint_types #=> Array
|
4480
|
+
# resp.campaigns_response.item[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
4384
4481
|
# resp.campaigns_response.item[0].default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
4385
4482
|
# resp.campaigns_response.item[0].description #=> String
|
4386
4483
|
# resp.campaigns_response.item[0].holdout_percent #=> Integer
|
@@ -4430,6 +4527,7 @@ module Aws::Pinpoint
|
|
4430
4527
|
# resp.campaigns_response.item[0].message_configuration.baidu_message.time_to_live #=> Integer
|
4431
4528
|
# resp.campaigns_response.item[0].message_configuration.baidu_message.title #=> String
|
4432
4529
|
# resp.campaigns_response.item[0].message_configuration.baidu_message.url #=> String
|
4530
|
+
# resp.campaigns_response.item[0].message_configuration.custom_message.data #=> String
|
4433
4531
|
# resp.campaigns_response.item[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4434
4532
|
# resp.campaigns_response.item[0].message_configuration.default_message.body #=> String
|
4435
4533
|
# resp.campaigns_response.item[0].message_configuration.default_message.image_icon_url #=> String
|
@@ -4533,6 +4631,9 @@ module Aws::Pinpoint
|
|
4533
4631
|
#
|
4534
4632
|
# resp.campaigns_response.item #=> Array
|
4535
4633
|
# resp.campaigns_response.item[0].additional_treatments #=> Array
|
4634
|
+
# resp.campaigns_response.item[0].additional_treatments[0].custom_delivery_configuration.delivery_uri #=> String
|
4635
|
+
# resp.campaigns_response.item[0].additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
|
4636
|
+
# resp.campaigns_response.item[0].additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
4536
4637
|
# resp.campaigns_response.item[0].additional_treatments[0].id #=> String
|
4537
4638
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4538
4639
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.adm_message.body #=> String
|
@@ -4570,6 +4671,7 @@ module Aws::Pinpoint
|
|
4570
4671
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.time_to_live #=> Integer
|
4571
4672
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.title #=> String
|
4572
4673
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.baidu_message.url #=> String
|
4674
|
+
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.custom_message.data #=> String
|
4573
4675
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4574
4676
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.body #=> String
|
4575
4677
|
# resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
|
@@ -4634,6 +4736,9 @@ module Aws::Pinpoint
|
|
4634
4736
|
# resp.campaigns_response.item[0].application_id #=> String
|
4635
4737
|
# resp.campaigns_response.item[0].arn #=> String
|
4636
4738
|
# resp.campaigns_response.item[0].creation_date #=> String
|
4739
|
+
# resp.campaigns_response.item[0].custom_delivery_configuration.delivery_uri #=> String
|
4740
|
+
# resp.campaigns_response.item[0].custom_delivery_configuration.endpoint_types #=> Array
|
4741
|
+
# resp.campaigns_response.item[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
4637
4742
|
# resp.campaigns_response.item[0].default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
4638
4743
|
# resp.campaigns_response.item[0].description #=> String
|
4639
4744
|
# resp.campaigns_response.item[0].holdout_percent #=> Integer
|
@@ -4683,6 +4788,7 @@ module Aws::Pinpoint
|
|
4683
4788
|
# resp.campaigns_response.item[0].message_configuration.baidu_message.time_to_live #=> Integer
|
4684
4789
|
# resp.campaigns_response.item[0].message_configuration.baidu_message.title #=> String
|
4685
4790
|
# resp.campaigns_response.item[0].message_configuration.baidu_message.url #=> String
|
4791
|
+
# resp.campaigns_response.item[0].message_configuration.custom_message.data #=> String
|
4686
4792
|
# resp.campaigns_response.item[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
4687
4793
|
# resp.campaigns_response.item[0].message_configuration.default_message.body #=> String
|
4688
4794
|
# resp.campaigns_response.item[0].message_configuration.default_message.image_icon_url #=> String
|
@@ -7302,6 +7408,7 @@ module Aws::Pinpoint
|
|
7302
7408
|
# sms_message: {
|
7303
7409
|
# body: "__string",
|
7304
7410
|
# keyword: "__string",
|
7411
|
+
# media_url: "__string",
|
7305
7412
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
7306
7413
|
# origination_number: "__string",
|
7307
7414
|
# sender_id: "__string",
|
@@ -7526,6 +7633,7 @@ module Aws::Pinpoint
|
|
7526
7633
|
# sms_message: {
|
7527
7634
|
# body: "__string",
|
7528
7635
|
# keyword: "__string",
|
7636
|
+
# media_url: "__string",
|
7529
7637
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
7530
7638
|
# origination_number: "__string",
|
7531
7639
|
# sender_id: "__string",
|
@@ -8041,6 +8149,10 @@ module Aws::Pinpoint
|
|
8041
8149
|
# write_campaign_request: { # required
|
8042
8150
|
# additional_treatments: [
|
8043
8151
|
# {
|
8152
|
+
# custom_delivery_configuration: {
|
8153
|
+
# delivery_uri: "__string", # required
|
8154
|
+
# endpoint_types: ["GCM"], # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
|
8155
|
+
# },
|
8044
8156
|
# message_configuration: {
|
8045
8157
|
# adm_message: {
|
8046
8158
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -8084,6 +8196,9 @@ module Aws::Pinpoint
|
|
8084
8196
|
# title: "__string",
|
8085
8197
|
# url: "__string",
|
8086
8198
|
# },
|
8199
|
+
# custom_message: {
|
8200
|
+
# data: "__string",
|
8201
|
+
# },
|
8087
8202
|
# default_message: {
|
8088
8203
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
8089
8204
|
# body: "__string",
|
@@ -8179,6 +8294,10 @@ module Aws::Pinpoint
|
|
8179
8294
|
# treatment_name: "__string",
|
8180
8295
|
# },
|
8181
8296
|
# ],
|
8297
|
+
# custom_delivery_configuration: {
|
8298
|
+
# delivery_uri: "__string", # required
|
8299
|
+
# endpoint_types: ["GCM"], # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
|
8300
|
+
# },
|
8182
8301
|
# description: "__string",
|
8183
8302
|
# holdout_percent: 1,
|
8184
8303
|
# hook: {
|
@@ -8236,6 +8355,9 @@ module Aws::Pinpoint
|
|
8236
8355
|
# title: "__string",
|
8237
8356
|
# url: "__string",
|
8238
8357
|
# },
|
8358
|
+
# custom_message: {
|
8359
|
+
# data: "__string",
|
8360
|
+
# },
|
8239
8361
|
# default_message: {
|
8240
8362
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
8241
8363
|
# body: "__string",
|
@@ -8340,6 +8462,9 @@ module Aws::Pinpoint
|
|
8340
8462
|
# @example Response structure
|
8341
8463
|
#
|
8342
8464
|
# resp.campaign_response.additional_treatments #=> Array
|
8465
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.delivery_uri #=> String
|
8466
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types #=> Array
|
8467
|
+
# resp.campaign_response.additional_treatments[0].custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
8343
8468
|
# resp.campaign_response.additional_treatments[0].id #=> String
|
8344
8469
|
# resp.campaign_response.additional_treatments[0].message_configuration.adm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
8345
8470
|
# resp.campaign_response.additional_treatments[0].message_configuration.adm_message.body #=> String
|
@@ -8377,6 +8502,7 @@ module Aws::Pinpoint
|
|
8377
8502
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.time_to_live #=> Integer
|
8378
8503
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.title #=> String
|
8379
8504
|
# resp.campaign_response.additional_treatments[0].message_configuration.baidu_message.url #=> String
|
8505
|
+
# resp.campaign_response.additional_treatments[0].message_configuration.custom_message.data #=> String
|
8380
8506
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
8381
8507
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
|
8382
8508
|
# resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
|
@@ -8441,6 +8567,9 @@ module Aws::Pinpoint
|
|
8441
8567
|
# resp.campaign_response.application_id #=> String
|
8442
8568
|
# resp.campaign_response.arn #=> String
|
8443
8569
|
# resp.campaign_response.creation_date #=> String
|
8570
|
+
# resp.campaign_response.custom_delivery_configuration.delivery_uri #=> String
|
8571
|
+
# resp.campaign_response.custom_delivery_configuration.endpoint_types #=> Array
|
8572
|
+
# resp.campaign_response.custom_delivery_configuration.endpoint_types[0] #=> String, one of "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "VOICE", "EMAIL", "BAIDU", "CUSTOM"
|
8444
8573
|
# resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED"
|
8445
8574
|
# resp.campaign_response.description #=> String
|
8446
8575
|
# resp.campaign_response.holdout_percent #=> Integer
|
@@ -8490,6 +8619,7 @@ module Aws::Pinpoint
|
|
8490
8619
|
# resp.campaign_response.message_configuration.baidu_message.time_to_live #=> Integer
|
8491
8620
|
# resp.campaign_response.message_configuration.baidu_message.title #=> String
|
8492
8621
|
# resp.campaign_response.message_configuration.baidu_message.url #=> String
|
8622
|
+
# resp.campaign_response.message_configuration.custom_message.data #=> String
|
8493
8623
|
# resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
|
8494
8624
|
# resp.campaign_response.message_configuration.default_message.body #=> String
|
8495
8625
|
# resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
|
@@ -8671,8 +8801,10 @@ module Aws::Pinpoint
|
|
8671
8801
|
|
8672
8802
|
# Creates a new endpoint for an application or updates the settings and
|
8673
8803
|
# attributes of an existing endpoint for an application. You can also
|
8674
|
-
# use this operation to define custom attributes
|
8675
|
-
#
|
8804
|
+
# use this operation to define custom attributes for an endpoint. If an
|
8805
|
+
# update includes one or more values for a custom attribute, Amazon
|
8806
|
+
# Pinpoint replaces (overwrites) any existing values with the new
|
8807
|
+
# values.
|
8676
8808
|
#
|
8677
8809
|
# @option params [required, String] :application_id
|
8678
8810
|
#
|
@@ -8747,8 +8879,9 @@ module Aws::Pinpoint
|
|
8747
8879
|
# Creates a new batch of endpoints for an application or updates the
|
8748
8880
|
# settings and attributes of a batch of existing endpoints for an
|
8749
8881
|
# application. You can also use this operation to define custom
|
8750
|
-
# attributes
|
8751
|
-
#
|
8882
|
+
# attributes for a batch of endpoints. If an update includes one or more
|
8883
|
+
# values for a custom attribute, Amazon Pinpoint replaces (overwrites)
|
8884
|
+
# any existing values with the new values.
|
8752
8885
|
#
|
8753
8886
|
# @option params [required, String] :application_id
|
8754
8887
|
#
|
@@ -10177,7 +10310,7 @@ module Aws::Pinpoint
|
|
10177
10310
|
params: params,
|
10178
10311
|
config: config)
|
10179
10312
|
context[:gem_name] = 'aws-sdk-pinpoint'
|
10180
|
-
context[:gem_version] = '1.
|
10313
|
+
context[:gem_version] = '1.40.0'
|
10181
10314
|
Seahorse::Client::Request.new(handlers, context)
|
10182
10315
|
end
|
10183
10316
|
|