aws-sdk-cognitosync 1.16.0 → 1.17.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: '08dab2a51f7a898d19b7052d9d0ae16a488bd9d8'
4
- data.tar.gz: 38885fcd5a57ab6b338ec3f5ffb4e9cea17e03ab
2
+ SHA256:
3
+ metadata.gz: 5aed96b4f91d56dda52295762d8ad74e38de69eb058e6c69cbc1f4ce16a4e02c
4
+ data.tar.gz: 338097cf8952f3e3003a47c4059b97c282d238bf8c1db0fb2332730e32ecd800
5
5
  SHA512:
6
- metadata.gz: 94edad85256fc65e2070eb4f3a813d695757ad02296674e16d7a8bb737b5189f179a20c48d32a4c7028d330541e1852c0040f6f1f0fefecb9e690b2815a9c5a3
7
- data.tar.gz: c9cc9c672975faa9778e6d50342ead6f3b81501d7b927c3608ef054820d0a3526da75dfd448b89574590bd0394b6cd18ce63f526c107186de050cd02c6476d9a
6
+ metadata.gz: 4c1ffac3ce12267296b412614d22a10e64930da18307c5c0e9a10eb0db55ba55856a6bdb7149c779546e1955fcec854a24e0446a9702e6d7c3114e17e3a2b91d
7
+ data.tar.gz: db72ee09d96ded75362ca2c061a17d644f814883b2fa0d07cc4774b45287f55cf82ebcf4e6b97b8b7f04a17a41d4ff8d4606e4a7ade1251990b30a811f39bda8
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-cognitosync/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # cognito_sync = Aws::CognitoSync::Client.new
28
+ # resp = cognito_sync.bulk_publish(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Cognito Sync all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Cognito Sync are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::CognitoSync::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Cognito Sync API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-cognitosync/customizations'
42
45
  # @service
43
46
  module Aws::CognitoSync
44
47
 
45
- GEM_VERSION = '1.16.0'
48
+ GEM_VERSION = '1.17.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:cognitosync)
31
31
 
32
32
  module Aws::CognitoSync
33
+ # An API client for CognitoSync. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::CognitoSync::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -108,6 +120,12 @@ module Aws::CognitoSync
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
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
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::CognitoSync
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
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
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -166,15 +188,29 @@ module Aws::CognitoSync
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
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
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
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
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # 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.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
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.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::CognitoSync
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # 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.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
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
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -209,16 +264,16 @@ module Aws::CognitoSync
209
264
  # requests through. Formatted like 'http://proxy.com:123'.
210
265
  #
211
266
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
267
+ # seconds to wait when opening a HTTP session before raising a
213
268
  # `Timeout::Error`.
214
269
  #
215
270
  # @option options [Integer] :http_read_timeout (60) The default
216
271
  # number of seconds to wait for response data. This value can
217
272
  # safely be set
218
- # per-request on the session yeidled by {#session_for}.
273
+ # per-request on the session yielded by {#session_for}.
219
274
  #
220
275
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
276
+ # seconds a connection is allowed to sit idle before it is
222
277
  # considered stale. Stale connections are closed and removed
223
278
  # from the pool before making a request.
224
279
  #
@@ -227,7 +282,7 @@ module Aws::CognitoSync
227
282
  # request body. This option has no effect unless the request has
228
283
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
284
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
285
+ # request on the session yielded by {#session_for}.
231
286
  #
232
287
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
288
  # HTTP debug output will be sent to the `:logger`.
@@ -1115,7 +1170,7 @@ module Aws::CognitoSync
1115
1170
  params: params,
1116
1171
  config: config)
1117
1172
  context[:gem_name] = 'aws-sdk-cognitosync'
1118
- context[:gem_version] = '1.16.0'
1173
+ context[:gem_version] = '1.17.0'
1119
1174
  Seahorse::Client::Request.new(handlers, context)
1120
1175
  end
1121
1176
 
@@ -6,6 +6,41 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::CognitoSync
9
+
10
+ # When CognitoSync returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::CognitoSync::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all CognitoSync errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::CognitoSync::Errors::ServiceError
18
+ # # rescues all CognitoSync API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {AlreadyStreamedException}
29
+ # * {ConcurrentModificationException}
30
+ # * {DuplicateRequestException}
31
+ # * {InternalErrorException}
32
+ # * {InvalidConfigurationException}
33
+ # * {InvalidLambdaFunctionOutputException}
34
+ # * {InvalidParameterException}
35
+ # * {LambdaThrottledException}
36
+ # * {LimitExceededException}
37
+ # * {NotAuthorizedException}
38
+ # * {ResourceConflictException}
39
+ # * {ResourceNotFoundException}
40
+ # * {TooManyRequestsException}
41
+ #
42
+ # Additionally, error classes are dynamically generated for service errors based on the error code
43
+ # if they are not defined above.
9
44
  module Errors
