aws-sdk-cognitoidentityprovider 1.32.0 → 1.37.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/aws-sdk-cognitoidentityprovider.rb +7 -4
- data/lib/aws-sdk-cognitoidentityprovider/client.rb +109 -22
- data/lib/aws-sdk-cognitoidentityprovider/client_api.rb +1 -0
- data/lib/aws-sdk-cognitoidentityprovider/errors.rb +59 -37
- data/lib/aws-sdk-cognitoidentityprovider/resource.rb +1 -0
- data/lib/aws-sdk-cognitoidentityprovider/types.rb +38 -2
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 4fe19a6754b664482fefb12f0366ee62c155b8f2dcf907e2714f705434c1ec52
|
4
|
+
data.tar.gz: 95d78a87c1902b92eaf1c8377932eb37278737980b029ff4a70974904fd8c2d5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a6d0b7ba8fa11fe6c2ba2e128f6960282456954b199d75b1bcbe28859641a64badee34359406e9df2948d894c67fbdaeb41a5c7d5f44fa223f617b58fbcd6987
|
7
|
+
data.tar.gz: 419945b2ed5153384e5b18714fc360436d12f9d01c17200f5e9183c3c4bfb3820945827503eb0b6fe7fbfb9e1ce11be21c334da56c31f2d916baeec709828054
|
@@ -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
|
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
|
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.
|
48
|
+
GEM_VERSION = '1.37.1'
|
46
49
|
|
47
50
|
end
|
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
28
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
29
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
29
30
|
|
30
31
|
Aws::Plugins::GlobalConfiguration.add_identifier(:cognitoidentityprovider)
|
31
32
|
|
32
33
|
module Aws::CognitoIdentityProvider
|
34
|
+
# An API client for CognitoIdentityProvider. To construct a client, you need to configure a `:region` and `:credentials`.
|
35
|
+
#
|
36
|
+
# client = Aws::CognitoIdentityProvider::Client.new(
|
37
|
+
# region: region_name,
|
38
|
+
# credentials: credentials,
|
39
|
+
# # ...
|
40
|
+
# )
|
41
|
+
#
|
42
|
+
# For details on configuring region and credentials see
|
43
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
44
|
+
#
|
45
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
46
|
class Client < Seahorse::Client::Base
|
34
47
|
|
35
48
|
include Aws::ClientStubs
|
@@ -57,6 +70,7 @@ module Aws::CognitoIdentityProvider
|
|
57
70
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
58
71
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
59
72
|
add_plugin(Aws::Plugins::TransferEncoding)
|
73
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
60
74
|
add_plugin(Aws::Plugins::SignatureV4)
|
61
75
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
62
76
|
|
@@ -93,7 +107,7 @@ module Aws::CognitoIdentityProvider
|
|
93
107
|
# @option options [required, String] :region
|
94
108
|
# The AWS region to connect to. The configured `:region` is
|
95
109
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
97
111
|
#
|
98
112
|
# * `Aws.config[:region]`
|
99
113
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +122,12 @@ module Aws::CognitoIdentityProvider
|
|
108
122
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
123
|
# the background every 60 secs (default). Defaults to `false`.
|
110
124
|
#
|
125
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
126
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
127
|
+
# until there is sufficent client side capacity to retry the request.
|
128
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
129
|
+
# not retry instead of sleeping.
|
130
|
+
#
|
111
131
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
132
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
133
|
# this client.
|
@@ -132,6 +152,10 @@ module Aws::CognitoIdentityProvider
|
|
132
152
|
# When `true`, an attempt is made to coerce request parameters into
|
133
153
|
# the required types.
|
134
154
|
#
|
155
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
156
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
157
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
158
|
+
#
|
135
159
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
160
|
# Set to true to disable SDK automatically adding host prefix
|
137
161
|
# to default service endpoint when available.
|
@@ -139,7 +163,7 @@ module Aws::CognitoIdentityProvider
|
|
139
163
|
# @option options [String] :endpoint
|
140
164
|
# The client endpoint is normally constructed from the `:region`
|
141
165
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
166
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
143
167
|
#
|
144
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +178,7 @@ module Aws::CognitoIdentityProvider
|
|
154
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
179
|
#
|
156
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
182
|
#
|
159
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
184
|
# The log formatter.
|
@@ -166,15 +190,29 @@ module Aws::CognitoIdentityProvider
|
|
166
190
|
# The Logger instance to send log messages to. If this option
|
167
191
|
# is not set, logging will be disabled.
|
168
192
|
#
|
193
|
+
# @option options [Integer] :max_attempts (3)
|
194
|
+
# An integer representing the maximum number attempts that will be made for
|
195
|
+
# a single request, including the initial attempt. For example,
|
196
|
+
# setting this value to 5 will result in a request being retried up to
|
197
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
198
|
+
#
|
169
199
|
# @option options [String] :profile ("default")
|
170
200
|
# Used when loading credentials from the shared credentials file
|
171
201
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
202
|
#
|
203
|
+
# @option options [Proc] :retry_backoff
|
204
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
205
|
+
# This option is only used in the `legacy` retry mode.
|
206
|
+
#
|
173
207
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
208
|
+
# The base delay in seconds used by the default backoff function. This option
|
209
|
+
# is only used in the `legacy` retry mode.
|
175
210
|
#
|
176
211
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
212
|
+
# A delay randomiser function used by the default backoff function.
|
213
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
214
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
215
|
+
# in the `legacy` retry mode.
|
178
216
|
#
|
179
217
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
218
|
#
|
@@ -182,11 +220,30 @@ module Aws::CognitoIdentityProvider
|
|
182
220
|
# The maximum number of times to retry failed requests. Only
|
183
221
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
222
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
223
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
224
|
+
# endpoint discovery, and errors from expired credentials.
|
225
|
+
# This option is only used in the `legacy` retry mode.
|
187
226
|
#
|
188
227
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
228
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
229
|
+
# used by the default backoff function. This option is only used in the
|
230
|
+
# `legacy` retry mode.
|
231
|
+
#
|
232
|
+
# @option options [String] :retry_mode ("legacy")
|
233
|
+
# Specifies which retry algorithm to use. Values are:
|
234
|
+
#
|
235
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
236
|
+
# no retry mode is provided.
|
237
|
+
#
|
238
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
239
|
+
# This includes support for retry quotas, which limit the number of
|
240
|
+
# unsuccessful retries a client can make.
|
241
|
+
#
|
242
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
243
|
+
# functionality of `standard` mode along with automatic client side
|
244
|
+
# throttling. This is a provisional mode that may change behavior
|
245
|
+
# in the future.
|
246
|
+
#
|
190
247
|
#
|
191
248
|
# @option options [String] :secret_access_key
|
192
249
|
#
|
@@ -219,16 +276,15 @@ module Aws::CognitoIdentityProvider
|
|
219
276
|
# requests through. Formatted like 'http://proxy.com:123'.
|
220
277
|
#
|
221
278
|
# @option options [Float] :http_open_timeout (15) The number of
|
222
|
-
# seconds to wait when opening a HTTP session before
|
279
|
+
# seconds to wait when opening a HTTP session before raising a
|
223
280
|
# `Timeout::Error`.
|
224
281
|
#
|
225
282
|
# @option options [Integer] :http_read_timeout (60) The default
|
226
283
|
# number of seconds to wait for response data. This value can
|
227
|
-
# safely be set
|
228
|
-
# per-request on the session yeidled by {#session_for}.
|
284
|
+
# safely be set per-request on the session.
|
229
285
|
#
|
230
286
|
# @option options [Float] :http_idle_timeout (5) The number of
|
231
|
-
# seconds a connection is allowed to sit
|
287
|
+
# seconds a connection is allowed to sit idle before it is
|
232
288
|
# considered stale. Stale connections are closed and removed
|
233
289
|
# from the pool before making a request.
|
234
290
|
#
|
@@ -237,7 +293,7 @@ module Aws::CognitoIdentityProvider
|
|
237
293
|
# request body. This option has no effect unless the request has
|
238
294
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
239
295
|
# disables this behaviour. This value can safely be set per
|
240
|
-
# request on the session
|
296
|
+
# request on the session.
|
241
297
|
#
|
242
298
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
243
299
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -1300,6 +1356,8 @@ module Aws::CognitoIdentityProvider
|
|
1300
1356
|
# * {Types::AdminListGroupsForUserResponse#groups #groups} => Array<Types::GroupType>
|
1301
1357
|
# * {Types::AdminListGroupsForUserResponse#next_token #next_token} => String
|
1302
1358
|
#
|
1359
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1360
|
+
#
|
1303
1361
|
# @example Request syntax with placeholder values
|
1304
1362
|
#
|
1305
1363
|
# resp = client.admin_list_groups_for_user({
|
@@ -1350,6 +1408,8 @@ module Aws::CognitoIdentityProvider
|
|
1350
1408
|
# * {Types::AdminListUserAuthEventsResponse#auth_events #auth_events} => Array<Types::AuthEventType>
|
1351
1409
|
# * {Types::AdminListUserAuthEventsResponse#next_token #next_token} => String
|
1352
1410
|
#
|
1411
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1412
|
+
#
|
1353
1413
|
# @example Request syntax with placeholder values
|
1354
1414
|
#
|
1355
1415
|
# resp = client.admin_list_user_auth_events({
|
@@ -1368,6 +1428,7 @@ module Aws::CognitoIdentityProvider
|
|
1368
1428
|
# resp.auth_events[0].event_response #=> String, one of "Success", "Failure"
|
1369
1429
|
# resp.auth_events[0].event_risk.risk_decision #=> String, one of "NoRisk", "AccountTakeover", "Block"
|
1370
1430
|
# resp.auth_events[0].event_risk.risk_level #=> String, one of "Low", "Medium", "High"
|
1431
|
+
# resp.auth_events[0].event_risk.compromised_credentials_detected #=> Boolean
|
1371
1432
|
# resp.auth_events[0].challenge_responses #=> Array
|
1372
1433
|
# resp.auth_events[0].challenge_responses[0].challenge_name #=> String, one of "Password", "Mfa"
|
1373
1434
|
# resp.auth_events[0].challenge_responses[0].challenge_response #=> String, one of "Success", "Failure"
|
@@ -2433,7 +2494,7 @@ module Aws::CognitoIdentityProvider
|
|
2433
2494
|
#
|
2434
2495
|
# * MetadataFile OR MetadataURL
|
2435
2496
|
#
|
2436
|
-
# *
|
2497
|
+
# * IDPSignout *optional*
|
2437
2498
|
#
|
2438
2499
|
# @option params [Hash<String,String>] :attribute_mapping
|
2439
2500
|
# A mapping of identity provider attributes to standard and custom user
|
@@ -3031,6 +3092,12 @@ module Aws::CognitoIdentityProvider
|
|
3031
3092
|
# The Amazon Pinpoint analytics configuration for collecting metrics for
|
3032
3093
|
# this user pool.
|
3033
3094
|
#
|
3095
|
+
# <note markdown="1"> Cognito User Pools only supports sending events to Amazon Pinpoint
|
3096
|
+
# projects in the US East (N. Virginia) us-east-1 Region, regardless of
|
3097
|
+
# the region in which the user pool resides.
|
3098
|
+
#
|
3099
|
+
# </note>
|
3100
|
+
#
|
3034
3101
|
# @option params [String] :prevent_user_existence_errors
|
3035
3102
|
# Use this setting to choose which errors and responses are returned by
|
3036
3103
|
# Cognito APIs during authentication, account confirmation, and password
|
@@ -3813,13 +3880,13 @@ module Aws::CognitoIdentityProvider
|
|
3813
3880
|
|
3814
3881
|
# Calling this API causes a message to be sent to the end user with a
|
3815
3882
|
# confirmation code that is required to change the user's password. For
|
3816
|
-
# the `Username` parameter, you can use the username or user alias.
|
3817
|
-
#
|
3818
|
-
#
|
3819
|
-
#
|
3820
|
-
# number nor a verified email exists,
|
3821
|
-
# thrown. To use the confirmation code
|
3822
|
-
# .
|
3883
|
+
# the `Username` parameter, you can use the username or user alias. The
|
3884
|
+
# method used to send the confirmation code is sent according to the
|
3885
|
+
# specified AccountRecoverySetting. For more information, see
|
3886
|
+
# [Recovering User Accounts]() in the *Amazon Cognito Developer Guide*.
|
3887
|
+
# If neither a verified phone number nor a verified email exists, an
|
3888
|
+
# `InvalidParameterException` is thrown. To use the confirmation code
|
3889
|
+
# for resetting the password, call .
|
3823
3890
|
#
|
3824
3891
|
# @option params [required, String] :client_id
|
3825
3892
|
# The ID of the client associated with the user pool.
|
@@ -4561,6 +4628,8 @@ module Aws::CognitoIdentityProvider
|
|
4561
4628
|
# * {Types::ListGroupsResponse#groups #groups} => Array<Types::GroupType>
|
4562
4629
|
# * {Types::ListGroupsResponse#next_token #next_token} => String
|
4563
4630
|
#
|
4631
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4632
|
+
#
|
4564
4633
|
# @example Request syntax with placeholder values
|
4565
4634
|
#
|
4566
4635
|
# resp = client.list_groups({
|
@@ -4606,6 +4675,8 @@ module Aws::CognitoIdentityProvider
|
|
4606
4675
|
# * {Types::ListIdentityProvidersResponse#providers #providers} => Array<Types::ProviderDescription>
|
4607
4676
|
# * {Types::ListIdentityProvidersResponse#next_token #next_token} => String
|
4608
4677
|
#
|
4678
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4679
|
+
#
|
4609
4680
|
# @example Request syntax with placeholder values
|
4610
4681
|
#
|
4611
4682
|
# resp = client.list_identity_providers({
|
@@ -4648,6 +4719,8 @@ module Aws::CognitoIdentityProvider
|
|
4648
4719
|
# * {Types::ListResourceServersResponse#resource_servers #resource_servers} => Array<Types::ResourceServerType>
|
4649
4720
|
# * {Types::ListResourceServersResponse#next_token #next_token} => String
|
4650
4721
|
#
|
4722
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4723
|
+
#
|
4651
4724
|
# @example Request syntax with placeholder values
|
4652
4725
|
#
|
4653
4726
|
# resp = client.list_resource_servers({
|
@@ -4786,6 +4859,8 @@ module Aws::CognitoIdentityProvider
|
|
4786
4859
|
# * {Types::ListUserPoolClientsResponse#user_pool_clients #user_pool_clients} => Array<Types::UserPoolClientDescription>
|
4787
4860
|
# * {Types::ListUserPoolClientsResponse#next_token #next_token} => String
|
4788
4861
|
#
|
4862
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4863
|
+
#
|
4789
4864
|
# @example Request syntax with placeholder values
|
4790
4865
|
#
|
4791
4866
|
# resp = client.list_user_pool_clients({
|
@@ -4827,6 +4902,8 @@ module Aws::CognitoIdentityProvider
|
|
4827
4902
|
# * {Types::ListUserPoolsResponse#user_pools #user_pools} => Array<Types::UserPoolDescriptionType>
|
4828
4903
|
# * {Types::ListUserPoolsResponse#next_token #next_token} => String
|
4829
4904
|
#
|
4905
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4906
|
+
#
|
4830
4907
|
# @example Request syntax with placeholder values
|
4831
4908
|
#
|
4832
4909
|
# resp = client.list_user_pools({
|
@@ -4940,6 +5017,8 @@ module Aws::CognitoIdentityProvider
|
|
4940
5017
|
# * {Types::ListUsersResponse#users #users} => Array<Types::UserType>
|
4941
5018
|
# * {Types::ListUsersResponse#pagination_token #pagination_token} => String
|
4942
5019
|
#
|
5020
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5021
|
+
#
|
4943
5022
|
# @example Request syntax with placeholder values
|
4944
5023
|
#
|
4945
5024
|
# resp = client.list_users({
|
@@ -4998,6 +5077,8 @@ module Aws::CognitoIdentityProvider
|
|
4998
5077
|
# * {Types::ListUsersInGroupResponse#users #users} => Array<Types::UserType>
|
4999
5078
|
# * {Types::ListUsersInGroupResponse#next_token #next_token} => String
|
5000
5079
|
#
|
5080
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5081
|
+
#
|
5001
5082
|
# @example Request syntax with placeholder values
|
5002
5083
|
#
|
5003
5084
|
# resp = client.list_users_in_group({
|
@@ -6511,6 +6592,12 @@ module Aws::CognitoIdentityProvider
|
|
6511
6592
|
# The Amazon Pinpoint analytics configuration for collecting metrics for
|
6512
6593
|
# this user pool.
|
6513
6594
|
#
|
6595
|
+
# <note markdown="1"> Cognito User Pools only supports sending events to Amazon Pinpoint
|
6596
|
+
# projects in the US East (N. Virginia) us-east-1 Region, regardless of
|
6597
|
+
# the region in which the user pool resides.
|
6598
|
+
#
|
6599
|
+
# </note>
|
6600
|
+
#
|
6514
6601
|
# @option params [String] :prevent_user_existence_errors
|
6515
6602
|
# Use this setting to choose which errors and responses are returned by
|
6516
6603
|
# Cognito APIs during authentication, account confirmation, and password
|
@@ -6792,7 +6879,7 @@ module Aws::CognitoIdentityProvider
|
|
6792
6879
|
params: params,
|
6793
6880
|
config: config)
|
6794
6881
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
6795
|
-
context[:gem_version] = '1.
|
6882
|
+
context[:gem_version] = '1.37.1'
|
6796
6883
|
Seahorse::Client::Request.new(handlers, context)
|
6797
6884
|
end
|
6798
6885
|
|
@@ -1087,6 +1087,7 @@ module Aws::CognitoIdentityProvider
|
|
1087
1087
|
|
1088
1088
|
EventRiskType.add_member(:risk_decision, Shapes::ShapeRef.new(shape: RiskDecisionType, location_name: "RiskDecision"))
|
1089
1089
|
EventRiskType.add_member(:risk_level, Shapes::ShapeRef.new(shape: RiskLevelType, location_name: "RiskLevel"))
|
1090
|
+
EventRiskType.add_member(:compromised_credentials_detected, Shapes::ShapeRef.new(shape: WrappedBooleanType, location_name: "CompromisedCredentialsDetected"))
|
1090
1091
|
EventRiskType.struct_class = Types::EventRiskType
|
1091
1092
|
|
1092
1093
|
ExpiredCodeException.add_member(:message, Shapes::ShapeRef.new(shape: MessageType, location_name: "message"))
|
@@ -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
|
@@ -2104,6 +2104,12 @@ module Aws::CognitoIdentityProvider
|
|
2104
2104
|
# The Amazon Pinpoint analytics configuration for collecting metrics for
|
2105
2105
|
# a user pool.
|
2106
2106
|
#
|
2107
|
+
# <note markdown="1"> Cognito User Pools only supports sending events to Amazon Pinpoint
|
2108
|
+
# projects in the US East (N. Virginia) us-east-1 Region, regardless of
|
2109
|
+
# the region in which the user pool resides.
|
2110
|
+
#
|
2111
|
+
# </note>
|
2112
|
+
#
|
2107
2113
|
# @note When making an API call, you may pass AnalyticsConfigurationType
|
2108
2114
|
# data as a hash:
|
2109
2115
|
#
|
@@ -2147,6 +2153,12 @@ module Aws::CognitoIdentityProvider
|
|
2147
2153
|
# An endpoint uniquely identifies a mobile device, email address, or
|
2148
2154
|
# phone number that can receive messages from Amazon Pinpoint analytics.
|
2149
2155
|
#
|
2156
|
+
# <note markdown="1"> Cognito User Pools only supports sending events to Amazon Pinpoint
|
2157
|
+
# projects in the US East (N. Virginia) us-east-1 Region, regardless of
|
2158
|
+
# the region in which the user pool resides.
|
2159
|
+
#
|
2160
|
+
# </note>
|
2161
|
+
#
|
2150
2162
|
# @note When making an API call, you may pass AnalyticsMetadataType
|
2151
2163
|
# data as a hash:
|
2152
2164
|
#
|
@@ -2993,7 +3005,7 @@ module Aws::CognitoIdentityProvider
|
|
2993
3005
|
#
|
2994
3006
|
# * MetadataFile OR MetadataURL
|
2995
3007
|
#
|
2996
|
-
# *
|
3008
|
+
# * IDPSignout *optional*
|
2997
3009
|
# @return [Hash<String,String>]
|
2998
3010
|
#
|
2999
3011
|
# @!attribute [rw] attribute_mapping
|
@@ -3314,6 +3326,12 @@ module Aws::CognitoIdentityProvider
|
|
3314
3326
|
# @!attribute [rw] analytics_configuration
|
3315
3327
|
# The Amazon Pinpoint analytics configuration for collecting metrics
|
3316
3328
|
# for this user pool.
|
3329
|
+
#
|
3330
|
+
# <note markdown="1"> Cognito User Pools only supports sending events to Amazon Pinpoint
|
3331
|
+
# projects in the US East (N. Virginia) us-east-1 Region, regardless
|
3332
|
+
# of the region in which the user pool resides.
|
3333
|
+
#
|
3334
|
+
# </note>
|
3317
3335
|
# @return [Types::AnalyticsConfigurationType]
|
3318
3336
|
#
|
3319
3337
|
# @!attribute [rw] prevent_user_existence_errors
|
@@ -4548,11 +4566,17 @@ module Aws::CognitoIdentityProvider
|
|
4548
4566
|
# The risk level.
|
4549
4567
|
# @return [String]
|
4550
4568
|
#
|
4569
|
+
# @!attribute [rw] compromised_credentials_detected
|
4570
|
+
# Indicates whether compromised credentials were detected during an
|
4571
|
+
# authentication event.
|
4572
|
+
# @return [Boolean]
|
4573
|
+
#
|
4551
4574
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/EventRiskType AWS API Documentation
|
4552
4575
|
#
|
4553
4576
|
class EventRiskType < Struct.new(
|
4554
4577
|
:risk_decision,
|
4555
|
-
:risk_level
|
4578
|
+
:risk_level,
|
4579
|
+
:compromised_credentials_detected)
|
4556
4580
|
include Aws::Structure
|
4557
4581
|
end
|
4558
4582
|
|
@@ -8723,6 +8747,12 @@ module Aws::CognitoIdentityProvider
|
|
8723
8747
|
# @!attribute [rw] analytics_configuration
|
8724
8748
|
# The Amazon Pinpoint analytics configuration for collecting metrics
|
8725
8749
|
# for this user pool.
|
8750
|
+
#
|
8751
|
+
# <note markdown="1"> Cognito User Pools only supports sending events to Amazon Pinpoint
|
8752
|
+
# projects in the US East (N. Virginia) us-east-1 Region, regardless
|
8753
|
+
# of the region in which the user pool resides.
|
8754
|
+
#
|
8755
|
+
# </note>
|
8726
8756
|
# @return [Types::AnalyticsConfigurationType]
|
8727
8757
|
#
|
8728
8758
|
# @!attribute [rw] prevent_user_existence_errors
|
@@ -9447,6 +9477,12 @@ module Aws::CognitoIdentityProvider
|
|
9447
9477
|
# @!attribute [rw] analytics_configuration
|
9448
9478
|
# The Amazon Pinpoint analytics configuration for the user pool
|
9449
9479
|
# client.
|
9480
|
+
#
|
9481
|
+
# <note markdown="1"> Cognito User Pools only supports sending events to Amazon Pinpoint
|
9482
|
+
# projects in the US East (N. Virginia) us-east-1 Region, regardless
|
9483
|
+
# of the region in which the user pool resides.
|
9484
|
+
#
|
9485
|
+
# </note>
|
9450
9486
|
# @return [Types::AnalyticsConfigurationType]
|
9451
9487
|
#
|
9452
9488
|
# @!attribute [rw] prevent_user_existence_errors
|
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.
|
4
|
+
version: 1.37.1
|
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-
|
11
|
+
date: 2020-06-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.99.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.99.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
81
81
|
version: '0'
|
82
82
|
requirements: []
|
83
83
|
rubyforge_project:
|
84
|
-
rubygems_version: 2.
|
84
|
+
rubygems_version: 2.7.6.2
|
85
85
|
signing_key:
|
86
86
|
specification_version: 4
|
87
87
|
summary: AWS SDK for Ruby - Amazon Cognito Identity Provider
|