aws-sdk-cognitoidentityprovider 1.31.0 → 1.36.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: 578f7d94326ca7c6330d2fe103763deab0ac2a0e
4
- data.tar.gz: 827cb1755e2cacca7d4e20b308b41c3225bf160b
2
+ SHA256:
3
+ metadata.gz: f3cabfe2f83422710ee9a722d7265330a262ab979fd344e149d843d0271e818b
4
+ data.tar.gz: 71f795792b804f33790eecd112c4568d97e8fd5f6c13213532419af28add22ff
5
5
  SHA512:
6
- metadata.gz: 6bb8b9eb46d02d64cf7b185c5f4ac8efd88b1ea4fac04f94a66b26c8a6104b50f916828628f04b07196fdb3c26f6911a5d0588736ab459a52079edfb781e9651
7
- data.tar.gz: 8a82815bc9182b9267c9c5b8e16208108963990e737ee6b2707dd6052d20ec9f312c3cb7fc96f7ec684e4e0f845d89e7bda62007c2fa91431cf6062ede5f66b6
6
+ metadata.gz: dc59315647b9aceabcc662247421b226318d63063ab6a386a4962c9850622cf3d6b0b4e36741d9accfcbeb5b383c0b8a03daa9bef8b8e89bc014d820a886056a
7
+ data.tar.gz: 7116ed411ace31fb7bbf60cb8972a11e9dd654732aa8ada8df6124d3f8c14292e2b31691d7a48d3cb9d05ffa48b3355989c2c171284fc080d9e9e3024474d26c
@@ -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.31.0'
48
+ GEM_VERSION = '1.36.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
@@ -93,7 +105,7 @@ module Aws::CognitoIdentityProvider
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -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.
@@ -139,7 +161,7 @@ module Aws::CognitoIdentityProvider
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::CognitoIdentityProvider
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -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,30 @@ 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
+ #
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
  #
@@ -219,16 +274,15 @@ module Aws::CognitoIdentityProvider
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # 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}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::CognitoIdentityProvider
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -1086,7 +1140,7 @@ module Aws::CognitoIdentityProvider
1086
1140
  # client_id: "ClientIdType", # required
1087
1141
  # auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH
1088
1142
  # auth_parameters: {
1089
- # "StringType" => "StringType",
1143
+ # "StringType" => "AuthParametersValueType",
1090
1144
  # },
1091
1145
  # client_metadata: {
1092
1146
  # "StringType" => "StringType",
@@ -1300,6 +1354,8 @@ module Aws::CognitoIdentityProvider
1300
1354
  # * {Types::AdminListGroupsForUserResponse#groups #groups} => Array&lt;Types::GroupType&gt;
1301
1355
  # * {Types::AdminListGroupsForUserResponse#next_token #next_token} => String
1302
1356
  #
1357
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1358
+ #
1303
1359
  # @example Request syntax with placeholder values
1304
1360
  #
1305
1361
  # resp = client.admin_list_groups_for_user({
@@ -1350,6 +1406,8 @@ module Aws::CognitoIdentityProvider
1350
1406
  # * {Types::AdminListUserAuthEventsResponse#auth_events #auth_events} => Array&lt;Types::AuthEventType&gt;
1351
1407
  # * {Types::AdminListUserAuthEventsResponse#next_token #next_token} => String
1352
1408
  #
1409
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1410
+ #
1353
1411
  # @example Request syntax with placeholder values
1354
1412
  #
1355
1413
  # resp = client.admin_list_user_auth_events({
@@ -1368,6 +1426,7 @@ module Aws::CognitoIdentityProvider
1368
1426
  # resp.auth_events[0].event_response #=> String, one of "Success", "Failure"
1369
1427
  # resp.auth_events[0].event_risk.risk_decision #=> String, one of "NoRisk", "AccountTakeover", "Block"
1370
1428
  # resp.auth_events[0].event_risk.risk_level #=> String, one of "Low", "Medium", "High"
1429
+ # resp.auth_events[0].event_risk.compromised_credentials_detected #=> Boolean
1371
1430
  # resp.auth_events[0].challenge_responses #=> Array
1372
1431
  # resp.auth_events[0].challenge_responses[0].challenge_name #=> String, one of "Password", "Mfa"
1373
1432
  # resp.auth_events[0].challenge_responses[0].challenge_response #=> String, one of "Success", "Failure"
