@@ -648,16 +648,19 @@ public function adminRemoveUserFromGroup($input): Result
648
648
/**
649
649
* Resets the specified user's password in a user pool as an administrator. Works on any user.
650
650
*
651
+ * To use this API operation, your user pool must have self-service account recovery configured. Use
652
+ * AdminSetUserPassword [^1] if you manage passwords as an administrator.
653
+ *
651
654
* > This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register
652
655
* > an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in
653
- * > Amazon Cognito, you must register a phone number with Amazon Pinpoint [^1 ]. Amazon Cognito uses the registered
656
+ * > Amazon Cognito, you must register a phone number with Amazon Pinpoint [^2 ]. Amazon Cognito uses the registered
654
657
* > number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up,
655
658
* > activate their accounts, or sign in.
656
659
* >
657
660
* > If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple
658
- * > Notification Service might place your account in the SMS sandbox. In *sandbox mode [^2 ]*, you can send messages
661
+ * > Notification Service might place your account in the SMS sandbox. In *sandbox mode [^3 ]*, you can send messages
659
662
* > only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the
660
- * > sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools [^3 ] in
663
+ * > sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools [^4 ] in
661
664
* > the *Amazon Cognito Developer Guide*.
662
665
*
663
666
* Deactivates a user's password, requiring them to change it. If a user tries to sign in after the API is called,
@@ -673,15 +676,16 @@ public function adminRemoveUserFromGroup($input): Result
673
676
* >
674
677
* > **Learn more**
675
678
* >
676
- * > - Signing Amazon Web Services API Requests [^4 ]
677
- * > - Using the Amazon Cognito user pools API and user pool endpoints [^5 ]
679
+ * > - Signing Amazon Web Services API Requests [^5 ]
680
+ * > - Using the Amazon Cognito user pools API and user pool endpoints [^6 ]
678
681
* >
679
682
*
680
- * [^1]: https://console.aws.amazon.com/pinpoint/home/
681
- * [^2]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html
682
- * [^3]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html
683
- * [^4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
684
- * [^5]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
683
+ * [^1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserPassword.html
684
+ * [^2]: https://console.aws.amazon.com/pinpoint/home/
685
+ * [^3]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html
686
+ * [^4]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html
687
+ * [^5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
688
+ * [^6]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
685
689
*
686
690
* @see https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminResetUserPassword.html
687
691
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html#adminresetuserpassword
@@ -1258,29 +1262,33 @@ public function createGroup($input): CreateGroupResponse
1258
1262
* app client has a client secret and you don't provide a `SECRET_HASH` parameter, this API returns
1259
1263
* `NotAuthorizedException`.
1260
1264
*
1265
+ * To use this API operation, your user pool must have self-service account recovery configured. Use
1266
+ * AdminSetUserPassword [^3] if you manage passwords as an administrator.
1267
+ *
1261
1268
* > Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation.
1262
1269
* > For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in
1263
1270
* > policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user
1264
- * > pools API and user pool endpoints [^3 ].
1271
+ * > pools API and user pool endpoints [^4 ].
1265
1272
*
1266
1273
* > This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register
1267
1274
* > an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in
1268
- * > Amazon Cognito, you must register a phone number with Amazon Pinpoint [^4 ]. Amazon Cognito uses the registered
1275
+ * > Amazon Cognito, you must register a phone number with Amazon Pinpoint [^5 ]. Amazon Cognito uses the registered
1269
1276
* > number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up,
1270
1277
* > activate their accounts, or sign in.
1271
1278
* >
1272
1279
* > If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple
1273
- * > Notification Service might place your account in the SMS sandbox. In *sandbox mode [^5 ]*, you can send messages
1280
+ * > Notification Service might place your account in the SMS sandbox. In *sandbox mode [^6 ]*, you can send messages
1274
1281
* > only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the
1275
- * > sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools [^6 ] in
1282
+ * > sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools [^7 ] in
1276
1283
* > the *Amazon Cognito Developer Guide*.
1277
1284
*
1278
1285
* [^1]: https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html
1279
1286
* [^2]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html
1280
- * [^3]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
1281
- * [^4]: https://console.aws.amazon.com/pinpoint/home/
1282
- * [^5]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html
1283
- * [^6]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html
1287
+ * [^3]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserPassword.html
1288
+ * [^4]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
1289
+ * [^5]: https://console.aws.amazon.com/pinpoint/home/
1290
+ * [^6]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html
1291
+ * [^7]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html
1284
1292
*
1285
1293
* @see https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html
1286
1294
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html#forgotpassword
0 commit comments