aws-sdk-cognitoidentityprovider 1.32.0 → 1.33.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
2
  SHA1:
3
- metadata.gz: 7361662f5b0bb67d92023891586c6754bcd59a79
4
- data.tar.gz: 0ec4d5ed41aa58bb88d9f421ffdc8b76c454e08f
3
+ metadata.gz: 124330bce8f041acf8a3235a1adbf59654874562
4
+ data.tar.gz: 6b89b4e9a36daa2d30ef76340044bc29f792b245
5
5
  SHA512:
6
- metadata.gz: 3e52d8c2d325203792364482f6d14c3a011857f2185256cae3dd4a59cbc0ae816ba50bb8fa1cedb75dac824af8dc005edca238eb7104f4e52a230dfc394c5bb7
7
- data.tar.gz: d826e8ee58e58d4626c3586e48d85b71f23b5edf6ac7f562e4342917d95674699dd3376c50d3b4a328752aa41de6c3184a8e7d5729cacf9212dbcd74107f3e3d
6
+ metadata.gz: '00846ce13c2f509a9dcbc458683ca087607a0be9ced9f5587e4bdb89ce0fc3437ea44524a622b9b32186b29d8335211aaad8868b1df3b1170c02051edd214441'
7
+ data.tar.gz: 98b791025d4ba9b36370107ce1d9e655a9eb2ab58d81f66ac3d93cf75c15ec82bfee00b01483ffdf802259afc1a333e691a9b7f053cbbb02c597fc3563b5b463
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-cognitoidentityprovider/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # cognito_identity_provider = Aws::CognitoIdentityProvider::Client.new
28
+ # resp = cognito_identity_provider.add_custom_attributes(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Cognito Identity Provider all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Cognito Identity Provider 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::CognitoIdentityProvider::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Cognito Identity Provider API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-cognitoidentityprovider/customizations'
42
45
  # @service
43
46
  module Aws::CognitoIdentityProvider
44
47
 
45
- GEM_VERSION = '1.32.0'
48
+ GEM_VERSION = '1.33.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:cognitoidentityprovider)
31
31
 
32
32
  module Aws::CognitoIdentityProvider
33
+ # An API client for CognitoIdentityProvider. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::CognitoIdentityProvider::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::CognitoIdentityProvider
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::CognitoIdentityProvider
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::CognitoIdentityProvider
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,26 @@ module Aws::CognitoIdentityProvider
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
+ # * `legacy` - The pre-existing retry behavior. This is default value if
233
+ # no retry mode is provided.
234
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
+ # This includes support for retry quotas, which limit the number of
236
+ # unsuccessful retries a client can make.
237
+ # * `adaptive` - An experimental retry mode that includes all the
238
+ # functionality of `standard` mode along with automatic client side
239
+ # throttling. This is a provisional mode that may change behavior
240
+ # in the future.
190
241
  #
191
242
  # @option options [String] :secret_access_key
192
243
  #
@@ -219,16 +270,16 @@ module Aws::CognitoIdentityProvider
219
270
  # requests through. Formatted like 'http://proxy.com:123'.
220
271
  #
221
272
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
273
+ # seconds to wait when opening a HTTP session before raising a
223
274
  # `Timeout::Error`.
224
275
  #
225
276
  # @option options [Integer] :http_read_timeout (60) The default
226
277
  # number of seconds to wait for response data. This value can
227
278
  # safely be set
228
- # per-request on the session yeidled by {#session_for}.
279
+ # per-request on the session yielded by {#session_for}.
229
280
  #
230
281
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
282
+ # seconds a connection is allowed to sit idle before it is
232
283
  # considered stale. Stale connections are closed and removed
233
284
  # from the pool before making a request.
234
285
  #
@@ -237,7 +288,7 @@ module Aws::CognitoIdentityProvider
237
288
  # request body. This option has no effect unless the request has
238
289
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
290
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
291
+ # request on the session yielded by {#session_for}.
241
292
  #
242
293
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
294
  # HTTP debug output will be sent to the `:logger`.
@@ -6792,7 +6843,7 @@ module Aws::CognitoIdentityProvider
6792
6843
  params: params,
6793
6844
  config: config)