@@ -2380,8 +2439,60 @@ module Aws::CognitoIdentityProvider
2380
2439
  # The identity provider type.
2381
2440
  #
2382
2441
  # @option params [required, Hash<String,String>] :provider_details
2383
- # The identity provider details, such as `MetadataURL` and
2384
- # `MetadataFile`.
2442
+ # The identity provider details. The following list describes the
2443
+ # provider detail keys for each identity provider type.
2444
+ #
2445
+ # * For Google, Facebook and Login with Amazon:
2446
+ #
2447
+ # * client\_id
2448
+ #
2449
+ # * client\_secret
2450
+ #
2451
+ # * authorize\_scopes
2452
+ #
2453
+ # * For Sign in with Apple:
2454
+ #
2455
+ # * client\_id
2456
+ #
2457
+ # * team\_id
2458
+ #
2459
+ # * key\_id
2460
+ #
2461
+ # * private\_key
2462
+ #
2463
+ # * authorize\_scopes
2464
+ #
2465
+ # * For OIDC providers:
2466
+ #
2467
+ # * client\_id
2468
+ #
2469
+ # * client\_secret
2470
+ #
2471
+ # * attributes\_request\_method
2472
+ #
2473
+ # * oidc\_issuer
2474
+ #
2475
+ # * authorize\_scopes
2476
+ #
2477
+ # * authorize\_url *if not available from discovery URL specified by
2478
+ # oidc\_issuer key*
2479
+ #
2480
+ # * token\_url *if not available from discovery URL specified by
2481
+ # oidc\_issuer key*
2482
+ #
2483
+ # * attributes\_url *if not available from discovery URL specified by
2484
+ # oidc\_issuer key*
2485
+ #
2486
+ # * jwks\_uri *if not available from discovery URL specified by
2487
+ # oidc\_issuer key*
2488
+ #
2489
+ # * authorize\_scopes
2490
+ #
2491
+ # * For SAML providers:
2492
+ #
2493
+ # * MetadataFile OR MetadataURL
2494
+ #
2495
+ # * IDPSignout *optional*
2385
2496
  #
2386
2497
  # @option params [Hash<String,String>] :attribute_mapping
2387
2498
  # A mapping of identity provider attributes to standard and custom user
@@ -2623,6 +2734,13 @@ module Aws::CognitoIdentityProvider
2623
2734
  # Used to enable advanced security risk detection. Set the key
2624
2735
  # `AdvancedSecurityMode` to the value "AUDIT".
2625
2736
  #
2737
+ # @option params [Types::UsernameConfigurationType] :username_configuration
2738
+ # You can choose to set case sensitivity on the username input for the
2739
+ # selected sign-in option. For example, when this is set to `False`,
2740
+ # users will be able to sign in using either "username" or
2741
+ # "Username". This configuration is immutable once it has been set.
2742
+ # For more information, see .
2743
+ #
2626
2744
  # @option params [Types::AccountRecoverySettingType] :account_recovery_setting
2627
2745
  # Use this setting to define which verified available method a user can
2628
2746
  # use to recover their password when they call `ForgotPassword`. It
@@ -2731,6 +2849,9 @@ module Aws::CognitoIdentityProvider
2731
2849
  # user_pool_add_ons: {
2732
2850
  # advanced_security_mode: "OFF", # required, accepts OFF, AUDIT, ENFORCED
2733
2851
  # },
2852
+ # username_configuration: {
2853
+ # case_sensitive: false, # required
2854
+ # },
2734
2855
  # account_recovery_setting: {
2735
2856
  # recovery_mechanisms: [
2736
2857
  # {
@@ -2813,6 +2934,7 @@ module Aws::CognitoIdentityProvider
2813
2934
  # resp.user_pool.admin_create_user_config.invite_message_template.email_message #=> String
2814
2935
  # resp.user_pool.admin_create_user_config.invite_message_template.email_subject #=> String
2815
2936
  # resp.user_pool.user_pool_add_ons.advanced_security_mode #=> String, one of "OFF", "AUDIT", "ENFORCED"
2937
+ # resp.user_pool.username_configuration.case_sensitive #=> Boolean
2816
2938
  # resp.user_pool.arn #=> String
2817
2939
  # resp.user_pool.account_recovery_setting.recovery_mechanisms #=> Array
2818
2940
  # resp.user_pool.account_recovery_setting.recovery_mechanisms[0].priority #=> Integer