10
45
 
11
46
  extend Aws::Errors::DynamicErrors
@@ -23,7 +58,6 @@ module Aws::CognitoSync
23
58
  def message
24
59
  @message || @data[:message]
25
60
  end
26
-
27
61
  end
28
62
 
29
63
  class ConcurrentModificationException < ServiceError
@@ -39,7 +73,6 @@ module Aws::CognitoSync
39
73
  def message
40
74
  @message || @data[:message]
41
75
  end
42
-
43
76
  end
44
77
 
45
78
  class DuplicateRequestException < ServiceError
@@ -55,7 +88,6 @@ module Aws::CognitoSync
55
88
  def message
56
89
  @message || @data[:message]
57
90
  end
58
-
59
91
  end
60
92
 
61
93
  class InternalErrorException < ServiceError
@@ -71,7 +103,6 @@ module Aws::CognitoSync
71
103
  def message
72
104
  @message || @data[:message]
73
105
  end
74
-
75
106
  end
76
107
 
77
108
  class InvalidConfigurationException < ServiceError
@@ -87,7 +118,6 @@ module Aws::CognitoSync
87
118
  def message
88
119
  @message || @data[:message]
89
120
  end
90
-
91
121
  end
92
122
 
93
123
  class InvalidLambdaFunctionOutputException < ServiceError
@@ -103,7 +133,6 @@ module Aws::CognitoSync
103
133
  def message
104
134
  @message || @data[:message]
105
135
  end
106
-
107
136
  end
108
137
 
109
138
  class InvalidParameterException < ServiceError
@@ -119,7 +148,6 @@ module Aws::CognitoSync
119
148
  def message
120
149
  @message || @data[:message]
121
150
  end
122
-
123
151
  end
124
152
 
125
153
  class LambdaThrottledException < ServiceError
@@ -135,7 +163,6 @@ module Aws::CognitoSync
135
163
  def message
136
164
  @message || @data[:message]
137
165
  end
138
-
139
166
  end
140
167
 
141
168
  class LimitExceededException < ServiceError
@@ -151,7 +178,6 @@ module Aws::CognitoSync
151
178
  def message
152
179
  @message || @data[:message]
153
180
  end
154
-
155
181
  end
156
182
 
157
183
  class NotAuthorizedException < ServiceError
@@ -167,7 +193,6 @@ module Aws::CognitoSync
167
193
  def message
168
194
  @message || @data[:message]
169
195
  end
170
-
171
196
  end
172
197
 
173
198
  class ResourceConflictException < ServiceError
@@ -183,7 +208,6 @@ module Aws::CognitoSync
183
208
  def message
184
209
  @message || @data[:message]
185
210
  end
186
-
187
211
  end
188
212
 
189
213
  class ResourceNotFoundException < ServiceError
@@ -199,7 +223,6 @@ module Aws::CognitoSync
199
223
  def message
200
224
  @message || @data[:message]
201
225
  end
202
-
203
226
  end
204
227
 
205
228
  class TooManyRequestsException < ServiceError
@@ -215,7 +238,6 @@ module Aws::CognitoSync
215
238
  def message
216
239
  @message || @data[:message]
217
240
  end
218
-
219
241
  end
220
242
 
221
243
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::CognitoSync
9
+ # This class provides a resource oriented interface for CognitoSync.
10
+ # To create a resource object:
11
+ # resource = Aws::CognitoSync::Resource.new(region: 'us-west-2')
12
+ # You can supply a client object with custom configuration that will be used for all resource operations.
13
+ # If you do not pass +:client+, a default client will be constructed.
14
+ # client = Aws::CognitoSync::Client.new(region: 'us-west-2')
15
+ # resource = Aws::CognitoSync::Resource.new(client: client)
9
16
  class Resource
10
17
 
11
18
  # @param options ({})
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-cognitosync
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.16.0
4
+ version: 1.17.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: 2019-10-23 00:00:00.000000000 Z
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
- rubyforge_project:
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 Cognito Sync