aws-sdk-cognitoidentityprovider 1.87.0 → 1.88.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cognitoidentityprovider/client.rb +82 -46
- data/lib/aws-sdk-cognitoidentityprovider/client_api.rb +1 -0
- data/lib/aws-sdk-cognitoidentityprovider/types.rb +63 -59
- data/lib/aws-sdk-cognitoidentityprovider.rb +1 -1
- 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: e749e0487787924b27659ee96b5bc394762187154a3c0993d37a017715226a22
|
4
|
+
data.tar.gz: cb521c5347efb2ad7135b48c776480faae2a197b1ca9248edf2353dcd86148d3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7396f49eca1014b3d0710a07f5cc78b47de90cd59c5eddd8520a9f6a4179782df0889103351d6942320745c0b1e6bf22b58ce18dfc8a00335105fc10d97e3d37
|
7
|
+
data.tar.gz: 1425f42c0cdce405d1c1e09a9f7ce818d5d05cb6e932aefed8582d4dfd7eae296115b38b8638b7308421cf5e1546b5d8ab836155837b803f4eeb9eb5225b4556
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.88.0
|
@@ -488,7 +488,8 @@ module Aws::CognitoIdentityProvider
|
|
488
488
|
# The username of the user that you want to query or modify. The value
|
489
489
|
# of this parameter is typically your user's username, but it can be
|
490
490
|
# any of their alias attributes. If `username` isn't an alias attribute
|
491
|
-
# in your user pool,
|
491
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
492
|
+
# username of a user from a third-party IdP.
|
492
493
|
#
|
493
494
|
# @option params [required, String] :group_name
|
494
495
|
# The name of the group that you want to add your user to.
|
@@ -550,7 +551,8 @@ module Aws::CognitoIdentityProvider
|
|
550
551
|
# The username of the user that you want to query or modify. The value
|
551
552
|
# of this parameter is typically your user's username, but it can be
|
552
553
|
# any of their alias attributes. If `username` isn't an alias attribute
|
553
|
-
# in your user pool,
|
554
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
555
|
+
# username of a user from a third-party IdP.
|
554
556
|
#
|
555
557
|
# @option params [Hash<String,String>] :client_metadata
|
556
558
|
# A map of custom key-value pairs that you can provide as input for any
|
@@ -960,7 +962,8 @@ module Aws::CognitoIdentityProvider
|
|
960
962
|
# The username of the user that you want to query or modify. The value
|
961
963
|
# of this parameter is typically your user's username, but it can be
|
962
964
|
# any of their alias attributes. If `username` isn't an alias attribute
|
963
|
-
# in your user pool,
|
965
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
966
|
+
# username of a user from a third-party IdP.
|
964
967
|
#
|
965
968
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
966
969
|
#
|
@@ -1009,7 +1012,8 @@ module Aws::CognitoIdentityProvider
|
|
1009
1012
|
# The username of the user that you want to query or modify. The value
|
1010
1013
|
# of this parameter is typically your user's username, but it can be
|
1011
1014
|
# any of their alias attributes. If `username` isn't an alias attribute
|
1012
|
-
# in your user pool,
|
1015
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
1016
|
+
# username of a user from a third-party IdP.
|
1013
1017
|
#
|
1014
1018
|
# @option params [required, Array<String>] :user_attribute_names
|
1015
1019
|
# An array of strings representing the user attribute names you want to
|
@@ -1146,7 +1150,8 @@ module Aws::CognitoIdentityProvider
|
|
1146
1150
|
# The username of the user that you want to query or modify. The value
|
1147
1151
|
# of this parameter is typically your user's username, but it can be
|
1148
1152
|
# any of their alias attributes. If `username` isn't an alias attribute
|
1149
|
-
# in your user pool,
|
1153
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
1154
|
+
# username of a user from a third-party IdP.
|
1150
1155
|
#
|
1151
1156
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1152
1157
|
#
|
@@ -1193,7 +1198,8 @@ module Aws::CognitoIdentityProvider
|
|
1193
1198
|
# The username of the user that you want to query or modify. The value
|
1194
1199
|
# of this parameter is typically your user's username, but it can be
|
1195
1200
|
# any of their alias attributes. If `username` isn't an alias attribute
|
1196
|
-
# in your user pool,
|
1201
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
1202
|
+
# username of a user from a third-party IdP.
|
1197
1203
|
#
|
1198
1204
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1199
1205
|
#
|
@@ -1240,7 +1246,8 @@ module Aws::CognitoIdentityProvider
|
|
1240
1246
|
# The username of the user that you want to query or modify. The value
|
1241
1247
|
# of this parameter is typically your user's username, but it can be
|
1242
1248
|
# any of their alias attributes. If `username` isn't an alias attribute
|
1243
|
-
# in your user pool,
|
1249
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
1250
|
+
# username of a user from a third-party IdP.
|
1244
1251
|
#
|
1245
1252
|
# @option params [required, String] :device_key
|
1246
1253
|
# The device key.
|
@@ -1294,7 +1301,8 @@ module Aws::CognitoIdentityProvider
|
|
1294
1301
|
# The username of the user that you want to query or modify. The value
|
1295
1302
|
# of this parameter is typically your user's username, but it can be
|
1296
1303
|
# any of their alias attributes. If `username` isn't an alias attribute
|
1297
|
-
# in your user pool,
|
1304
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
1305
|
+
# username of a user from a third-party IdP.
|
1298
1306
|
#
|
1299
1307
|
# @return [Types::AdminGetDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1300
1308
|
#
|
@@ -1356,7 +1364,8 @@ module Aws::CognitoIdentityProvider
|
|
1356
1364
|
# The username of the user that you want to query or modify. The value
|
1357
1365
|
# of this parameter is typically your user's username, but it can be
|
1358
1366
|
# any of their alias attributes. If `username` isn't an alias attribute
|
1359
|
-
# in your user pool,
|
1367
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
1368
|
+
# username of a user from a third-party IdP.
|
1360
1369
|
#
|
1361
1370
|
# @return [Types::AdminGetUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1362
1371
|
#
|
@@ -1796,7 +1805,8 @@ module Aws::CognitoIdentityProvider
|
|
1796
1805
|
# The username of the user that you want to query or modify. The value
|
1797
1806
|
# of this parameter is typically your user's username, but it can be
|
1798
1807
|
# any of their alias attributes. If `username` isn't an alias attribute
|
1799
|
-
# in your user pool,
|
1808
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
1809
|
+
# username of a user from a third-party IdP.
|
1800
1810
|
#
|
1801
1811
|
# @option params [Integer] :limit
|
1802
1812
|
# The limit of the devices request.
|
@@ -1868,7 +1878,8 @@ module Aws::CognitoIdentityProvider
|
|
1868
1878
|
# The username of the user that you want to query or modify. The value
|
1869
1879
|
# of this parameter is typically your user's username, but it can be
|
1870
1880
|
# any of their alias attributes. If `username` isn't an alias attribute
|
1871
|
-
# in your user pool,
|
1881
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
1882
|
+
# username of a user from a third-party IdP.
|
1872
1883
|
#
|
1873
1884
|
# @option params [required, String] :user_pool_id
|
1874
1885
|
# The user pool ID for the user pool.
|
@@ -1946,7 +1957,8 @@ module Aws::CognitoIdentityProvider
|
|
1946
1957
|
# The username of the user that you want to query or modify. The value
|
1947
1958
|
# of this parameter is typically your user's username, but it can be
|
1948
1959
|
# any of their alias attributes. If `username` isn't an alias attribute
|
1949
|
-
# in your user pool,
|
1960
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
1961
|
+
# username of a user from a third-party IdP.
|
1950
1962
|
#
|
1951
1963
|
# @option params [Integer] :max_results
|
1952
1964
|
# The maximum number of authentication events to return. Returns 60
|
@@ -2031,7 +2043,8 @@ module Aws::CognitoIdentityProvider
|
|
2031
2043
|
# The username of the user that you want to query or modify. The value
|
2032
2044
|
# of this parameter is typically your user's username, but it can be
|
2033
2045
|
# any of their alias attributes. If `username` isn't an alias attribute
|
2034
|
-
# in your user pool,
|
2046
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
2047
|
+
# username of a user from a third-party IdP.
|
2035
2048
|
#
|
2036
2049
|
# @option params [required, String] :group_name
|
2037
2050
|
# The group name.
|
@@ -2058,11 +2071,15 @@ module Aws::CognitoIdentityProvider
|
|
2058
2071
|
# Resets the specified user's password in a user pool as an
|
2059
2072
|
# administrator. Works on any user.
|
2060
2073
|
#
|
2074
|
+
# To use this API operation, your user pool must have self-service
|
2075
|
+
# account recovery configured. Use [AdminSetUserPassword][1] if you
|
2076
|
+
# manage passwords as an administrator.
|
2077
|
+
#
|
2061
2078
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
2062
2079
|
# US telecom carriers require you to register an origination phone
|
2063
2080
|
# number before you can send SMS messages to US phone numbers. If you
|
2064
2081
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
2065
|
-
# number with [Amazon Pinpoint][
|
2082
|
+
# number with [Amazon Pinpoint][2]. Amazon Cognito uses the registered
|
2066
2083
|
# number automatically. Otherwise, Amazon Cognito users who must receive
|
2067
2084
|
# SMS messages might not be able to sign up, activate their accounts, or
|
2068
2085
|
# sign in.
|
@@ -2074,7 +2091,7 @@ module Aws::CognitoIdentityProvider
|
|
2074
2091
|
# mode</a> </i>, you can send messages only to verified phone numbers.
|
2075
2092
|
# After you test your app while in the sandbox environment, you can move
|
2076
2093
|
# out of the sandbox and into production. For more information, see [
|
2077
|
-
# SMS message settings for Amazon Cognito user pools][
|
2094
|
+
# SMS message settings for Amazon Cognito user pools][3] in the *Amazon
|
2078
2095
|
# Cognito Developer Guide*.
|
2079
2096
|
#
|
2080
2097
|
# </note>
|
@@ -2096,18 +2113,19 @@ module Aws::CognitoIdentityProvider
|
|
2096
2113
|
#
|
2097
2114
|
# **Learn more**
|
2098
2115
|
#
|
2099
|
-
# * [Signing Amazon Web Services API Requests][
|
2116
|
+
# * [Signing Amazon Web Services API Requests][4]
|
2100
2117
|
#
|
2101
|
-
# * [Using the Amazon Cognito user pools API and user pool endpoints][
|
2118
|
+
# * [Using the Amazon Cognito user pools API and user pool endpoints][5]
|
2102
2119
|
#
|
2103
2120
|
# </note>
|
2104
2121
|
#
|
2105
2122
|
#
|
2106
2123
|
#
|
2107
|
-
# [1]: https://
|
2108
|
-
# [2]: https://
|
2109
|
-
# [3]: https://docs.aws.amazon.com/
|
2110
|
-
# [4]: https://docs.aws.amazon.com/
|
2124
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserPassword.html
|
2125
|
+
# [2]: https://console.aws.amazon.com/pinpoint/home/
|
2126
|
+
# [3]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html
|
2127
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
|
2128
|
+
# [5]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
|
2111
2129
|
#
|
2112
2130
|
# @option params [required, String] :user_pool_id
|
2113
2131
|
# The user pool ID for the user pool where you want to reset the user's
|
@@ -2117,7 +2135,8 @@ module Aws::CognitoIdentityProvider
|
|
2117
2135
|
# The username of the user that you want to query or modify. The value
|
2118
2136
|
# of this parameter is typically your user's username, but it can be
|
2119
2137
|
# any of their alias attributes. If `username` isn't an alias attribute
|
2120
|
-
# in your user pool,
|
2138
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
2139
|
+
# username of a user from a third-party IdP.
|
2121
2140
|
#
|
2122
2141
|
# @option params [Hash<String,String>] :client_metadata
|
2123
2142
|
# A map of custom key-value pairs that you can provide as input for any
|
@@ -2500,7 +2519,8 @@ module Aws::CognitoIdentityProvider
|
|
2500
2519
|
# The username of the user that you want to query or modify. The value
|
2501
2520
|
# of this parameter is typically your user's username, but it can be
|
2502
2521
|
# any of their alias attributes. If `username` isn't an alias attribute
|
2503
|
-
# in your user pool,
|
2522
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
2523
|
+
# username of a user from a third-party IdP.
|
2504
2524
|
#
|
2505
2525
|
# @option params [required, String] :user_pool_id
|
2506
2526
|
# The user pool ID.
|
@@ -2584,7 +2604,8 @@ module Aws::CognitoIdentityProvider
|
|
2584
2604
|
# The username of the user that you want to query or modify. The value
|
2585
2605
|
# of this parameter is typically your user's username, but it can be
|
2586
2606
|
# any of their alias attributes. If `username` isn't an alias attribute
|
2587
|
-
# in your user pool,
|
2607
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
2608
|
+
# username of a user from a third-party IdP.
|
2588
2609
|
#
|
2589
2610
|
# @option params [required, String] :password
|
2590
2611
|
# The password for the user.
|
@@ -2644,7 +2665,8 @@ module Aws::CognitoIdentityProvider
|
|
2644
2665
|
# The username of the user that you want to query or modify. The value
|
2645
2666
|
# of this parameter is typically your user's username, but it can be
|
2646
2667
|
# any of their alias attributes. If `username` isn't an alias attribute
|
2647
|
-
# in your user pool,
|
2668
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
2669
|
+
# username of a user from a third-party IdP.
|
2648
2670
|
#
|
2649
2671
|
# @option params [required, Array<Types::MFAOptionType>] :mfa_options
|
2650
2672
|
# You can use this parameter only to set an SMS configuration that uses
|
@@ -2704,7 +2726,8 @@ module Aws::CognitoIdentityProvider
|
|
2704
2726
|
# The username of the user that you want to query or modify. The value
|
2705
2727
|
# of this parameter is typically your user's username, but it can be
|
2706
2728
|
# any of their alias attributes. If `username` isn't an alias attribute
|
2707
|
-
# in your user pool,
|
2729
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
2730
|
+
# username of a user from a third-party IdP.
|
2708
2731
|
#
|
2709
2732
|
# @option params [required, String] :event_id
|
2710
2733
|
# The authentication event ID.
|
@@ -2764,7 +2787,8 @@ module Aws::CognitoIdentityProvider
|
|
2764
2787
|
# The username of the user that you want to query or modify. The value
|
2765
2788
|
# of this parameter is typically your user's username, but it can be
|
2766
2789
|
# any of their alias attributes. If `username` isn't an alias attribute
|
2767
|
-
# in your user pool,
|
2790
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
2791
|
+
# username of a user from a third-party IdP.
|
2768
2792
|
#
|
2769
2793
|
# @option params [required, String] :device_key
|
2770
2794
|
# The device key.
|
@@ -2852,7 +2876,8 @@ module Aws::CognitoIdentityProvider
|
|
2852
2876
|
# The username of the user that you want to query or modify. The value
|
2853
2877
|
# of this parameter is typically your user's username, but it can be
|
2854
2878
|
# any of their alias attributes. If `username` isn't an alias attribute
|
2855
|
-
# in your user pool,
|
2879
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
2880
|
+
# username of a user from a third-party IdP.
|
2856
2881
|
#
|
2857
2882
|
# @option params [required, Array<Types::AttributeType>] :user_attributes
|
2858
2883
|
# An array of name-value pairs representing user attributes.
|
@@ -2991,7 +3016,8 @@ module Aws::CognitoIdentityProvider
|
|
2991
3016
|
# The username of the user that you want to query or modify. The value
|
2992
3017
|
# of this parameter is typically your user's username, but it can be
|
2993
3018
|
# any of their alias attributes. If `username` isn't an alias attribute
|
2994
|
-
# in your user pool,
|
3019
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
3020
|
+
# username of a user from a third-party IdP.
|
2995
3021
|
#
|
2996
3022
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2997
3023
|
#
|
@@ -3225,7 +3251,8 @@ module Aws::CognitoIdentityProvider
|
|
3225
3251
|
# The username of the user that you want to query or modify. The value
|
3226
3252
|
# of this parameter is typically your user's username, but it can be
|
3227
3253
|
# any of their alias attributes. If `username` isn't an alias attribute
|
3228
|
-
# in your user pool,
|
3254
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
3255
|
+
# username of a user from a third-party IdP.
|
3229
3256
|
#
|
3230
3257
|
# @option params [required, String] :confirmation_code
|
3231
3258
|
# The confirmation code from your user's request to reset their
|
@@ -3361,7 +3388,8 @@ module Aws::CognitoIdentityProvider
|
|
3361
3388
|
# The username of the user that you want to query or modify. The value
|
3362
3389
|
# of this parameter is typically your user's username, but it can be
|
3363
3390
|
# any of their alias attributes. If `username` isn't an alias attribute
|
3364
|
-
# in your user pool,
|
3391
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
3392
|
+
# username of a user from a third-party IdP.
|
3365
3393
|
#
|
3366
3394
|
# @option params [required, String] :confirmation_code
|
3367
3395
|
# The confirmation code sent by a user's request to confirm
|
@@ -6157,12 +6185,16 @@ module Aws::CognitoIdentityProvider
|
|
6157
6185
|
# client secret and you don't provide a `SECRET_HASH` parameter, this
|
6158
6186
|
# API returns `NotAuthorizedException`.
|
6159
6187
|
#
|
6188
|
+
# To use this API operation, your user pool must have self-service
|
6189
|
+
# account recovery configured. Use [AdminSetUserPassword][3] if you
|
6190
|
+
# manage passwords as an administrator.
|
6191
|
+
#
|
6160
6192
|
# <note markdown="1"> Amazon Cognito doesn't evaluate Identity and Access Management (IAM)
|
6161
6193
|
# policies in requests for this API operation. For this operation, you
|
6162
6194
|
# can't use IAM credentials to authorize requests, and you can't grant
|
6163
6195
|
# IAM permissions in policies. For more information about authorization
|
6164
6196
|
# models in Amazon Cognito, see [Using the Amazon Cognito user pools API
|
6165
|
-
# and user pool endpoints][
|
6197
|
+
# and user pool endpoints][4].
|
6166
6198
|
#
|
6167
6199
|
# </note>
|
6168
6200
|
#
|
@@ -6170,7 +6202,7 @@ module Aws::CognitoIdentityProvider
|
|
6170
6202
|
# US telecom carriers require you to register an origination phone
|
6171
6203
|
# number before you can send SMS messages to US phone numbers. If you
|
6172
6204
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
6173
|
-
# number with [Amazon Pinpoint][
|
6205
|
+
# number with [Amazon Pinpoint][5]. Amazon Cognito uses the registered
|
6174
6206
|
# number automatically. Otherwise, Amazon Cognito users who must receive
|
6175
6207
|
# SMS messages might not be able to sign up, activate their accounts, or
|
6176
6208
|
# sign in.
|
@@ -6182,7 +6214,7 @@ module Aws::CognitoIdentityProvider
|
|
6182
6214
|
# mode</a> </i>, you can send messages only to verified phone numbers.
|
6183
6215
|
# After you test your app while in the sandbox environment, you can move
|
6184
6216
|
# out of the sandbox and into production. For more information, see [
|
6185
|
-
# SMS message settings for Amazon Cognito user pools][
|
6217
|
+
# SMS message settings for Amazon Cognito user pools][6] in the *Amazon
|
6186
6218
|
# Cognito Developer Guide*.
|
6187
6219
|
#
|
6188
6220
|
# </note>
|
@@ -6191,9 +6223,10 @@ module Aws::CognitoIdentityProvider
|
|
6191
6223
|
#
|
6192
6224
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html
|
6193
6225
|
# [2]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html
|
6194
|
-
# [3]: https://docs.aws.amazon.com/cognito/latest/
|
6195
|
-
# [4]: https://
|
6196
|
-
# [5]: https://
|
6226
|
+
# [3]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserPassword.html
|
6227
|
+
# [4]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
|
6228
|
+
# [5]: https://console.aws.amazon.com/pinpoint/home/
|
6229
|
+
# [6]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html
|
6197
6230
|
#
|
6198
6231
|
# @option params [required, String] :client_id
|
6199
6232
|
# The ID of the client associated with the user pool.
|
@@ -6214,7 +6247,8 @@ module Aws::CognitoIdentityProvider
|
|
6214
6247
|
# The username of the user that you want to query or modify. The value
|
6215
6248
|
# of this parameter is typically your user's username, but it can be
|
6216
6249
|
# any of their alias attributes. If `username` isn't an alias attribute
|
6217
|
-
# in your user pool,
|
6250
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
6251
|
+
# username of a user from a third-party IdP.
|
6218
6252
|
#
|
6219
6253
|
# @option params [Types::AnalyticsMetadataType] :analytics_metadata
|
6220
6254
|
# The Amazon Pinpoint analytics metadata that contributes to your
|
@@ -7682,15 +7716,15 @@ module Aws::CognitoIdentityProvider
|
|
7682
7716
|
# @option params [String] :filter
|
7683
7717
|
# A filter string of the form "*AttributeName* *Filter-Type*
|
7684
7718
|
# "*AttributeValue*"". Quotation marks within the filter string must
|
7685
|
-
# be escaped using the backslash (
|
7686
|
-
# "
|
7719
|
+
# be escaped using the backslash (``) character. For example,
|
7720
|
+
# `"family_name = "Reddy""`.
|
7687
7721
|
#
|
7688
7722
|
# * *AttributeName*: The name of the attribute to search for. You can
|
7689
7723
|
# only search for one attribute at a time.
|
7690
7724
|
#
|
7691
|
-
# * *Filter-Type*: For an exact match, use
|
7692
|
-
# "`given_name
|
7693
|
-
#
|
7725
|
+
# * *Filter-Type*: For an exact match, use `=`, for example,
|
7726
|
+
# "`given_name = "Jon"`". For a prefix ("starts with") match,
|
7727
|
+
# use `^=`, for example, "`given_name ^= "Jon"`".
|
7694
7728
|
#
|
7695
7729
|
# * *AttributeValue*: The attribute value that must be matched for each
|
7696
7730
|
# user.
|
@@ -7999,7 +8033,8 @@ module Aws::CognitoIdentityProvider
|
|
7999
8033
|
# The username of the user that you want to query or modify. The value
|
8000
8034
|
# of this parameter is typically your user's username, but it can be
|
8001
8035
|
# any of their alias attributes. If `username` isn't an alias attribute
|
8002
|
-
# in your user pool,
|
8036
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
8037
|
+
# username of a user from a third-party IdP.
|
8003
8038
|
#
|
8004
8039
|
# @option params [Types::AnalyticsMetadataType] :analytics_metadata
|
8005
8040
|
# The Amazon Pinpoint analytics metadata that contributes to your
|
@@ -9199,7 +9234,8 @@ module Aws::CognitoIdentityProvider
|
|
9199
9234
|
# The username of the user that you want to query or modify. The value
|
9200
9235
|
# of this parameter is typically your user's username, but it can be
|
9201
9236
|
# any of their alias attributes. If `username` isn't an alias attribute
|
9202
|
-
# in your user pool,
|
9237
|
+
# in your user pool, this value must be the `sub` of a local user or the
|
9238
|
+
# username of a user from a third-party IdP.
|
9203
9239
|
#
|
9204
9240
|
# @option params [required, String] :event_id
|
9205
9241
|
# The event ID.
|
@@ -10717,7 +10753,7 @@ module Aws::CognitoIdentityProvider
|
|
10717
10753
|
params: params,
|
10718
10754
|
config: config)
|
10719
10755
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
10720
|
-
context[:gem_version] = '1.
|
10756
|
+
context[:gem_version] = '1.88.0'
|
10721
10757
|
Seahorse::Client::Request.new(handlers, context)
|
10722
10758
|
end
|
10723
10759
|
|
@@ -3492,6 +3492,7 @@ module Aws::CognitoIdentityProvider
|
|
3492
3492
|
o.output = Shapes::ShapeRef.new(shape: SetUserPoolMfaConfigResponse)
|
3493
3493
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
3494
3494
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
3495
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
3495
3496
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
3496
3497
|
o.errors << Shapes::ShapeRef.new(shape: InvalidSmsRoleAccessPolicyException)
|
3497
3498
|
o.errors << Shapes::ShapeRef.new(shape: InvalidSmsRoleTrustRelationshipException)
|
@@ -133,8 +133,8 @@ module Aws::CognitoIdentityProvider
|
|
133
133
|
# The username of the user that you want to query or modify. The value
|
134
134
|
# of this parameter is typically your user's username, but it can be
|
135
135
|
# any of their alias attributes. If `username` isn't an alias
|
136
|
-
# attribute in your user pool,
|
137
|
-
#
|
136
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
137
|
+
# user or the username of a user from a third-party IdP.
|
138
138
|
# @return [String]
|
139
139
|
#
|
140
140
|
# @!attribute [rw] group_name
|
@@ -161,8 +161,8 @@ module Aws::CognitoIdentityProvider
|
|
161
161
|
# The username of the user that you want to query or modify. The value
|
162
162
|
# of this parameter is typically your user's username, but it can be
|
163
163
|
# any of their alias attributes. If `username` isn't an alias
|
164
|
-
# attribute in your user pool,
|
165
|
-
#
|
164
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
165
|
+
# user or the username of a user from a third-party IdP.
|
166
166
|
# @return [String]
|
167
167
|
#
|
168
168
|
# @!attribute [rw] client_metadata
|
@@ -474,8 +474,8 @@ module Aws::CognitoIdentityProvider
|
|
474
474
|
# The username of the user that you want to query or modify. The value
|
475
475
|
# of this parameter is typically your user's username, but it can be
|
476
476
|
# any of their alias attributes. If `username` isn't an alias
|
477
|
-
# attribute in your user pool,
|
478
|
-
#
|
477
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
478
|
+
# user or the username of a user from a third-party IdP.
|
479
479
|
# @return [String]
|
480
480
|
#
|
481
481
|
# @!attribute [rw] user_attribute_names
|
@@ -514,8 +514,8 @@ module Aws::CognitoIdentityProvider
|
|
514
514
|
# The username of the user that you want to query or modify. The value
|
515
515
|
# of this parameter is typically your user's username, but it can be
|
516
516
|
# any of their alias attributes. If `username` isn't an alias
|
517
|
-
# attribute in your user pool,
|
518
|
-
#
|
517
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
518
|
+
# user or the username of a user from a third-party IdP.
|
519
519
|
# @return [String]
|
520
520
|
#
|
521
521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUserRequest AWS API Documentation
|
@@ -559,8 +559,8 @@ module Aws::CognitoIdentityProvider
|
|
559
559
|
# The username of the user that you want to query or modify. The value
|
560
560
|
# of this parameter is typically your user's username, but it can be
|
561
561
|
# any of their alias attributes. If `username` isn't an alias
|
562
|
-
# attribute in your user pool,
|
563
|
-
#
|
562
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
563
|
+
# user or the username of a user from a third-party IdP.
|
564
564
|
# @return [String]
|
565
565
|
#
|
566
566
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableUserRequest AWS API Documentation
|
@@ -590,8 +590,8 @@ module Aws::CognitoIdentityProvider
|
|
590
590
|
# The username of the user that you want to query or modify. The value
|
591
591
|
# of this parameter is typically your user's username, but it can be
|
592
592
|
# any of their alias attributes. If `username` isn't an alias
|
593
|
-
# attribute in your user pool,
|
594
|
-
#
|
593
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
594
|
+
# user or the username of a user from a third-party IdP.
|
595
595
|
# @return [String]
|
596
596
|
#
|
597
597
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminEnableUserRequest AWS API Documentation
|
@@ -620,8 +620,8 @@ module Aws::CognitoIdentityProvider
|
|
620
620
|
# The username of the user that you want to query or modify. The value
|
621
621
|
# of this parameter is typically your user's username, but it can be
|
622
622
|
# any of their alias attributes. If `username` isn't an alias
|
623
|
-
# attribute in your user pool,
|
624
|
-
#
|
623
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
624
|
+
# user or the username of a user from a third-party IdP.
|
625
625
|
# @return [String]
|
626
626
|
#
|
627
627
|
# @!attribute [rw] device_key
|
@@ -652,8 +652,8 @@ module Aws::CognitoIdentityProvider
|
|
652
652
|
# The username of the user that you want to query or modify. The value
|
653
653
|
# of this parameter is typically your user's username, but it can be
|
654
654
|
# any of their alias attributes. If `username` isn't an alias
|
655
|
-
# attribute in your user pool,
|
656
|
-
#
|
655
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
656
|
+
# user or the username of a user from a third-party IdP.
|
657
657
|
# @return [String]
|
658
658
|
#
|
659
659
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetDeviceRequest AWS API Documentation
|
@@ -691,8 +691,8 @@ module Aws::CognitoIdentityProvider
|
|
691
691
|
# The username of the user that you want to query or modify. The value
|
692
692
|
# of this parameter is typically your user's username, but it can be
|
693
693
|
# any of their alias attributes. If `username` isn't an alias
|
694
|
-
# attribute in your user pool,
|
695
|
-
#
|
694
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
695
|
+
# user or the username of a user from a third-party IdP.
|
696
696
|
# @return [String]
|
697
697
|
#
|
698
698
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetUserRequest AWS API Documentation
|
@@ -1148,8 +1148,8 @@ module Aws::CognitoIdentityProvider
|
|
1148
1148
|
# The username of the user that you want to query or modify. The value
|
1149
1149
|
# of this parameter is typically your user's username, but it can be
|
1150
1150
|
# any of their alias attributes. If `username` isn't an alias
|
1151
|
-
# attribute in your user pool,
|
1152
|
-
#
|
1151
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
1152
|
+
# user or the username of a user from a third-party IdP.
|
1153
1153
|
# @return [String]
|
1154
1154
|
#
|
1155
1155
|
# @!attribute [rw] limit
|
@@ -1204,8 +1204,8 @@ module Aws::CognitoIdentityProvider
|
|
1204
1204
|
# The username of the user that you want to query or modify. The value
|
1205
1205
|
# of this parameter is typically your user's username, but it can be
|
1206
1206
|
# any of their alias attributes. If `username` isn't an alias
|
1207
|
-
# attribute in your user pool,
|
1208
|
-
#
|
1207
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
1208
|
+
# user or the username of a user from a third-party IdP.
|
1209
1209
|
# @return [String]
|
1210
1210
|
#
|
1211
1211
|
# @!attribute [rw] user_pool_id
|
@@ -1260,8 +1260,8 @@ module Aws::CognitoIdentityProvider
|
|
1260
1260
|
# The username of the user that you want to query or modify. The value
|
1261
1261
|
# of this parameter is typically your user's username, but it can be
|
1262
1262
|
# any of their alias attributes. If `username` isn't an alias
|
1263
|
-
# attribute in your user pool,
|
1264
|
-
#
|
1263
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
1264
|
+
# user or the username of a user from a third-party IdP.
|
1265
1265
|
# @return [String]
|
1266
1266
|
#
|
1267
1267
|
# @!attribute [rw] max_results
|
@@ -1311,8 +1311,8 @@ module Aws::CognitoIdentityProvider
|
|
1311
1311
|
# The username of the user that you want to query or modify. The value
|
1312
1312
|
# of this parameter is typically your user's username, but it can be
|
1313
1313
|
# any of their alias attributes. If `username` isn't an alias
|
1314
|
-
# attribute in your user pool,
|
1315
|
-
#
|
1314
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
1315
|
+
# user or the username of a user from a third-party IdP.
|
1316
1316
|
# @return [String]
|
1317
1317
|
#
|
1318
1318
|
# @!attribute [rw] group_name
|
@@ -1341,8 +1341,8 @@ module Aws::CognitoIdentityProvider
|
|
1341
1341
|
# The username of the user that you want to query or modify. The value
|
1342
1342
|
# of this parameter is typically your user's username, but it can be
|
1343
1343
|
# any of their alias attributes. If `username` isn't an alias
|
1344
|
-
# attribute in your user pool,
|
1345
|
-
#
|
1344
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
1345
|
+
# user or the username of a user from a third-party IdP.
|
1346
1346
|
# @return [String]
|
1347
1347
|
#
|
1348
1348
|
# @!attribute [rw] client_metadata
|
@@ -1661,8 +1661,8 @@ module Aws::CognitoIdentityProvider
|
|
1661
1661
|
# The username of the user that you want to query or modify. The value
|
1662
1662
|
# of this parameter is typically your user's username, but it can be
|
1663
1663
|
# any of their alias attributes. If `username` isn't an alias
|
1664
|
-
# attribute in your user pool,
|
1665
|
-
#
|
1664
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
1665
|
+
# user or the username of a user from a third-party IdP.
|
1666
1666
|
# @return [String]
|
1667
1667
|
#
|
1668
1668
|
# @!attribute [rw] user_pool_id
|
@@ -1693,8 +1693,8 @@ module Aws::CognitoIdentityProvider
|
|
1693
1693
|
# The username of the user that you want to query or modify. The value
|
1694
1694
|
# of this parameter is typically your user's username, but it can be
|
1695
1695
|
# any of their alias attributes. If `username` isn't an alias
|
1696
|
-
# attribute in your user pool,
|
1697
|
-
#
|
1696
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
1697
|
+
# user or the username of a user from a third-party IdP.
|
1698
1698
|
# @return [String]
|
1699
1699
|
#
|
1700
1700
|
# @!attribute [rw] password
|
@@ -1732,8 +1732,8 @@ module Aws::CognitoIdentityProvider
|
|
1732
1732
|
# The username of the user that you want to query or modify. The value
|
1733
1733
|
# of this parameter is typically your user's username, but it can be
|
1734
1734
|
# any of their alias attributes. If `username` isn't an alias
|
1735
|
-
# attribute in your user pool,
|
1736
|
-
#
|
1735
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
1736
|
+
# user or the username of a user from a third-party IdP.
|
1737
1737
|
# @return [String]
|
1738
1738
|
#
|
1739
1739
|
# @!attribute [rw] mfa_options
|
@@ -1766,8 +1766,8 @@ module Aws::CognitoIdentityProvider
|
|
1766
1766
|
# The username of the user that you want to query or modify. The value
|
1767
1767
|
# of this parameter is typically your user's username, but it can be
|
1768
1768
|
# any of their alias attributes. If `username` isn't an alias
|
1769
|
-
# attribute in your user pool,
|
1770
|
-
#
|
1769
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
1770
|
+
# user or the username of a user from a third-party IdP.
|
1771
1771
|
# @return [String]
|
1772
1772
|
#
|
1773
1773
|
# @!attribute [rw] event_id
|
@@ -1809,8 +1809,8 @@ module Aws::CognitoIdentityProvider
|
|
1809
1809
|
# The username of the user that you want to query or modify. The value
|
1810
1810
|
# of this parameter is typically your user's username, but it can be
|
1811
1811
|
# any of their alias attributes. If `username` isn't an alias
|
1812
|
-
# attribute in your user pool,
|
1813
|
-
#
|
1812
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
1813
|
+
# user or the username of a user from a third-party IdP.
|
1814
1814
|
# @return [String]
|
1815
1815
|
#
|
1816
1816
|
# @!attribute [rw] device_key
|
@@ -1851,8 +1851,8 @@ module Aws::CognitoIdentityProvider
|
|
1851
1851
|
# The username of the user that you want to query or modify. The value
|
1852
1852
|
# of this parameter is typically your user's username, but it can be
|
1853
1853
|
# any of their alias attributes. If `username` isn't an alias
|
1854
|
-
# attribute in your user pool,
|
1855
|
-
#
|
1854
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
1855
|
+
# user or the username of a user from a third-party IdP.
|
1856
1856
|
# @return [String]
|
1857
1857
|
#
|
1858
1858
|
# @!attribute [rw] user_attributes
|
@@ -1944,8 +1944,8 @@ module Aws::CognitoIdentityProvider
|
|
1944
1944
|
# The username of the user that you want to query or modify. The value
|
1945
1945
|
# of this parameter is typically your user's username, but it can be
|
1946
1946
|
# any of their alias attributes. If `username` isn't an alias
|
1947
|
-
# attribute in your user pool,
|
1948
|
-
#
|
1947
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
1948
|
+
# user or the username of a user from a third-party IdP.
|
1949
1949
|
# @return [String]
|
1950
1950
|
#
|
1951
1951
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUserGlobalSignOutRequest AWS API Documentation
|
@@ -2461,8 +2461,8 @@ module Aws::CognitoIdentityProvider
|
|
2461
2461
|
# The username of the user that you want to query or modify. The value
|
2462
2462
|
# of this parameter is typically your user's username, but it can be
|
2463
2463
|
# any of their alias attributes. If `username` isn't an alias
|
2464
|
-
# attribute in your user pool,
|
2465
|
-
#
|
2464
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
2465
|
+
# user or the username of a user from a third-party IdP.
|
2466
2466
|
# @return [String]
|
2467
2467
|
#
|
2468
2468
|
# @!attribute [rw] confirmation_code
|
@@ -2567,8 +2567,8 @@ module Aws::CognitoIdentityProvider
|
|
2567
2567
|
# The username of the user that you want to query or modify. The value
|
2568
2568
|
# of this parameter is typically your user's username, but it can be
|
2569
2569
|
# any of their alias attributes. If `username` isn't an alias
|
2570
|
-
# attribute in your user pool,
|
2571
|
-
#
|
2570
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
2571
|
+
# user or the username of a user from a third-party IdP.
|
2572
2572
|
# @return [String]
|
2573
2573
|
#
|
2574
2574
|
# @!attribute [rw] confirmation_code
|
@@ -4650,8 +4650,8 @@ module Aws::CognitoIdentityProvider
|
|
4650
4650
|
# The username of the user that you want to query or modify. The value
|
4651
4651
|
# of this parameter is typically your user's username, but it can be
|
4652
4652
|
# any of their alias attributes. If `username` isn't an alias
|
4653
|
-
# attribute in your user pool,
|
4654
|
-
#
|
4653
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
4654
|
+
# user or the username of a user from a third-party IdP.
|
4655
4655
|
# @return [String]
|
4656
4656
|
#
|
4657
4657
|
# @!attribute [rw] analytics_metadata
|
@@ -6365,15 +6365,15 @@ module Aws::CognitoIdentityProvider
|
|
6365
6365
|
# @!attribute [rw] filter
|
6366
6366
|
# A filter string of the form "*AttributeName* *Filter-Type*
|
6367
6367
|
# "*AttributeValue*"". Quotation marks within the filter string
|
6368
|
-
# must be escaped using the backslash (
|
6369
|
-
# "
|
6368
|
+
# must be escaped using the backslash (``) character. For example,
|
6369
|
+
# `"family_name = "Reddy""`.
|
6370
6370
|
#
|
6371
6371
|
# * *AttributeName*: The name of the attribute to search for. You can
|
6372
6372
|
# only search for one attribute at a time.
|
6373
6373
|
#
|
6374
|
-
# * *Filter-Type*: For an exact match, use
|
6375
|
-
# "`given_name
|
6376
|
-
#
|
6374
|
+
# * *Filter-Type*: For an exact match, use `=`, for example,
|
6375
|
+
# "`given_name = "Jon"`". For a prefix ("starts with") match,
|
6376
|
+
# use `^=`, for example, "`given_name ^= "Jon"`".
|
6377
6377
|
#
|
6378
6378
|
# * *AttributeValue*: The attribute value that must be matched for
|
6379
6379
|
# each user.
|
@@ -6713,7 +6713,9 @@ module Aws::CognitoIdentityProvider
|
|
6713
6713
|
# @return [String]
|
6714
6714
|
#
|
6715
6715
|
# @!attribute [rw] max_value
|
6716
|
-
# The maximum
|
6716
|
+
# The maximum length of a number attribute value. Must be a number
|
6717
|
+
# less than or equal to `2^1023`, represented as a string with a
|
6718
|
+
# length of 131072 characters or fewer.
|
6717
6719
|
# @return [String]
|
6718
6720
|
#
|
6719
6721
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/NumberAttributeConstraintsType AWS API Documentation
|
@@ -6940,8 +6942,8 @@ module Aws::CognitoIdentityProvider
|
|
6940
6942
|
# The username of the user that you want to query or modify. The value
|
6941
6943
|
# of this parameter is typically your user's username, but it can be
|
6942
6944
|
# any of their alias attributes. If `username` isn't an alias
|
6943
|
-
# attribute in your user pool,
|
6944
|
-
#
|
6945
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
6946
|
+
# user or the username of a user from a third-party IdP.
|
6945
6947
|
# @return [String]
|
6946
6948
|
#
|
6947
6949
|
# @!attribute [rw] analytics_metadata
|
@@ -8157,7 +8159,9 @@ module Aws::CognitoIdentityProvider
|
|
8157
8159
|
# @return [String]
|
8158
8160
|
#
|
8159
8161
|
# @!attribute [rw] max_length
|
8160
|
-
# The maximum length.
|
8162
|
+
# The maximum length of a string attribute value. Must be a number
|
8163
|
+
# less than or equal to `2^1023`, represented as a string with a
|
8164
|
+
# length of 131072 characters or fewer.
|
8161
8165
|
# @return [String]
|
8162
8166
|
#
|
8163
8167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StringAttributeConstraintsType AWS API Documentation
|
@@ -8430,8 +8434,8 @@ module Aws::CognitoIdentityProvider
|
|
8430
8434
|
# The username of the user that you want to query or modify. The value
|
8431
8435
|
# of this parameter is typically your user's username, but it can be
|
8432
8436
|
# any of their alias attributes. If `username` isn't an alias
|
8433
|
-
# attribute in your user pool,
|
8434
|
-
#
|
8437
|
+
# attribute in your user pool, this value must be the `sub` of a local
|
8438
|
+
# user or the username of a user from a third-party IdP.
|
8435
8439
|
# @return [String]
|
8436
8440
|
#
|
8437
8441
|
# @!attribute [rw] event_id
|
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.88.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-03-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|