@@ -2941,27 +3063,39 @@ module Aws::CognitoIdentityProvider
2941
3063
  # [1]: https://tools.ietf.org/html/rfc6749#section-3.1.2
2942
3064
  #
2943
3065
  # @option params [Array<String>] :allowed_o_auth_flows
3066
+ # The allowed OAuth flows.
3067
+ #
2944
3068
  # Set to `code` to initiate a code grant flow, which provides an
2945
3069
  # authorization code as the response. This code can be exchanged for
2946
3070
  # access tokens with the token endpoint.
2947
3071
  #
2948
- # Set to `token` to specify that the client should get the access token
2949
- # (and, optionally, ID token, based on scopes) directly.
3072
+ # Set to `implicit` to specify that the client should get the access
3073
+ # token (and, optionally, ID token, based on scopes) directly.
3074
+ #
3075
+ # Set to `client_credentials` to specify that the client should get the
3076
+ # access token (and, optionally, ID token, based on scopes) from the
3077
+ # token endpoint using a combination of client and client\_secret.
2950
3078
  #
2951
3079
  # @option params [Array<String>] :allowed_o_auth_scopes
2952
- # A list of allowed `OAuth` scopes. Currently supported values are
2953
- # `"phone"`, `"email"`, `"openid"`, and `"Cognito"`. In addition to
2954
- # these values, custom scopes created in Resource Servers are also
2955
- # supported.
3080
+ # The allowed OAuth scopes. Possible values provided by OAuth are:
3081
+ # `phone`, `email`, `openid`, and `profile`. Possible values provided by
3082
+ # AWS are: `aws.cognito.signin.user.admin`. Custom scopes created in
3083
+ # Resource Servers are also supported.
2956
3084
  #
2957
3085
  # @option params [Boolean] :allowed_o_auth_flows_user_pool_client
2958
- # Set to `True` if the client is allowed to follow the OAuth protocol
2959
- # when interacting with Cognito user pools.
3086
+ # Set to true if the client is allowed to follow the OAuth protocol when
3087
+ # interacting with Cognito user pools.
2960
3088
  #
2961
3089
  # @option params [Types::AnalyticsConfigurationType] :analytics_configuration
2962
3090
  # The Amazon Pinpoint analytics configuration for collecting metrics for
2963
3091
  # this user pool.
2964
3092
  #
3093
+ # <note markdown="1"> Cognito User Pools only supports sending events to Amazon Pinpoint
3094
+ # projects in the US East (N. Virginia) us-east-1 Region, regardless of
3095
+ # the region in which the user pool resides.
3096
+ #
3097
+ # </note>
3098
+ #
2965
3099
  # @option params [String] :prevent_user_existence_errors
2966
3100
  # Use this setting to choose which errors and responses are returned by
2967
3101
  # Cognito APIs during authentication, account confirmation, and password
@@ -2998,9 +3132,9 @@ module Aws::CognitoIdentityProvider
2998
3132
  #
2999
3133
  # * ResendConfirmationCode
3000
3134
  #
3001
- # <note markdown="1"> After January 1st 2020, the value of `PreventUserExistenceErrors` will
3002
- # default to `ENABLED` for newly created user pool clients if no value
3003
- # is provided.
3135
+ # <note markdown="1"> After February 15th 2020, the value of `PreventUserExistenceErrors`
3136
+ # will default to `ENABLED` for newly created user pool clients if no
3137
+ # value is provided.
3004
3138
  #
3005
3139
  # </note>
3006
3140
  #
@@ -3604,6 +3738,7 @@ module Aws::CognitoIdentityProvider
3604
3738
  # resp.user_pool.admin_create_user_config.invite_message_template.email_message #=> String
3605
3739
  # resp.user_pool.admin_create_user_config.invite_message_template.email_subject #=> String
3606
3740
  # resp.user_pool.user_pool_add_ons.advanced_security_mode #=> String, one of "OFF", "AUDIT", "ENFORCED"
3741
+ # resp.user_pool.username_configuration.case_sensitive #=> Boolean
3607
3742
  # resp.user_pool.arn #=> String
3608
3743
  # resp.user_pool.account_recovery_setting.recovery_mechanisms #=> Array
3609
3744
  # resp.user_pool.account_recovery_setting.recovery_mechanisms[0].priority #=> Integer
@@ -3743,13 +3878,13 @@ module Aws::CognitoIdentityProvider
3743
3878
 
