aws-sdk-cognitoidentityprovider 1.39.0 → 1.44.0
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 +4 -4
- data/lib/aws-sdk-cognitoidentityprovider.rb +1 -1
- data/lib/aws-sdk-cognitoidentityprovider/client.rb +187 -101
- data/lib/aws-sdk-cognitoidentityprovider/client_api.rb +23 -3
- data/lib/aws-sdk-cognitoidentityprovider/customizations.rb +1 -0
- data/lib/aws-sdk-cognitoidentityprovider/types.rb +523 -130
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fc51e18f2294d37efc29cfb1fcf4bb90dc4883c012cb0aa33233e3f30b4272d3
|
4
|
+
data.tar.gz: daddd7a3daf5ba303b835aa97c5705b7219ec67487fd66434d48f848fdc45b8a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e7d7653c6dd0f4032ca8a53b392a63d6aecaad0836721b38fc187027874cc88a8e769c493f922b2844e326944c17e49ab482640007fa857db7aafe742b546d8c
|
7
|
+
data.tar.gz: 35ffbe29517a8444b546b37cf78ec689ffcaeaacd22dc6221e7c207a721c2c377b3e4af19b709c1b4166e93edc84b881222d903717dd323a9b06978a42d50ca8
|
@@ -471,19 +471,18 @@ module Aws::CognitoIdentityProvider
|
|
471
471
|
# If `MessageAction` is not set, the default is to send a welcome
|
472
472
|
# message via email or phone (SMS).
|
473
473
|
#
|
474
|
-
#
|
475
|
-
# to or . This template includes your custom
|
476
|
-
# placeholders for user name and temporary
|
477
|
-
#
|
478
|
-
# </note>
|
474
|
+
# This message is based on a template that you configured in your call
|
475
|
+
# to create or update a user pool. This template includes your custom
|
476
|
+
# sign-up instructions and placeholders for user name and temporary
|
477
|
+
# password.
|
479
478
|
#
|
480
|
-
# Alternatively, you can call AdminCreateUser with “SUPPRESS” for the
|
479
|
+
# Alternatively, you can call `AdminCreateUser` with “SUPPRESS” for the
|
481
480
|
# `MessageAction` parameter, and Amazon Cognito will not send any email.
|
482
481
|
#
|
483
482
|
# In either case, the user will be in the `FORCE_CHANGE_PASSWORD` state
|
484
483
|
# until they sign in and change their password.
|
485
484
|
#
|
486
|
-
# AdminCreateUser requires developer credentials.
|
485
|
+
# `AdminCreateUser` requires developer credentials.
|
487
486
|
#
|
488
487
|
# @option params [required, String] :user_pool_id
|
489
488
|
# The user pool ID for the user pool where the user will be created.
|
@@ -497,10 +496,10 @@ module Aws::CognitoIdentityProvider
|
|
497
496
|
# An array of name-value pairs that contain user attributes and
|
498
497
|
# attribute values to be set for the user to be created. You can create
|
499
498
|
# a user without specifying any attributes other than `Username`.
|
500
|
-
# However, any attributes that you specify as required (
|
501
|
-
# **Attributes** tab of the console) must be
|
502
|
-
# your call to `AdminCreateUser`) or by the
|
503
|
-
# up in response to your welcome message).
|
499
|
+
# However, any attributes that you specify as required (when creating a
|
500
|
+
# user pool or in the **Attributes** tab of the console) must be
|
501
|
+
# supplied either by you (in your call to `AdminCreateUser`) or by the
|
502
|
+
# user (when he or she signs up in response to your welcome message).
|
504
503
|
#
|
505
504
|
# For custom attributes, you must prepend the `custom:` prefix to the
|
506
505
|
# attribute name.
|
@@ -512,7 +511,8 @@ module Aws::CognitoIdentityProvider
|
|
512
511
|
#
|
513
512
|
# In your call to `AdminCreateUser`, you can set the `email_verified`
|
514
513
|
# attribute to `True`, and you can set the `phone_number_verified`
|
515
|
-
# attribute to `True`. (You can also do this by calling
|
514
|
+
# attribute to `True`. (You can also do this by calling
|
515
|
+
# [AdminUpdateUserAttributes][1].)
|
516
516
|
#
|
517
517
|
# * **email**\: The email address of the user to whom the message that
|
518
518
|
# contains the code and username will be sent. Required if the
|
@@ -524,6 +524,10 @@ module Aws::CognitoIdentityProvider
|
|
524
524
|
# `phone_number_verified` attribute is set to `True`, or if `"SMS"` is
|
525
525
|
# specified in the `DesiredDeliveryMediums` parameter.
|
526
526
|
#
|
527
|
+
#
|
528
|
+
#
|
529
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html
|
530
|
+
#
|
527
531
|
# @option params [Array<Types::AttributeType>] :validation_data
|
528
532
|
# The user's validation data. This is an array of name-value pairs that
|
529
533
|
# contain user attributes and attribute values that you can use for
|
@@ -745,7 +749,7 @@ module Aws::CognitoIdentityProvider
|
|
745
749
|
# IdP user, any link between that user and an existing user is removed.
|
746
750
|
# The next time the external user (no longer attached to the previously
|
747
751
|
# linked `DestinationUser`) signs in, they must create a new user
|
748
|
-
# account. See .
|
752
|
+
# account. See [AdminLinkProviderForUser][1].
|
749
753
|
#
|
750
754
|
# This action is enabled only for admin access and requires developer
|
751
755
|
# credentials.
|
@@ -766,12 +770,16 @@ module Aws::CognitoIdentityProvider
|
|
766
770
|
# For de-linking a SAML identity, there are two scenarios. If the linked
|
767
771
|
# identity has not yet been used to sign-in, the `ProviderAttributeName`
|
768
772
|
# and `ProviderAttributeValue` must be the same values that were used
|
769
|
-
# for the `SourceUser` when the identities were originally linked
|
770
|
-
# call. (If the linking was done with
|
771
|
-
# `Cognito_Subject`, the same applies
|
772
|
-
# already signed in, the
|
773
|
-
# `
|
774
|
-
# the SAML assertion.
|
773
|
+
# for the `SourceUser` when the identities were originally linked using
|
774
|
+
# ` AdminLinkProviderForUser` call. (If the linking was done with
|
775
|
+
# `ProviderAttributeName` set to `Cognito_Subject`, the same applies
|
776
|
+
# here). However, if the user has already signed in, the
|
777
|
+
# `ProviderAttributeName` must be `Cognito_Subject` and
|
778
|
+
# `ProviderAttributeValue` must be the subject of the SAML assertion.
|
779
|
+
#
|
780
|
+
#
|
781
|
+
#
|
782
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html
|
775
783
|
#
|
776
784
|
# @option params [required, String] :user_pool_id
|
777
785
|
# The user pool ID for the user pool.
|
@@ -1045,18 +1053,20 @@ module Aws::CognitoIdentityProvider
|
|
1045
1053
|
#
|
1046
1054
|
# * For `USER_SRP_AUTH`\: `USERNAME` (required), `SRP_A` (required),
|
1047
1055
|
# `SECRET_HASH` (required if the app client is configured with a
|
1048
|
-
# client secret), `DEVICE_KEY
|
1056
|
+
# client secret), `DEVICE_KEY`.
|
1049
1057
|
#
|
1050
1058
|
# * For `REFRESH_TOKEN_AUTH/REFRESH_TOKEN`\: `REFRESH_TOKEN` (required),
|
1051
1059
|
# `SECRET_HASH` (required if the app client is configured with a
|
1052
|
-
# client secret), `DEVICE_KEY
|
1060
|
+
# client secret), `DEVICE_KEY`.
|
1053
1061
|
#
|
1054
1062
|
# * For `ADMIN_NO_SRP_AUTH`\: `USERNAME` (required), `SECRET_HASH` (if
|
1055
1063
|
# app client is configured with client secret), `PASSWORD` (required),
|
1056
|
-
# `DEVICE_KEY
|
1064
|
+
# `DEVICE_KEY`.
|
1057
1065
|
#
|
1058
1066
|
# * For `CUSTOM_AUTH`\: `USERNAME` (required), `SECRET_HASH` (if app
|
1059
|
-
# client is configured with client secret), `DEVICE_KEY
|
1067
|
+
# client is configured with client secret), `DEVICE_KEY`. To start the
|
1068
|
+
# authentication flow with password verification, include
|
1069
|
+
# `ChallengeName: SRP_A` and `SRP_A: (The SRP_A Value)`.
|
1060
1070
|
#
|
1061
1071
|
# @option params [Hash<String,String>] :client_metadata
|
1062
1072
|
# A map of custom key-value pairs that you can provide as input for
|
@@ -1202,13 +1212,15 @@ module Aws::CognitoIdentityProvider
|
|
1202
1212
|
# that when the federated user identity is used, the user signs in as
|
1203
1213
|
# the existing user account.
|
1204
1214
|
#
|
1215
|
+
# <note markdown="1"> The maximum number of federated identities linked to a user is 5.
|
1216
|
+
#
|
1217
|
+
# </note>
|
1218
|
+
#
|
1205
1219
|
# Because this API allows a user with an external federated identity to
|
1206
1220
|
# sign in as an existing user in the user pool, it is critical that it
|
1207
1221
|
# only be used with external identity providers and provider attributes
|
1208
1222
|
# that have been trusted by the application owner.
|
1209
1223
|
#
|
1210
|
-
# See also .
|
1211
|
-
#
|
1212
1224
|
# This action is enabled only for admin access and requires developer
|
1213
1225
|
# credentials.
|
1214
1226
|
#
|
@@ -1578,7 +1590,11 @@ module Aws::CognitoIdentityProvider
|
|
1578
1590
|
# The app client ID.
|
1579
1591
|
#
|
1580
1592
|
# @option params [required, String] :challenge_name
|
1581
|
-
# The challenge name. For more information, see .
|
1593
|
+
# The challenge name. For more information, see [AdminInitiateAuth][1].
|
1594
|
+
#
|
1595
|
+
#
|
1596
|
+
#
|
1597
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html
|
1582
1598
|
#
|
1583
1599
|
# @option params [Hash<String,String>] :challenge_responses
|
1584
1600
|
# The challenge responses. These are inputs corresponding to the value
|
@@ -1816,9 +1832,13 @@ module Aws::CognitoIdentityProvider
|
|
1816
1832
|
|
1817
1833
|
# *This action is no longer supported.* You can use it to configure only
|
1818
1834
|
# SMS MFA. You can't use it to configure TOTP software token MFA. To
|
1819
|
-
# configure either type of MFA, use
|
1835
|
+
# configure either type of MFA, use [AdminSetUserMFAPreference][1]
|
1820
1836
|
# instead.
|
1821
1837
|
#
|
1838
|
+
#
|
1839
|
+
#
|
1840
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html
|
1841
|
+
#
|
1822
1842
|
# @option params [required, String] :user_pool_id
|
1823
1843
|
# The ID of the user pool that contains the user that you are setting
|
1824
1844
|
# options for.
|
@@ -2176,7 +2196,11 @@ module Aws::CognitoIdentityProvider
|
|
2176
2196
|
#
|
2177
2197
|
# @option params [required, String] :confirmation_code
|
2178
2198
|
# The confirmation code sent by a user's request to retrieve a
|
2179
|
-
# forgotten password. For more information, see
|
2199
|
+
# forgotten password. For more information, see [ForgotPassword][1].
|
2200
|
+
#
|
2201
|
+
#
|
2202
|
+
#
|
2203
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html
|
2180
2204
|
#
|
2181
2205
|
# @option params [required, String] :password
|
2182
2206
|
# The password sent by a user's request to retrieve a forgotten
|
@@ -2446,7 +2470,7 @@ module Aws::CognitoIdentityProvider
|
|
2446
2470
|
# The identity provider details. The following list describes the
|
2447
2471
|
# provider detail keys for each identity provider type.
|
2448
2472
|
#
|
2449
|
-
# * For Google
|
2473
|
+
# * For Google and Login with Amazon:
|
2450
2474
|
#
|
2451
2475
|
# * client\_id
|
2452
2476
|
#
|
@@ -2454,6 +2478,16 @@ module Aws::CognitoIdentityProvider
|
|
2454
2478
|
#
|
2455
2479
|
# * authorize\_scopes
|
2456
2480
|
#
|
2481
|
+
# * For Facebook:
|
2482
|
+
#
|
2483
|
+
# * client\_id
|
2484
|
+
#
|
2485
|
+
# * client\_secret
|
2486
|
+
#
|
2487
|
+
# * authorize\_scopes
|
2488
|
+
#
|
2489
|
+
# * api\_version
|
2490
|
+
#
|
2457
2491
|
# * For Sign in with Apple:
|
2458
2492
|
#
|
2459
2493
|
# * client\_id
|
@@ -2490,8 +2524,6 @@ module Aws::CognitoIdentityProvider
|
|
2490
2524
|
# * jwks\_uri *if not available from discovery URL specified by
|
2491
2525
|
# oidc\_issuer key*
|
2492
2526
|
#
|
2493
|
-
# * authorize\_scopes
|
2494
|
-
#
|
2495
2527
|
# * For SAML providers:
|
2496
2528
|
#
|
2497
2529
|
# * MetadataFile OR MetadataURL
|
@@ -2743,7 +2775,11 @@ module Aws::CognitoIdentityProvider
|
|
2743
2775
|
# selected sign-in option. For example, when this is set to `False`,
|
2744
2776
|
# users will be able to sign in using either "username" or
|
2745
2777
|
# "Username". This configuration is immutable once it has been set.
|
2746
|
-
# For more information, see .
|
2778
|
+
# For more information, see [UsernameConfigurationType][1].
|
2779
|
+
#
|
2780
|
+
#
|
2781
|
+
#
|
2782
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html
|
2747
2783
|
#
|
2748
2784
|
# @option params [Types::AccountRecoverySettingType] :account_recovery_setting
|
2749
2785
|
# Use this setting to define which verified available method a user can
|
@@ -2754,12 +2790,6 @@ module Aws::CognitoIdentityProvider
|
|
2754
2790
|
# the absence of this setting, Cognito uses the legacy behavior to
|
2755
2791
|
# determine the recovery method where SMS is preferred over email.
|
2756
2792
|
#
|
2757
|
-
# <note markdown="1"> Starting February 1, 2020, the value of `AccountRecoverySetting` will
|
2758
|
-
# default to `verified_email` first and `verified_phone_number` as the
|
2759
|
-
# second option for newly created user pools if no value is provided.
|
2760
|
-
#
|
2761
|
-
# </note>
|
2762
|
-
#
|
2763
2793
|
# @return [Types::CreateUserPoolResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2764
2794
|
#
|
2765
2795
|
# * {Types::CreateUserPoolResponse#user_pool #user_pool} => Types::UserPoolType
|
@@ -2970,6 +3000,20 @@ module Aws::CognitoIdentityProvider
|
|
2970
3000
|
# The time limit, in days, after which the refresh token is no longer
|
2971
3001
|
# valid and cannot be used.
|
2972
3002
|
#
|
3003
|
+
# @option params [Integer] :access_token_validity
|
3004
|
+
# The time limit, between 5 minutes and 1 day, after which the access
|
3005
|
+
# token is no longer valid and cannot be used. This value will be
|
3006
|
+
# overridden if you have entered a value in TokenValidityUnits.
|
3007
|
+
#
|
3008
|
+
# @option params [Integer] :id_token_validity
|
3009
|
+
# The time limit, between 5 minutes and 1 day, after which the ID token
|
3010
|
+
# is no longer valid and cannot be used. This value will be overridden
|
3011
|
+
# if you have entered a value in TokenValidityUnits.
|
3012
|
+
#
|
3013
|
+
# @option params [Types::TokenValidityUnitsType] :token_validity_units
|
3014
|
+
# The units in which the validity times are represented in. Default for
|
3015
|
+
# RefreshToken is days, and default for ID and access tokens are hours.
|
3016
|
+
#
|
2973
3017
|
# @option params [Array<String>] :read_attributes
|
2974
3018
|
# The read attributes.
|
2975
3019
|
#
|
@@ -3094,9 +3138,10 @@ module Aws::CognitoIdentityProvider
|
|
3094
3138
|
# The Amazon Pinpoint analytics configuration for collecting metrics for
|
3095
3139
|
# this user pool.
|
3096
3140
|
#
|
3097
|
-
# <note markdown="1">
|
3098
|
-
#
|
3099
|
-
#
|
3141
|
+
# <note markdown="1"> In regions where Pinpoint is not available, Cognito User Pools only
|
3142
|
+
# supports sending events to Amazon Pinpoint projects in us-east-1. In
|
3143
|
+
# regions where Pinpoint is available, Cognito User Pools will support
|
3144
|
+
# sending events to Amazon Pinpoint projects within that same region.
|
3100
3145
|
#
|
3101
3146
|
# </note>
|
3102
3147
|
#
|
@@ -3118,24 +3163,6 @@ module Aws::CognitoIdentityProvider
|
|
3118
3163
|
# * `LEGACY` - This represents the old behavior of Cognito where user
|
3119
3164
|
# existence related errors are not prevented.
|
3120
3165
|
#
|
3121
|
-
# This setting affects the behavior of following APIs:
|
3122
|
-
#
|
3123
|
-
# * AdminInitiateAuth
|
3124
|
-
#
|
3125
|
-
# * AdminRespondToAuthChallenge
|
3126
|
-
#
|
3127
|
-
# * InitiateAuth
|
3128
|
-
#
|
3129
|
-
# * RespondToAuthChallenge
|
3130
|
-
#
|
3131
|
-
# * ForgotPassword
|
3132
|
-
#
|
3133
|
-
# * ConfirmForgotPassword
|
3134
|
-
#
|
3135
|
-
# * ConfirmSignUp
|
3136
|
-
#
|
3137
|
-
# * ResendConfirmationCode
|
3138
|
-
#
|
3139
3166
|
# <note markdown="1"> After February 15th 2020, the value of `PreventUserExistenceErrors`
|
3140
3167
|
# will default to `ENABLED` for newly created user pool clients if no
|
3141
3168
|
# value is provided.
|
@@ -3153,6 +3180,13 @@ module Aws::CognitoIdentityProvider
|
|
3153
3180
|
# client_name: "ClientNameType", # required
|
3154
3181
|
# generate_secret: false,
|
3155
3182
|
# refresh_token_validity: 1,
|
3183
|
+
# access_token_validity: 1,
|
3184
|
+
# id_token_validity: 1,
|
3185
|
+
# token_validity_units: {
|
3186
|
+
# access_token: "seconds", # accepts seconds, minutes, hours, days
|
3187
|
+
# id_token: "seconds", # accepts seconds, minutes, hours, days
|
3188
|
+
# refresh_token: "seconds", # accepts seconds, minutes, hours, days
|
3189
|
+
# },
|
3156
3190
|
# read_attributes: ["ClientPermissionType"],
|
3157
3191
|
# write_attributes: ["ClientPermissionType"],
|
3158
3192
|
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH
|
@@ -3164,9 +3198,10 @@ module Aws::CognitoIdentityProvider
|
|
3164
3198
|
# allowed_o_auth_scopes: ["ScopeType"],
|
3165
3199
|
# allowed_o_auth_flows_user_pool_client: false,
|
3166
3200
|
# analytics_configuration: {
|
3167
|
-
# application_id: "HexStringType",
|
3168
|
-
#
|
3169
|
-
#
|
3201
|
+
# application_id: "HexStringType",
|
3202
|
+
# application_arn: "ArnType",
|
3203
|
+
# role_arn: "ArnType",
|
3204
|
+
# external_id: "StringType",
|
3170
3205
|
# user_data_shared: false,
|
3171
3206
|
# },
|
3172
3207
|
# prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
|
@@ -3181,6 +3216,11 @@ module Aws::CognitoIdentityProvider
|
|
3181
3216
|
# resp.user_pool_client.last_modified_date #=> Time
|
3182
3217
|
# resp.user_pool_client.creation_date #=> Time
|
3183
3218
|
# resp.user_pool_client.refresh_token_validity #=> Integer
|
3219
|
+
# resp.user_pool_client.access_token_validity #=> Integer
|
3220
|
+
# resp.user_pool_client.id_token_validity #=> Integer
|
3221
|
+
# resp.user_pool_client.token_validity_units.access_token #=> String, one of "seconds", "minutes", "hours", "days"
|
3222
|
+
# resp.user_pool_client.token_validity_units.id_token #=> String, one of "seconds", "minutes", "hours", "days"
|
3223
|
+
# resp.user_pool_client.token_validity_units.refresh_token #=> String, one of "seconds", "minutes", "hours", "days"
|
3184
3224
|
# resp.user_pool_client.read_attributes #=> Array
|
3185
3225
|
# resp.user_pool_client.read_attributes[0] #=> String
|
3186
3226
|
# resp.user_pool_client.write_attributes #=> Array
|
@@ -3200,6 +3240,7 @@ module Aws::CognitoIdentityProvider
|
|
3200
3240
|
# resp.user_pool_client.allowed_o_auth_scopes[0] #=> String
|
3201
3241
|
# resp.user_pool_client.allowed_o_auth_flows_user_pool_client #=> Boolean
|
3202
3242
|
# resp.user_pool_client.analytics_configuration.application_id #=> String
|
3243
|
+
# resp.user_pool_client.analytics_configuration.application_arn #=> String
|
3203
3244
|
# resp.user_pool_client.analytics_configuration.role_arn #=> String
|
3204
3245
|
# resp.user_pool_client.analytics_configuration.external_id #=> String
|
3205
3246
|
# resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
|
@@ -3786,6 +3827,11 @@ module Aws::CognitoIdentityProvider
|
|
3786
3827
|
# resp.user_pool_client.last_modified_date #=> Time
|
3787
3828
|
# resp.user_pool_client.creation_date #=> Time
|
3788
3829
|
# resp.user_pool_client.refresh_token_validity #=> Integer
|
3830
|
+
# resp.user_pool_client.access_token_validity #=> Integer
|
3831
|
+
# resp.user_pool_client.id_token_validity #=> Integer
|
3832
|
+
# resp.user_pool_client.token_validity_units.access_token #=> String, one of "seconds", "minutes", "hours", "days"
|
3833
|
+
# resp.user_pool_client.token_validity_units.id_token #=> String, one of "seconds", "minutes", "hours", "days"
|
3834
|
+
# resp.user_pool_client.token_validity_units.refresh_token #=> String, one of "seconds", "minutes", "hours", "days"
|
3789
3835
|
# resp.user_pool_client.read_attributes #=> Array
|
3790
3836
|
# resp.user_pool_client.read_attributes[0] #=> String
|
3791
3837
|
# resp.user_pool_client.write_attributes #=> Array
|
@@ -3805,6 +3851,7 @@ module Aws::CognitoIdentityProvider
|
|
3805
3851
|
# resp.user_pool_client.allowed_o_auth_scopes[0] #=> String
|
3806
3852
|
# resp.user_pool_client.allowed_o_auth_flows_user_pool_client #=> Boolean
|
3807
3853
|
# resp.user_pool_client.analytics_configuration.application_id #=> String
|
3854
|
+
# resp.user_pool_client.analytics_configuration.application_arn #=> String
|
3808
3855
|
# resp.user_pool_client.analytics_configuration.role_arn #=> String
|
3809
3856
|
# resp.user_pool_client.analytics_configuration.external_id #=> String
|
3810
3857
|
# resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
|
@@ -3885,10 +3932,15 @@ module Aws::CognitoIdentityProvider
|
|
3885
3932
|
# the `Username` parameter, you can use the username or user alias. The
|
3886
3933
|
# method used to send the confirmation code is sent according to the
|
3887
3934
|
# specified AccountRecoverySetting. For more information, see
|
3888
|
-
# [Recovering User Accounts]
|
3935
|
+
# [Recovering User Accounts][1] in the *Amazon Cognito Developer Guide*.
|
3889
3936
|
# If neither a verified phone number nor a verified email exists, an
|
3890
3937
|
# `InvalidParameterException` is thrown. To use the confirmation code
|
3891
|
-
# for resetting the password, call .
|
3938
|
+
# for resetting the password, call [ConfirmForgotPassword][2].
|
3939
|
+
#
|
3940
|
+
#
|
3941
|
+
#
|
3942
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html
|
3943
|
+
# [2]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html
|
3892
3944
|
#
|
3893
3945
|
# @option params [required, String] :client_id
|
3894
3946
|
# The ID of the client associated with the user pool.
|
@@ -4432,14 +4484,16 @@ module Aws::CognitoIdentityProvider
|
|
4432
4484
|
#
|
4433
4485
|
# * For `USER_SRP_AUTH`\: `USERNAME` (required), `SRP_A` (required),
|
4434
4486
|
# `SECRET_HASH` (required if the app client is configured with a
|
4435
|
-
# client secret), `DEVICE_KEY
|
4487
|
+
# client secret), `DEVICE_KEY`.
|
4436
4488
|
#
|
4437
4489
|
# * For `REFRESH_TOKEN_AUTH/REFRESH_TOKEN`\: `REFRESH_TOKEN` (required),
|
4438
4490
|
# `SECRET_HASH` (required if the app client is configured with a
|
4439
|
-
# client secret), `DEVICE_KEY
|
4491
|
+
# client secret), `DEVICE_KEY`.
|
4440
4492
|
#
|
4441
4493
|
# * For `CUSTOM_AUTH`\: `USERNAME` (required), `SECRET_HASH` (if app
|
4442
|
-
# client is configured with client secret), `DEVICE_KEY
|
4494
|
+
# client is configured with client secret), `DEVICE_KEY`. To start the
|
4495
|
+
# authentication flow with password verification, include
|
4496
|
+
# `ChallengeName: SRP_A` and `SRP_A: (The SRP_A Value)`.
|
4443
4497
|
#
|
4444
4498
|
# @option params [Hash<String,String>] :client_metadata
|
4445
4499
|
# A map of custom key-value pairs that you can provide as input for
|
@@ -5219,10 +5273,14 @@ module Aws::CognitoIdentityProvider
|
|
5219
5273
|
# The app client ID.
|
5220
5274
|
#
|
5221
5275
|
# @option params [required, String] :challenge_name
|
5222
|
-
# The challenge name. For more information, see .
|
5276
|
+
# The challenge name. For more information, see [InitiateAuth][1].
|
5223
5277
|
#
|
5224
5278
|
# `ADMIN_NO_SRP_AUTH` is not a valid value.
|
5225
5279
|
#
|
5280
|
+
#
|
5281
|
+
#
|
5282
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html
|
5283
|
+
#
|
5226
5284
|
# @option params [String] :session
|
5227
5285
|
# The session which should be passed both ways in challenge-response
|
5228
5286
|
# calls to the service. If `InitiateAuth` or `RespondToAuthChallenge`
|
@@ -5363,8 +5421,6 @@ module Aws::CognitoIdentityProvider
|
|
5363
5421
|
# To enable Amazon Cognito advanced security features, update the user
|
5364
5422
|
# pool to include the `UserPoolAddOns` key`AdvancedSecurityMode`.
|
5365
5423
|
#
|
5366
|
-
# See .
|
5367
|
-
#
|
5368
5424
|
# @option params [required, String] :user_pool_id
|
5369
5425
|
# The user pool ID.
|
5370
5426
|
#
|
@@ -5508,7 +5564,7 @@ module Aws::CognitoIdentityProvider
|
|
5508
5564
|
# @option params [String] :css
|
5509
5565
|
# The CSS values in the UI customization.
|
5510
5566
|
#
|
5511
|
-
# @option params [String,
|
5567
|
+
# @option params [String, StringIO, File] :image_file
|
5512
5568
|
# The uploaded logo image for the UI customization.
|
5513
5569
|
#
|
5514
5570
|
# @return [Types::SetUICustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -5647,8 +5703,11 @@ module Aws::CognitoIdentityProvider
|
|
5647
5703
|
|
5648
5704
|
# *This action is no longer supported.* You can use it to configure only
|
5649
5705
|
# SMS MFA. You can't use it to configure TOTP software token MFA. To
|
5650
|
-
# configure either type of MFA, use
|
5651
|
-
#
|
5706
|
+
# configure either type of MFA, use [SetUserMFAPreference][1] instead.
|
5707
|
+
#
|
5708
|
+
#
|
5709
|
+
#
|
5710
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html
|
5652
5711
|
#
|
5653
5712
|
# @option params [required, String] :access_token
|
5654
5713
|
# The access token for the set user settings request.
|
@@ -6063,7 +6122,11 @@ module Aws::CognitoIdentityProvider
|
|
6063
6122
|
#
|
6064
6123
|
# @option params [Integer] :precedence
|
6065
6124
|
# The new precedence value for the group. For more information about
|
6066
|
-
# this parameter, see .
|
6125
|
+
# this parameter, see [CreateGroup][1].
|
6126
|
+
#
|
6127
|
+
#
|
6128
|
+
#
|
6129
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html
|
6067
6130
|
#
|
6068
6131
|
# @return [Types::UpdateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6069
6132
|
#
|
@@ -6296,11 +6359,16 @@ module Aws::CognitoIdentityProvider
|
|
6296
6359
|
end
|
6297
6360
|
|
6298
6361
|
# Updates the specified user pool with the specified attributes. You can
|
6299
|
-
# get a list of the current user pool settings
|
6362
|
+
# get a list of the current user pool settings using
|
6363
|
+
# [DescribeUserPool][1].
|
6300
6364
|
#
|
6301
6365
|
# If you don't provide a value for an attribute, it will be set to the
|
6302
6366
|
# default value.
|
6303
6367
|
#
|
6368
|
+
#
|
6369
|
+
#
|
6370
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html
|
6371
|
+
#
|
6304
6372
|
# @option params [required, String] :user_pool_id
|
6305
6373
|
# The user pool ID for the user pool you want to update.
|
6306
6374
|
#
|
@@ -6465,11 +6533,15 @@ module Aws::CognitoIdentityProvider
|
|
6465
6533
|
|
6466
6534
|
# Updates the specified user pool app client with the specified
|
6467
6535
|
# attributes. You can get a list of the current user pool app client
|
6468
|
-
# settings
|
6536
|
+
# settings using [DescribeUserPoolClient][1].
|
6469
6537
|
#
|
6470
6538
|
# If you don't provide a value for an attribute, it will be set to the
|
6471
6539
|
# default value.
|
6472
6540
|
#
|
6541
|
+
#
|
6542
|
+
#
|
6543
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html
|
6544
|
+
#
|
6473
6545
|
# @option params [required, String] :user_pool_id
|
6474
6546
|
# The user pool ID for the user pool where you want to update the user
|
6475
6547
|
# pool client.
|
@@ -6484,6 +6556,18 @@ module Aws::CognitoIdentityProvider
|
|
6484
6556
|
# The time limit, in days, after which the refresh token is no longer
|
6485
6557
|
# valid and cannot be used.
|
6486
6558
|
#
|
6559
|
+
# @option params [Integer] :access_token_validity
|
6560
|
+
# The time limit, after which the access token is no longer valid and
|
6561
|
+
# cannot be used.
|
6562
|
+
#
|
6563
|
+
# @option params [Integer] :id_token_validity
|
6564
|
+
# The time limit, after which the ID token is no longer valid and cannot
|
6565
|
+
# be used.
|
6566
|
+
#
|
6567
|
+
# @option params [Types::TokenValidityUnitsType] :token_validity_units
|
6568
|
+
# The units in which the validity times are represented in. Default for
|
6569
|
+
# RefreshToken is days, and default for ID and access tokens are hours.
|
6570
|
+
#
|
6487
6571
|
# @option params [Array<String>] :read_attributes
|
6488
6572
|
# The read-only attributes of the user pool.
|
6489
6573
|
#
|
@@ -6594,9 +6678,10 @@ module Aws::CognitoIdentityProvider
|
|
6594
6678
|
# The Amazon Pinpoint analytics configuration for collecting metrics for
|
6595
6679
|
# this user pool.
|
6596
6680
|
#
|
6597
|
-
# <note markdown="1">
|
6598
|
-
#
|
6599
|
-
#
|
6681
|
+
# <note markdown="1"> In regions where Pinpoint is not available, Cognito User Pools only
|
6682
|
+
# supports sending events to Amazon Pinpoint projects in us-east-1. In
|
6683
|
+
# regions where Pinpoint is available, Cognito User Pools will support
|
6684
|
+
# sending events to Amazon Pinpoint projects within that same region.
|
6600
6685
|
#
|
6601
6686
|
# </note>
|
6602
6687
|
#
|
@@ -6618,24 +6703,6 @@ module Aws::CognitoIdentityProvider
|
|
6618
6703
|
# * `LEGACY` - This represents the old behavior of Cognito where user
|
6619
6704
|
# existence related errors are not prevented.
|
6620
6705
|
#
|
6621
|
-
# This setting affects the behavior of following APIs:
|
6622
|
-
#
|
6623
|
-
# * AdminInitiateAuth
|
6624
|
-
#
|
6625
|
-
# * AdminRespondToAuthChallenge
|
6626
|
-
#
|
6627
|
-
# * InitiateAuth
|
6628
|
-
#
|
6629
|
-
# * RespondToAuthChallenge
|
6630
|
-
#
|
6631
|
-
# * ForgotPassword
|
6632
|
-
#
|
6633
|
-
# * ConfirmForgotPassword
|
6634
|
-
#
|
6635
|
-
# * ConfirmSignUp
|
6636
|
-
#
|
6637
|
-
# * ResendConfirmationCode
|
6638
|
-
#
|
6639
6706
|
# <note markdown="1"> After February 15th 2020, the value of `PreventUserExistenceErrors`
|
6640
6707
|
# will default to `ENABLED` for newly created user pool clients if no
|
6641
6708
|
# value is provided.
|
@@ -6653,6 +6720,13 @@ module Aws::CognitoIdentityProvider
|
|
6653
6720
|
# client_id: "ClientIdType", # required
|
6654
6721
|
# client_name: "ClientNameType",
|
6655
6722
|
# refresh_token_validity: 1,
|
6723
|
+
# access_token_validity: 1,
|
6724
|
+
# id_token_validity: 1,
|
6725
|
+
# token_validity_units: {
|
6726
|
+
# access_token: "seconds", # accepts seconds, minutes, hours, days
|
6727
|
+
# id_token: "seconds", # accepts seconds, minutes, hours, days
|
6728
|
+
# refresh_token: "seconds", # accepts seconds, minutes, hours, days
|
6729
|
+
# },
|
6656
6730
|
# read_attributes: ["ClientPermissionType"],
|
6657
6731
|
# write_attributes: ["ClientPermissionType"],
|
6658
6732
|
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH
|
@@ -6664,9 +6738,10 @@ module Aws::CognitoIdentityProvider
|
|
6664
6738
|
# allowed_o_auth_scopes: ["ScopeType"],
|
6665
6739
|
# allowed_o_auth_flows_user_pool_client: false,
|
6666
6740
|
# analytics_configuration: {
|
6667
|
-
# application_id: "HexStringType",
|
6668
|
-
#
|
6669
|
-
#
|
6741
|
+
# application_id: "HexStringType",
|
6742
|
+
# application_arn: "ArnType",
|
6743
|
+
# role_arn: "ArnType",
|
6744
|
+
# external_id: "StringType",
|
6670
6745
|
# user_data_shared: false,
|
6671
6746
|
# },
|
6672
6747
|
# prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
|
@@ -6681,6 +6756,11 @@ module Aws::CognitoIdentityProvider
|
|
6681
6756
|
# resp.user_pool_client.last_modified_date #=> Time
|
6682
6757
|
# resp.user_pool_client.creation_date #=> Time
|
6683
6758
|
# resp.user_pool_client.refresh_token_validity #=> Integer
|
6759
|
+
# resp.user_pool_client.access_token_validity #=> Integer
|
6760
|
+
# resp.user_pool_client.id_token_validity #=> Integer
|
6761
|
+
# resp.user_pool_client.token_validity_units.access_token #=> String, one of "seconds", "minutes", "hours", "days"
|
6762
|
+
# resp.user_pool_client.token_validity_units.id_token #=> String, one of "seconds", "minutes", "hours", "days"
|
6763
|
+
# resp.user_pool_client.token_validity_units.refresh_token #=> String, one of "seconds", "minutes", "hours", "days"
|
6684
6764
|
# resp.user_pool_client.read_attributes #=> Array
|
6685
6765
|
# resp.user_pool_client.read_attributes[0] #=> String
|
6686
6766
|
# resp.user_pool_client.write_attributes #=> Array
|
@@ -6700,6 +6780,7 @@ module Aws::CognitoIdentityProvider
|
|
6700
6780
|
# resp.user_pool_client.allowed_o_auth_scopes[0] #=> String
|
6701
6781
|
# resp.user_pool_client.allowed_o_auth_flows_user_pool_client #=> Boolean
|
6702
6782
|
# resp.user_pool_client.analytics_configuration.application_id #=> String
|
6783
|
+
# resp.user_pool_client.analytics_configuration.application_arn #=> String
|
6703
6784
|
# resp.user_pool_client.analytics_configuration.role_arn #=> String
|
6704
6785
|
# resp.user_pool_client.analytics_configuration.external_id #=> String
|
6705
6786
|
# resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
|
@@ -6806,6 +6887,11 @@ module Aws::CognitoIdentityProvider
|
|
6806
6887
|
#
|
6807
6888
|
# @option params [required, String] :user_code
|
6808
6889
|
# The one time password computed using the secret code returned by
|
6890
|
+
# [AssociateSoftwareToken"][1].
|
6891
|
+
#
|
6892
|
+
#
|
6893
|
+
#
|
6894
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html
|
6809
6895
|
#
|
6810
6896
|
# @option params [String] :friendly_device_name
|
6811
6897
|
# The friendly device name.
|
@@ -6881,7 +6967,7 @@ module Aws::CognitoIdentityProvider
|
|
6881
6967
|
params: params,
|
6882
6968
|
config: config)
|
6883
6969
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
6884
|
-
context[:gem_version] = '1.
|
6970
|
+
context[:gem_version] = '1.44.0'
|
6885
6971
|
Seahorse::Client::Request.new(handlers, context)
|
6886
6972
|
end
|
6887
6973
|
|