6794
6845
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
6795
- context[:gem_version] = '1.32.0'
6846
+ context[:gem_version] = '1.33.0'
6796
6847
  Seahorse::Client::Request.new(handlers, context)
6797
6848
  end
6798
6849
 
@@ -6,6 +6,65 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::CognitoIdentityProvider
9
+
10
+ # When CognitoIdentityProvider returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::CognitoIdentityProvider::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all CognitoIdentityProvider errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::CognitoIdentityProvider::Errors::ServiceError
18
+ # # rescues all CognitoIdentityProvider 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
+ # * {AliasExistsException}
29
+ # * {CodeDeliveryFailureException}
30
+ # * {CodeMismatchException}
31
+ # * {ConcurrentModificationException}
32
+ # * {DuplicateProviderException}
33
+ # * {EnableSoftwareTokenMFAException}
34
+ # * {ExpiredCodeException}
35
+ # * {GroupExistsException}
36
+ # * {InternalErrorException}
37
+ # * {InvalidEmailRoleAccessPolicyException}
38
+ # * {InvalidLambdaResponseException}
39
+ # * {InvalidOAuthFlowException}
40
+ # * {InvalidParameterException}
41
+ # * {InvalidPasswordException}
42
+ # * {InvalidSmsRoleAccessPolicyException}
43
+ # * {InvalidSmsRoleTrustRelationshipException}
44
+ # * {InvalidUserPoolConfigurationException}
45
+ # * {LimitExceededException}
46
+ # * {MFAMethodNotFoundException}
47
+ # * {NotAuthorizedException}
48
+ # * {PasswordResetRequiredException}
49
+ # * {PreconditionNotMetException}
50
+ # * {ResourceNotFoundException}
51
+ # * {ScopeDoesNotExistException}
52
+ # * {SoftwareTokenMFANotFoundException}
53
+ # * {TooManyFailedAttemptsException}
54
+ # * {TooManyRequestsException}
55
+ # * {UnexpectedLambdaException}
56
+ # * {UnsupportedIdentityProviderException}
57
+ # * {UnsupportedUserStateException}
58
+ # * {UserImportInProgressException}
59
+ # * {UserLambdaValidationException}
60
+ # * {UserNotConfirmedException}
61
+ # * {UserNotFoundException}
62
+ # * {UserPoolAddOnNotEnabledException}
63
+ # * {UserPoolTaggingException}
64
+ # * {UsernameExistsException}
65
+ #
66
+ # Additionally, error classes are dynamically generated for service errors based on the error code
67
+ # if they are not defined above.
9
68
  module Errors
10
69
 
11
70
  extend Aws::Errors::DynamicErrors
@@ -23,7 +82,6 @@ module Aws::CognitoIdentityProvider
23
82
  def message
24
83
  @message || @data[:message]
25
84
  end
26
-
27
85
  end
28
86
 
29
87
  class CodeDeliveryFailureException < ServiceError
@@ -39,7 +97,6 @@ module Aws::CognitoIdentityProvider
39
97
  def message
40
98
  @message || @data[:message]
41
99
  end
42
-
43
100
  end
44
101
 
45
102
  class CodeMismatchException < ServiceError
@@ -55,7 +112,6 @@ module Aws::CognitoIdentityProvider
55
112
  def message
56
113
  @message || @data[:message]
57
114
  end
58
-
59
115
  end
60
116
 
61
117
  class ConcurrentModificationException < ServiceError
@@ -71,7 +127,6 @@ module Aws::CognitoIdentityProvider
71
127
  def message
72
128
  @message || @data[:message]
73
129
  end
74
-
75
130
  end
76
131
 
77
132
  class DuplicateProviderException < ServiceError
@@ -87,7 +142,6 @@ module Aws::CognitoIdentityProvider
87
142
  def message
88
143
  @message || @data[:message]
89
144
  end
90
-
91
145
  end
92
146
 
93
147
  class EnableSoftwareTokenMFAException < ServiceError
@@ -103,7 +157,6 @@ module Aws::CognitoIdentityProvider
103
157
  def message
104
158
  @message || @data[:message]
105
159
  end
106
-
107
160
  end
108
161
 
109
162
  class ExpiredCodeException < ServiceError
@@ -119,7 +172,6 @@ module Aws::CognitoIdentityProvider
119
172
  def message