3744
3879
  # Calling this API causes a message to be sent to the end user with a
3745
3880
  # confirmation code that is required to change the user's password. For
3746
- # the `Username` parameter, you can use the username or user alias. If a
3747
- # verified phone number exists for the user, the confirmation code is
3748
- # sent to the phone number. Otherwise, if a verified email exists, the
3749
- # confirmation code is sent to the email. If neither a verified phone
3750
- # number nor a verified email exists, `InvalidParameterException` is
3751
- # thrown. To use the confirmation code for resetting the password, call
3752
- # .
3881
+ # the `Username` parameter, you can use the username or user alias. The
3882
+ # method used to send the confirmation code is sent according to the
3883
+ # specified AccountRecoverySetting. For more information, see
3884
+ # [Recovering User Accounts]() in the *Amazon Cognito Developer Guide*.
3885
+ # If neither a verified phone number nor a verified email exists, an
3886
+ # `InvalidParameterException` is thrown. To use the confirmation code
3887
+ # for resetting the password, call .
3753
3888
  #
3754
3889
  # @option params [required, String] :client_id
3755
3890
  # The ID of the client associated with the user pool.
@@ -4389,7 +4524,7 @@ module Aws::CognitoIdentityProvider
4389
4524
  # resp = client.initiate_auth({
4390
4525
  # auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH
4391
4526
  # auth_parameters: {
4392
- # "StringType" => "StringType",
4527
+ # "StringType" => "AuthParametersValueType",
4393
4528
  # },
4394
4529
  # client_metadata: {
4395
4530
  # "StringType" => "StringType",
@@ -4491,6 +4626,8 @@ module Aws::CognitoIdentityProvider
4491
4626
  # * {Types::ListGroupsResponse#groups #groups} => Array&lt;Types::GroupType&gt;
4492
4627
  # * {Types::ListGroupsResponse#next_token #next_token} => String
4493
4628
  #
4629
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4630
+ #
4494
4631
  # @example Request syntax with placeholder values
4495
4632
  #
4496
4633
  # resp = client.list_groups({
@@ -4536,6 +4673,8 @@ module Aws::CognitoIdentityProvider
4536
4673
  # * {Types::ListIdentityProvidersResponse#providers #providers} => Array&lt;Types::ProviderDescription&gt;
4537
4674
  # * {Types::ListIdentityProvidersResponse#next_token #next_token} => String
4538
4675
  #
4676
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4677
+ #
4539
4678
  # @example Request syntax with placeholder values
4540
4679
  #
4541
4680
  # resp = client.list_identity_providers({
@@ -4578,6 +4717,8 @@ module Aws::CognitoIdentityProvider
4578
4717
  # * {Types::ListResourceServersResponse#resource_servers #resource_servers} => Array&lt;Types::ResourceServerType&gt;
4579
4718
  # * {Types::ListResourceServersResponse#next_token #next_token} => String
4580
4719
  #
4720
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4721
+ #
4581
4722
  # @example Request syntax with placeholder values
4582
4723
  #
4583
4724
  # resp = client.list_resource_servers({
@@ -4716,6 +4857,8 @@ module Aws::CognitoIdentityProvider
4716
4857
  # * {Types::ListUserPoolClientsResponse#user_pool_clients #user_pool_clients} => Array&lt;Types::UserPoolClientDescription&gt;
4717
4858
  # * {Types::ListUserPoolClientsResponse#next_token #next_token} => String
4718
4859
  #
4860
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4861
+ #
4719
4862
  # @example Request syntax with placeholder values
4720
4863
  #
4721
4864
  # resp = client.list_user_pool_clients({
@@ -4757,6 +4900,8 @@ module Aws::CognitoIdentityProvider
4757
4900
  # * {Types::ListUserPoolsResponse#user_pools #user_pools} => Array&lt;Types::UserPoolDescriptionType&gt;
4758
4901
  # * {Types::ListUserPoolsResponse#next_token #next_token} => String
4759
4902
  #
4903
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4904
+ #
4760
4905
  # @example Request syntax with placeholder values
4761
4906
  #
4762
4907
  # resp = client.list_user_pools({
@@ -4870,6 +5015,8 @@ module Aws::CognitoIdentityProvider
4870
5015
  # * {Types::ListUsersResponse#users #users} => Array&lt;Types::UserType&gt;
4871
5016
  # * {Types::ListUsersResponse#pagination_token #pagination_token} => String
