aws-sdk-pinpoint 1.35.0 → 1.36.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 +53 -8
- data/lib/aws-sdk-pinpoint/errors.rb +4 -15
- metadata +3 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 8a7fb04e9004cc3b109f0fa268a6e89f3efadc7ac23f98722fd0ee3b22e7d06d
|
4
|
+
data.tar.gz: c991fc0d4b1e45238b4eb2299cefaf3556ba0475fd43548a22eacd160ea3a8d6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d7dd1d8a49daa742e1f41e8804ba2c46c3c1747ff7aab25d3c462cabc91471aa4738c86fc63651da52bee042738a375b836fe79633172dc946ebe2d7ed0d0d56
|
7
|
+
data.tar.gz: c9a197b900498bd75e49e774ea3a555cbc6f13cf0817514136b79ebf103048822c5d7d64c4acbff1fafcd8bb9b05da6c4090eaa2d4d209553b36ebb16cae3c4d
|
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
|
@@ -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.
|
@@ -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
|
#
|
@@ -10177,7 +10222,7 @@ module Aws::Pinpoint
|
|
10177
10222
|
params: params,
|
10178
10223
|
config: config)
|
10179
10224
|
context[:gem_name] = 'aws-sdk-pinpoint'
|
10180
|
-
context[:gem_version] = '1.
|
10225
|
+
context[:gem_version] = '1.36.0'
|
10181
10226
|
Seahorse::Client::Request.new(handlers, context)
|
10182
10227
|
end
|
10183
10228
|
|
@@ -11,22 +11,17 @@ module Aws::Pinpoint
|
|
11
11
|
# These errors all extend Aws::Pinpoint::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
12
|
#
|
13
13
|
# You can rescue all Pinpoint errors using ServiceError:
|
14
|
+
#
|
14
15
|
# begin
|
15
16
|
# # do stuff
|
16
17
|
# rescue Aws::Pinpoint::Errors::ServiceError
|
17
18
|
# # rescues all Pinpoint API errors
|
18
19
|
# end
|
19
20
|
#
|
21
|
+
#
|
20
22
|
# ## Request Context
|
21
23
|
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
22
|
-
# information about the request that generated the error
|
23
|
-
# *
|
24
|
-
# * #params - The request params
|
25
|
-
# * #operation_name - Name of the API operation invoked
|
26
|
-
# * #http_request
|
27
|
-
# * #http_response
|
28
|
-
# * etc ...
|
29
|
-
#
|
24
|
+
# information about the request that generated the error.
|
30
25
|
# See {Seahorse::Client::RequestContext} for more information.
|
31
26
|
#
|
32
27
|
# ## Error Classes
|
@@ -37,6 +32,7 @@ module Aws::Pinpoint
|
|
37
32
|
# * {NotFoundException}
|
38
33
|
# * {PayloadTooLargeException}
|
39
34
|
# * {TooManyRequestsException}
|
35
|
+
#
|
40
36
|
# Additionally, error classes are dynamically generated for service errors based on the error code
|
41
37
|
# if they are not defined above.
|
42
38
|
module Errors
|
@@ -61,7 +57,6 @@ module Aws::Pinpoint
|
|
61
57
|
def request_id
|
62
58
|
@data[:request_id]
|
63
59
|
end
|
64
|
-
|
65
60
|
end
|
66
61
|
|
67
62
|
class ForbiddenException < ServiceError
|
@@ -82,7 +77,6 @@ module Aws::Pinpoint
|
|
82
77
|
def request_id
|
83
78
|
@data[:request_id]
|
84
79
|
end
|
85
|
-
|
86
80
|
end
|
87
81
|
|
88
82
|
class InternalServerErrorException < ServiceError
|
@@ -103,7 +97,6 @@ module Aws::Pinpoint
|
|
103
97
|
def request_id
|
104
98
|
@data[:request_id]
|
105
99
|
end
|
106
|
-
|
107
100
|
end
|
108
101
|
|
109
102
|
class MethodNotAllowedException < ServiceError
|
@@ -124,7 +117,6 @@ module Aws::Pinpoint
|
|
124
117
|
def request_id
|
125
118
|
@data[:request_id]
|
126
119
|
end
|
127
|
-
|
128
120
|
end
|
129
121
|
|
130
122
|
class NotFoundException < ServiceError
|
@@ -145,7 +137,6 @@ module Aws::Pinpoint
|
|
145
137
|
def request_id
|
146
138
|
@data[:request_id]
|
147
139
|
end
|
148
|
-
|
149
140
|
end
|
150
141
|
|
151
142
|
class PayloadTooLargeException < ServiceError
|
@@ -166,7 +157,6 @@ module Aws::Pinpoint
|
|
166
157
|
def request_id
|
167
158
|
@data[:request_id]
|
168
159
|
end
|
169
|
-
|
170
160
|
end
|
171
161
|
|
172
162
|
class TooManyRequestsException < ServiceError
|
@@ -187,7 +177,6 @@ module Aws::Pinpoint
|
|
187
177
|
def request_id
|
188
178
|
@data[:request_id]
|
189
179
|
end
|
190
|
-
|
191
180
|
end
|
192
181
|
|
193
182
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-pinpoint
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.36.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-03-
|
11
|
+
date: 2020-03-16 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -80,8 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
80
80
|
- !ruby/object:Gem::Version
|
81
81
|
version: '0'
|
82
82
|
requirements: []
|
83
|
-
|
84
|
-
rubygems_version: 2.5.2.3
|
83
|
+
rubygems_version: 3.0.3
|
85
84
|
signing_key:
|
86
85
|
specification_version: 4
|
87
86
|
summary: AWS SDK for Ruby - Amazon Pinpoint
|