120
173
  @message || @data[:message]
121
174
  end
122
-
123
175
  end
124
176
 
125
177
  class GroupExistsException < ServiceError
@@ -135,7 +187,6 @@ module Aws::CognitoIdentityProvider
135
187
  def message
136
188
  @message || @data[:message]
137
189
  end
138
-
139
190
  end
140
191
 
141
192
  class InternalErrorException < ServiceError
@@ -151,7 +202,6 @@ module Aws::CognitoIdentityProvider
151
202
  def message
152
203
  @message || @data[:message]
153
204
  end
154
-
155
205
  end
156
206
 
157
207
  class InvalidEmailRoleAccessPolicyException < ServiceError
@@ -167,7 +217,6 @@ module Aws::CognitoIdentityProvider
167
217
  def message
168
218
  @message || @data[:message]
169
219
  end
170
-
171
220
  end
172
221
 
173
222
  class InvalidLambdaResponseException < ServiceError
@@ -183,7 +232,6 @@ module Aws::CognitoIdentityProvider
183
232
  def message
184
233
  @message || @data[:message]
185
234
  end
186
-
187
235
  end
188
236
 
189
237
  class InvalidOAuthFlowException < ServiceError
@@ -199,7 +247,6 @@ module Aws::CognitoIdentityProvider
199
247
  def message
200
248
  @message || @data[:message]
201
249
  end
202
-
203
250
  end
204
251
 
205
252
  class InvalidParameterException < ServiceError
@@ -215,7 +262,6 @@ module Aws::CognitoIdentityProvider
215
262
  def message
216
263
  @message || @data[:message]
217
264
  end
218
-
219
265
  end
220
266
 
221
267
  class InvalidPasswordException < ServiceError
@@ -231,7 +277,6 @@ module Aws::CognitoIdentityProvider
231
277
  def message
232
278
  @message || @data[:message]
233
279
  end
234
-
235
280
  end
236
281
 
237
282
  class InvalidSmsRoleAccessPolicyException < ServiceError
@@ -247,7 +292,6 @@ module Aws::CognitoIdentityProvider
247
292
  def message
248
293
  @message || @data[:message]
249
294
  end
250
-
251
295
  end
252
296
 
253
297
  class InvalidSmsRoleTrustRelationshipException < ServiceError
@@ -263,7 +307,6 @@ module Aws::CognitoIdentityProvider
263
307
  def message
264
308
  @message || @data[:message]
265
309
  end
266
-
267
310
  end
268
311
 
269
312
  class InvalidUserPoolConfigurationException < ServiceError
@@ -279,7 +322,6 @@ module Aws::CognitoIdentityProvider
279
322
  def message
280
323
  @message || @data[:message]
281
324
  end
282
-
283
325
  end
284
326
 
285
327
  class LimitExceededException < ServiceError
@@ -295,7 +337,6 @@ module Aws::CognitoIdentityProvider
295
337
  def message
296
338
  @message || @data[:message]
297
339
  end
298
-
299
340
  end
300
341
 
301
342
  class MFAMethodNotFoundException < ServiceError
@@ -311,7 +352,6 @@ module Aws::CognitoIdentityProvider
311
352
  def message
312
353
  @message || @data[:message]
313
354
  end
314
-
315
355
  end
316
356
 
317
357
  class NotAuthorizedException < ServiceError
@@ -327,7 +367,6 @@ module Aws::CognitoIdentityProvider
327
367
  def message
328
368
  @message || @data[:message]
329
369
  end
330
-
331
370
  end
332
371
 
333
372
  class PasswordResetRequiredException < ServiceError
@@ -343,7 +382,6 @@ module Aws::CognitoIdentityProvider
343
382
  def message
344
383
  @message || @data[:message]
345
384
  end
346
-
347
385
  end
348
386
 
349
387
  class PreconditionNotMetException < ServiceError
@@ -359,7 +397,6 @@ module Aws::CognitoIdentityProvider
359
397
  def message
360
398
  @message || @data[:message]
361
399
  end
362
-
363
400
  end
364
401
 
365
402
  class ResourceNotFoundException < ServiceError
@@ -375,7 +412,6 @@ module Aws::CognitoIdentityProvider
375
412
  def message
376
413
  @message || @data[:message]