4872
5017
  #
5018
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5019
+ #
4873
5020
  # @example Request syntax with placeholder values
4874
5021
  #
4875
5022
  # resp = client.list_users({
@@ -4928,6 +5075,8 @@ module Aws::CognitoIdentityProvider
4928
5075
  # * {Types::ListUsersInGroupResponse#users #users} => Array&lt;Types::UserType&gt;
4929
5076
  # * {Types::ListUsersInGroupResponse#next_token #next_token} => String
4930
5077
  #
5078
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5079
+ #
4931
5080
  # @example Request syntax with placeholder values
4932
5081
  #
4933
5082
  # resp = client.list_users_in_group({
@@ -6414,24 +6563,39 @@ module Aws::CognitoIdentityProvider
6414
6563
  # [1]: https://tools.ietf.org/html/rfc6749#section-3.1.2
6415
6564
  #
6416
6565
  # @option params [Array<String>] :allowed_o_auth_flows
6566
+ # The allowed OAuth flows.
6567
+ #
6417
6568
  # Set to `code` to initiate a code grant flow, which provides an
6418
6569
  # authorization code as the response. This code can be exchanged for
6419
6570
  # access tokens with the token endpoint.
6420
6571
  #
6572
+ # Set to `implicit` to specify that the client should get the access
6573
+ # token (and, optionally, ID token, based on scopes) directly.
6574
+ #
6575
+ # Set to `client_credentials` to specify that the client should get the
6576
+ # access token (and, optionally, ID token, based on scopes) from the
6577
+ # token endpoint using a combination of client and client\_secret.
6578
+ #
6421
6579
  # @option params [Array<String>] :allowed_o_auth_scopes
6422
- # A list of allowed `OAuth` scopes. Currently supported values are
6423
- # `"phone"`, `"email"`, `"openid"`, and `"Cognito"`. In addition to
6424
- # these values, custom scopes created in Resource Servers are also
6425
- # supported.
6580
+ # The allowed OAuth scopes. Possible values provided by OAuth are:
6581
+ # `phone`, `email`, `openid`, and `profile`. Possible values provided by
6582
+ # AWS are: `aws.cognito.signin.user.admin`. Custom scopes created in
6583
+ # Resource Servers are also supported.
6426
6584
  #
6427
6585
  # @option params [Boolean] :allowed_o_auth_flows_user_pool_client
6428
- # Set to TRUE if the client is allowed to follow the OAuth protocol when
6586
+ # Set to true if the client is allowed to follow the OAuth protocol when
6429
6587
  # interacting with Cognito user pools.
6430
6588
  #
6431
6589
  # @option params [Types::AnalyticsConfigurationType] :analytics_configuration
6432
6590
  # The Amazon Pinpoint analytics configuration for collecting metrics for
6433
6591
  # this user pool.
6434
6592
  #
6593
+ # <note markdown="1"> Cognito User Pools only supports sending events to Amazon Pinpoint
6594
+ # projects in the US East (N. Virginia) us-east-1 Region, regardless of
6595
+ # the region in which the user pool resides.
6596
+ #
6597
+ # </note>
6598
+ #
6435
6599
  # @option params [String] :prevent_user_existence_errors
6436
6600
  # Use this setting to choose which errors and responses are returned by
6437
6601
  # Cognito APIs during authentication, account confirmation, and password
@@ -6468,9 +6632,9 @@ module Aws::CognitoIdentityProvider
6468
6632
  #
6469
6633
  # * ResendConfirmationCode
6470
6634
  #
6471
- # <note markdown="1"> After January 1st 2020, the value of `PreventUserExistenceErrors` will
6472
- # default to `ENABLED` for newly created user pool clients if no value
6473
- # is provided.
6635
+ # <note markdown="1"> After February 15th 2020, the value of `PreventUserExistenceErrors`
6636
+ # will default to `ENABLED` for newly created user pool clients if no
6637
+ # value is provided.
6474
6638
  #
6475
6639
  # </note>
6476
6640
  #
@@ -6713,7 +6877,7 @@ module Aws::CognitoIdentityProvider
6713
6877
  params: params,
6714
6878
  config: config)
6715
6879
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
6716
- context[:gem_version] = '1.31.0'
6880
+ context[:gem_version] = '1.36.0'
6717
6881
  Seahorse::Client::Request.new(handlers, context)
6718
6882
  end
6719
6883