377
414
  end
378
-
379
415
  end
380
416
 
381
417
  class ScopeDoesNotExistException < ServiceError
@@ -391,7 +427,6 @@ module Aws::CognitoIdentityProvider
391
427
  def message
392
428
  @message || @data[:message]
393
429
  end
394
-
395
430
  end
396
431
 
397
432
  class SoftwareTokenMFANotFoundException < ServiceError
@@ -407,7 +442,6 @@ module Aws::CognitoIdentityProvider
407
442
  def message
408
443
  @message || @data[:message]
409
444
  end
410
-
411
445
  end
412
446
 
413
447
  class TooManyFailedAttemptsException < ServiceError
@@ -423,7 +457,6 @@ module Aws::CognitoIdentityProvider
423
457
  def message
424
458
  @message || @data[:message]
425
459
  end
426
-
427
460
  end
428
461
 
429
462
  class TooManyRequestsException < ServiceError
@@ -439,7 +472,6 @@ module Aws::CognitoIdentityProvider
439
472
  def message
440
473
  @message || @data[:message]
441
474
  end
442
-
443
475
  end
444
476
 
445
477
  class UnexpectedLambdaException < ServiceError
@@ -455,7 +487,6 @@ module Aws::CognitoIdentityProvider
455
487
  def message
456
488
  @message || @data[:message]
457
489
  end
458
-
459
490
  end
460
491
 
461
492
  class UnsupportedIdentityProviderException < ServiceError
@@ -471,7 +502,6 @@ module Aws::CognitoIdentityProvider
471
502
  def message
472
503
  @message || @data[:message]
473
504
  end
474
-
475
505
  end
476
506
 
477
507
  class UnsupportedUserStateException < ServiceError
@@ -487,7 +517,6 @@ module Aws::CognitoIdentityProvider
487
517
  def message
488
518
  @message || @data[:message]
489
519
  end
490
-
491
520
  end
492
521
 
493
522
  class UserImportInProgressException < ServiceError
@@ -503,7 +532,6 @@ module Aws::CognitoIdentityProvider
503
532
  def message
504
533
  @message || @data[:message]
505
534
  end
506
-
507
535
  end
508
536
 
509
537
  class UserLambdaValidationException < ServiceError
@@ -519,7 +547,6 @@ module Aws::CognitoIdentityProvider
519
547
  def message
520
548
  @message || @data[:message]
521
549
  end
522
-
523
550
  end
524
551
 
525
552
  class UserNotConfirmedException < ServiceError
@@ -535,7 +562,6 @@ module Aws::CognitoIdentityProvider
535
562
  def message
536
563
  @message || @data[:message]
537
564
  end
538
-
539
565
  end
540
566
 
541
567
  class UserNotFoundException < ServiceError
@@ -551,7 +577,6 @@ module Aws::CognitoIdentityProvider
551
577
  def message
552
578
  @message || @data[:message]
553
579
  end
554
-
555
580
  end
556
581
 
557
582
  class UserPoolAddOnNotEnabledException < ServiceError
@@ -567,7 +592,6 @@ module Aws::CognitoIdentityProvider
567
592
  def message
568
593
  @message || @data[:message]
569
594
  end
570
-
571
595
  end
572
596
 
573
597
  class UserPoolTaggingException < ServiceError
@@ -583,7 +607,6 @@ module Aws::CognitoIdentityProvider
583
607
  def message
584
608
  @message || @data[:message]
585
609
  end
586
-
587
610
  end
588
611
 
589
612
  class UsernameExistsException < ServiceError
@@ -599,7 +622,6 @@ module Aws::CognitoIdentityProvider
599
622
  def message
600
623
  @message || @data[:message]
601
624
  end
602
-
603
625
  end
604
626
 
605
627
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::CognitoIdentityProvider
9
+ # This class provides a resource oriented interface for CognitoIdentityProvider.
10
+ # To create a resource object:
11
+ # resource = Aws::CognitoIdentityProvider::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::CognitoIdentityProvider::Client.new(region: 'us-west-2')
15
+ # resource = Aws::CognitoIdentityProvider::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-cognitoidentityprovider
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.32.0
4
+ version: 1.33.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-02-11 00:00:00.000000000 Z
11
+ date: 2020-03-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core