@aws-sdk/client-cognito-identity-provider 3.504.0 → 3.505.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.
Files changed (81) hide show
  1. package/dist-types/commands/AddCustomAttributesCommand.d.ts +2 -2
  2. package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +2 -2
  3. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +2 -2
  4. package/dist-types/commands/AdminCreateUserCommand.d.ts +13 -13
  5. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +2 -2
  6. package/dist-types/commands/AdminDeleteUserCommand.d.ts +2 -2
  7. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +2 -2
  8. package/dist-types/commands/AdminDisableUserCommand.d.ts +2 -2
  9. package/dist-types/commands/AdminEnableUserCommand.d.ts +2 -2
  10. package/dist-types/commands/AdminForgetDeviceCommand.d.ts +2 -2
  11. package/dist-types/commands/AdminGetDeviceCommand.d.ts +2 -2
  12. package/dist-types/commands/AdminGetUserCommand.d.ts +2 -2
  13. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +13 -13
  14. package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +2 -2
  15. package/dist-types/commands/AdminListDevicesCommand.d.ts +2 -2
  16. package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +2 -2
  17. package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +2 -2
  18. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +2 -2
  19. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +13 -13
  20. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +13 -13
  21. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +2 -2
  22. package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +2 -2
  23. package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +2 -2
  24. package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +2 -2
  25. package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +2 -2
  26. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +13 -13
  27. package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +2 -2
  28. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +3 -3
  29. package/dist-types/commands/ChangePasswordCommand.d.ts +4 -3
  30. package/dist-types/commands/ConfirmDeviceCommand.d.ts +5 -4
  31. package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +3 -3
  32. package/dist-types/commands/ConfirmSignUpCommand.d.ts +3 -3
  33. package/dist-types/commands/CreateGroupCommand.d.ts +2 -2
  34. package/dist-types/commands/CreateIdentityProviderCommand.d.ts +3 -3
  35. package/dist-types/commands/CreateResourceServerCommand.d.ts +2 -2
  36. package/dist-types/commands/CreateUserImportJobCommand.d.ts +2 -2
  37. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +2 -2
  38. package/dist-types/commands/CreateUserPoolCommand.d.ts +15 -15
  39. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +2 -2
  40. package/dist-types/commands/DeleteUserAttributesCommand.d.ts +4 -3
  41. package/dist-types/commands/DeleteUserCommand.d.ts +4 -3
  42. package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +2 -2
  43. package/dist-types/commands/DescribeUserPoolCommand.d.ts +3 -3
  44. package/dist-types/commands/ForgetDeviceCommand.d.ts +6 -4
  45. package/dist-types/commands/ForgotPasswordCommand.d.ts +14 -14
  46. package/dist-types/commands/GetDeviceCommand.d.ts +5 -4
  47. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +15 -14
  48. package/dist-types/commands/GetUserCommand.d.ts +4 -3
  49. package/dist-types/commands/GlobalSignOutCommand.d.ts +4 -3
  50. package/dist-types/commands/InitiateAuthCommand.d.ts +14 -14
  51. package/dist-types/commands/ListDevicesCommand.d.ts +6 -4
  52. package/dist-types/commands/ListGroupsCommand.d.ts +2 -2
  53. package/dist-types/commands/ListIdentityProvidersCommand.d.ts +2 -2
  54. package/dist-types/commands/ListResourceServersCommand.d.ts +2 -2
  55. package/dist-types/commands/ListUserImportJobsCommand.d.ts +2 -2
  56. package/dist-types/commands/ListUserPoolClientsCommand.d.ts +2 -2
  57. package/dist-types/commands/ListUserPoolsCommand.d.ts +3 -3
  58. package/dist-types/commands/ListUsersCommand.d.ts +2 -2
  59. package/dist-types/commands/ListUsersInGroupCommand.d.ts +2 -2
  60. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +14 -14
  61. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +14 -14
  62. package/dist-types/commands/RevokeTokenCommand.d.ts +3 -3
  63. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +4 -3
  64. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +11 -11
  65. package/dist-types/commands/SetUserSettingsCommand.d.ts +4 -3
  66. package/dist-types/commands/SignUpCommand.d.ts +14 -14
  67. package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +3 -3
  68. package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +6 -4
  69. package/dist-types/commands/UpdateGroupCommand.d.ts +2 -2
  70. package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +2 -2
  71. package/dist-types/commands/UpdateResourceServerCommand.d.ts +2 -2
  72. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +15 -14
  73. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +2 -2
  74. package/dist-types/commands/UpdateUserPoolCommand.d.ts +14 -14
  75. package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +2 -2
  76. package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +3 -3
  77. package/dist-types/commands/VerifyUserAttributeCommand.d.ts +4 -3
  78. package/dist-types/models/models_0.d.ts +473 -459
  79. package/dist-types/models/models_1.d.ts +191 -74
  80. package/dist-types/ts3.4/models/models_0.d.ts +1 -1
  81. package/package.json +1 -1
@@ -26,11 +26,11 @@ declare const CreateIdentityProviderCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Creates an IdP for a user pool.</p>
29
+ * <p>Adds a configuration and trust relationship between a third-party identity provider (IdP) and a user pool.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>
@@ -29,8 +29,8 @@ declare const CreateResourceServerCommand_base: {
29
29
  * <p>Creates a new OAuth2.0 resource server and defines custom scopes within it.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>
@@ -29,8 +29,8 @@ declare const CreateUserImportJobCommand_base: {
29
29
  * <p>Creates a user import job.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>
@@ -34,8 +34,8 @@ declare const CreateUserPoolClientCommand_base: {
34
34
  * </important>
35
35
  * <note>
36
36
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
37
- * this operation, you must use IAM credentials to authorize requests, and you must
38
- * grant yourself the corresponding IAM permission in a policy.</p>
37
+ * this operation, you must use IAM credentials to authorize requests, and you must
38
+ * grant yourself the corresponding IAM permission in a policy.</p>
39
39
  * <p class="title">
40
40
  * <b>Learn more</b>
41
41
  * </p>
@@ -28,20 +28,20 @@ declare const CreateUserPoolCommand_base: {
28
28
  * @public
29
29
  * <note>
30
30
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
31
- * require you to register an origination phone number before you can send SMS messages
32
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
33
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
34
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
35
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
36
- * in.</p>
31
+ * require you to register an origination phone number before you can send SMS messages
32
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
33
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
34
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
35
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
36
+ * in.</p>
37
37
  * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
38
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
38
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
39
39
  * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
40
- * mode</a>
40
+ * mode</a>
41
41
  * </i>, you can send messages only to verified phone
42
- * numbers. After you test your app while in the sandbox environment, you can move out
43
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
44
- * Developer Guide</i>.</p>
42
+ * numbers. After you test your app while in the sandbox environment, you can move out
43
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
44
+ * Developer Guide</i>.</p>
45
45
  * </note>
46
46
  * <p>Creates a new Amazon Cognito user pool and sets the password policy for the
47
47
  * pool.</p>
@@ -50,8 +50,8 @@ declare const CreateUserPoolCommand_base: {
50
50
  * </important>
51
51
  * <note>
52
52
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
53
- * this operation, you must use IAM credentials to authorize requests, and you must
54
- * grant yourself the corresponding IAM permission in a policy.</p>
53
+ * this operation, you must use IAM credentials to authorize requests, and you must
54
+ * grant yourself the corresponding IAM permission in a policy.</p>
55
55
  * <p class="title">
56
56
  * <b>Learn more</b>
57
57
  * </p>
@@ -97,11 +97,11 @@ declare const CreateUserPoolCommand_base: {
97
97
  * CreateAuthChallenge: "STRING_VALUE",
98
98
  * VerifyAuthChallengeResponse: "STRING_VALUE",
99
99
  * PreTokenGeneration: "STRING_VALUE",
100
+ * UserMigration: "STRING_VALUE",
100
101
  * PreTokenGenerationConfig: { // PreTokenGenerationVersionConfigType
101
102
  * LambdaVersion: "V1_0" || "V2_0", // required
102
103
  * LambdaArn: "STRING_VALUE", // required
103
104
  * },
104
- * UserMigration: "STRING_VALUE",
105
105
  * CustomSMSSender: { // CustomSMSLambdaVersionConfigType
106
106
  * LambdaVersion: "V1_0", // required
107
107
  * LambdaArn: "STRING_VALUE", // required
@@ -226,11 +226,11 @@ declare const CreateUserPoolCommand_base: {
226
226
  * // CreateAuthChallenge: "STRING_VALUE",
227
227
  * // VerifyAuthChallengeResponse: "STRING_VALUE",
228
228
  * // PreTokenGeneration: "STRING_VALUE",
229
+ * // UserMigration: "STRING_VALUE",
229
230
  * // PreTokenGenerationConfig: { // PreTokenGenerationVersionConfigType
230
231
  * // LambdaVersion: "V1_0" || "V2_0", // required
231
232
  * // LambdaArn: "STRING_VALUE", // required
232
233
  * // },
233
- * // UserMigration: "STRING_VALUE",
234
234
  * // CustomSMSSender: { // CustomSMSLambdaVersionConfigType
235
235
  * // LambdaVersion: "V1_0", // required
236
236
  * // LambdaArn: "STRING_VALUE", // required
@@ -29,8 +29,8 @@ declare const CreateUserPoolDomainCommand_base: {
29
29
  * <p>Creates a new domain for a user pool.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>
@@ -27,11 +27,12 @@ declare const DeleteUserAttributesCommand_base: {
27
27
  /**
28
28
  * @public
29
29
  * <p>Deletes the attributes for a user.</p>
30
+ * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
30
31
  * <note>
31
32
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you can't use IAM credentials to authorize requests, and you can't
33
- * grant IAM permissions in policies. For more information about authorization models in
34
- * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
33
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
34
+ * grant IAM permissions in policies. For more information about authorization models in
35
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
35
36
  * </note>
36
37
  * @example
37
38
  * Use a bare-bones client and the command you need to make an API call.
@@ -27,11 +27,12 @@ declare const DeleteUserCommand_base: {
27
27
  /**
28
28
  * @public
29
29
  * <p>Allows a user to delete their own user profile.</p>
30
+ * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
30
31
  * <note>
31
32
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you can't use IAM credentials to authorize requests, and you can't
33
- * grant IAM permissions in policies. For more information about authorization models in
34
- * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
33
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
34
+ * grant IAM permissions in policies. For more information about authorization models in
35
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
35
36
  * </note>
36
37
  * @example
37
38
  * Use a bare-bones client and the command you need to make an API call.
@@ -30,8 +30,8 @@ declare const DescribeUserPoolClientCommand_base: {
30
30
  * specified user pool app client.</p>
31
31
  * <note>
32
32
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
33
- * this operation, you must use IAM credentials to authorize requests, and you must
34
- * grant yourself the corresponding IAM permission in a policy.</p>
33
+ * this operation, you must use IAM credentials to authorize requests, and you must
34
+ * grant yourself the corresponding IAM permission in a policy.</p>
35
35
  * <p class="title">
36
36
  * <b>Learn more</b>
37
37
  * </p>
@@ -29,8 +29,8 @@ declare const DescribeUserPoolCommand_base: {
29
29
  * <p>Returns the configuration information and metadata of the specified user pool.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>
@@ -83,11 +83,11 @@ declare const DescribeUserPoolCommand_base: {
83
83
  * // CreateAuthChallenge: "STRING_VALUE",
84
84
  * // VerifyAuthChallengeResponse: "STRING_VALUE",
85
85
  * // PreTokenGeneration: "STRING_VALUE",
86
+ * // UserMigration: "STRING_VALUE",
86
87
  * // PreTokenGenerationConfig: { // PreTokenGenerationVersionConfigType
87
88
  * // LambdaVersion: "V1_0" || "V2_0", // required
88
89
  * // LambdaArn: "STRING_VALUE", // required
89
90
  * // },
90
- * // UserMigration: "STRING_VALUE",
91
91
  * // CustomSMSSender: { // CustomSMSLambdaVersionConfigType
92
92
  * // LambdaVersion: "V1_0", // required
93
93
  * // LambdaArn: "STRING_VALUE", // required
@@ -26,12 +26,14 @@ declare const ForgetDeviceCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Forgets the specified device.</p>
29
+ * <p>Forgets the specified device. For more information about device authentication, see
30
+ * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
31
+ * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
30
32
  * <note>
31
33
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you can't use IAM credentials to authorize requests, and you can't
33
- * grant IAM permissions in policies. For more information about authorization models in
34
- * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
34
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
35
+ * grant IAM permissions in policies. For more information about authorization models in
36
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
35
37
  * </note>
36
38
  * @example
37
39
  * Use a bare-bones client and the command you need to make an API call.
@@ -38,26 +38,26 @@ declare const ForgotPasswordCommand_base: {
38
38
  * <code>NotAuthorizedException</code>.</p>
39
39
  * <note>
40
40
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
41
- * this operation, you can't use IAM credentials to authorize requests, and you can't
42
- * grant IAM permissions in policies. For more information about authorization models in
43
- * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
41
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
42
+ * grant IAM permissions in policies. For more information about authorization models in
43
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
44
44
  * </note>
45
45
  * <note>
46
46
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
47
- * require you to register an origination phone number before you can send SMS messages
48
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
49
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
50
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
51
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
52
- * in.</p>
47
+ * require you to register an origination phone number before you can send SMS messages
48
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
49
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
50
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
51
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
52
+ * in.</p>
53
53
  * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
54
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
54
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
55
55
  * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
56
- * mode</a>
56
+ * mode</a>
57
57
  * </i>, you can send messages only to verified phone
58
- * numbers. After you test your app while in the sandbox environment, you can move out
59
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
60
- * Developer Guide</i>.</p>
58
+ * numbers. After you test your app while in the sandbox environment, you can move out
59
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
60
+ * Developer Guide</i>.</p>
61
61
  * </note>
62
62
  * @example
63
63
  * Use a bare-bones client and the command you need to make an API call.
@@ -26,12 +26,13 @@ declare const GetDeviceCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Gets the device.</p>
29
+ * <p>Gets the device. For more information about device authentication, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
30
+ * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
30
31
  * <note>
31
32
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you can't use IAM credentials to authorize requests, and you can't
33
- * grant IAM permissions in policies. For more information about authorization models in
34
- * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
33
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
34
+ * grant IAM permissions in policies. For more information about authorization models in
35
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
35
36
  * </note>
36
37
  * @example
37
38
  * Use a bare-bones client and the command you need to make an API call.
@@ -29,28 +29,29 @@ declare const GetUserAttributeVerificationCodeCommand_base: {
29
29
  * <p>Generates a user attribute verification code for the specified attribute name. Sends a
30
30
  * message to a user with a code that they must return in a VerifyUserAttribute
31
31
  * request.</p>
32
+ * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
32
33
  * <note>
33
34
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
34
- * this operation, you can't use IAM credentials to authorize requests, and you can't
35
- * grant IAM permissions in policies. For more information about authorization models in
36
- * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
35
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
36
+ * grant IAM permissions in policies. For more information about authorization models in
37
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
37
38
  * </note>
38
39
  * <note>
39
40
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
40
- * require you to register an origination phone number before you can send SMS messages
41
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
42
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
43
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
44
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
45
- * in.</p>
41
+ * require you to register an origination phone number before you can send SMS messages
42
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
43
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
44
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
45
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
46
+ * in.</p>
46
47
  * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
47
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
48
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
48
49
  * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
49
- * mode</a>
50
+ * mode</a>
50
51
  * </i>, you can send messages only to verified phone
51
- * numbers. After you test your app while in the sandbox environment, you can move out
52
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
53
- * Developer Guide</i>.</p>
52
+ * numbers. After you test your app while in the sandbox environment, you can move out
53
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
54
+ * Developer Guide</i>.</p>
54
55
  * </note>
55
56
  * @example
56
57
  * Use a bare-bones client and the command you need to make an API call.
@@ -27,11 +27,12 @@ declare const GetUserCommand_base: {
27
27
  /**
28
28
  * @public
29
29
  * <p>Gets the user attributes and metadata for a user.</p>
30
+ * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
30
31
  * <note>
31
32
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you can't use IAM credentials to authorize requests, and you can't
33
- * grant IAM permissions in policies. For more information about authorization models in
34
- * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
33
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
34
+ * grant IAM permissions in policies. For more information about authorization models in
35
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
35
36
  * </note>
36
37
  * @example
37
38
  * Use a bare-bones client and the command you need to make an API call.
@@ -50,11 +50,12 @@ declare const GlobalSignOutCommand_base: {
50
50
  * </li>
51
51
  * </ul>
52
52
  * <p>Other requests might be valid until your user's token expires.</p>
53
+ * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
53
54
  * <note>
54
55
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
55
- * this operation, you can't use IAM credentials to authorize requests, and you can't
56
- * grant IAM permissions in policies. For more information about authorization models in
57
- * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
56
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
57
+ * grant IAM permissions in policies. For more information about authorization models in
58
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
58
59
  * </note>
59
60
  * @example
60
61
  * Use a bare-bones client and the command you need to make an API call.
@@ -30,26 +30,26 @@ declare const InitiateAuthCommand_base: {
30
30
  * with a federated IdP with <code>InitiateAuth</code>. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html"> Adding user pool sign-in through a third party</a>.</p>
31
31
  * <note>
32
32
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
33
- * this operation, you can't use IAM credentials to authorize requests, and you can't
34
- * grant IAM permissions in policies. For more information about authorization models in
35
- * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
33
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
34
+ * grant IAM permissions in policies. For more information about authorization models in
35
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
36
36
  * </note>
37
37
  * <note>
38
38
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
39
- * require you to register an origination phone number before you can send SMS messages
40
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
41
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
42
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
43
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
44
- * in.</p>
39
+ * require you to register an origination phone number before you can send SMS messages
40
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
41
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
42
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
43
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
44
+ * in.</p>
45
45
  * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
46
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
46
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
47
47
  * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
48
- * mode</a>
48
+ * mode</a>
49
49
  * </i>, you can send messages only to verified phone
50
- * numbers. After you test your app while in the sandbox environment, you can move out
51
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
52
- * Developer Guide</i>.</p>
50
+ * numbers. After you test your app while in the sandbox environment, you can move out
51
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
52
+ * Developer Guide</i>.</p>
53
53
  * </note>
54
54
  * @example
55
55
  * Use a bare-bones client and the command you need to make an API call.
@@ -26,12 +26,14 @@ declare const ListDevicesCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Lists the sign-in devices that Amazon Cognito has registered to the current user.</p>
29
+ * <p>Lists the sign-in devices that Amazon Cognito has registered to the current user. For more
30
+ * information about device authentication, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
31
+ * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
30
32
  * <note>
31
33
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you can't use IAM credentials to authorize requests, and you can't
33
- * grant IAM permissions in policies. For more information about authorization models in
34
- * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
34
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
35
+ * grant IAM permissions in policies. For more information about authorization models in
36
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
35
37
  * </note>
36
38
  * @example
37
39
  * Use a bare-bones client and the command you need to make an API call.
@@ -29,8 +29,8 @@ declare const ListGroupsCommand_base: {
29
29
  * <p>Lists the groups associated with a user pool.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>
@@ -29,8 +29,8 @@ declare const ListIdentityProvidersCommand_base: {
29
29
  * <p>Lists information about all IdPs for a user pool.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>
@@ -29,8 +29,8 @@ declare const ListResourceServersCommand_base: {
29
29
  * <p>Lists the resource servers for a user pool.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>
@@ -29,8 +29,8 @@ declare const ListUserImportJobsCommand_base: {
29
29
  * <p>Lists user import jobs for a user pool.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>
@@ -29,8 +29,8 @@ declare const ListUserPoolClientsCommand_base: {
29
29
  * <p>Lists the clients that have been created for the specified user pool.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>
@@ -29,8 +29,8 @@ declare const ListUserPoolsCommand_base: {
29
29
  * <p>Lists the user pools associated with an Amazon Web Services account.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>
@@ -74,11 +74,11 @@ declare const ListUserPoolsCommand_base: {
74
74
  * // CreateAuthChallenge: "STRING_VALUE",
75
75
  * // VerifyAuthChallengeResponse: "STRING_VALUE",
76
76
  * // PreTokenGeneration: "STRING_VALUE",
77
+ * // UserMigration: "STRING_VALUE",
77
78
  * // PreTokenGenerationConfig: { // PreTokenGenerationVersionConfigType
78
79
  * // LambdaVersion: "V1_0" || "V2_0", // required
79
80
  * // LambdaArn: "STRING_VALUE", // required
80
81
  * // },
81
- * // UserMigration: "STRING_VALUE",
82
82
  * // CustomSMSSender: { // CustomSMSLambdaVersionConfigType
83
83
  * // LambdaVersion: "V1_0", // required
84
84
  * // LambdaArn: "STRING_VALUE", // required
@@ -29,8 +29,8 @@ declare const ListUsersCommand_base: {
29
29
  * <p>Lists users and their basic details in a user pool.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>
@@ -29,8 +29,8 @@ declare const ListUsersInGroupCommand_base: {
29
29
  * <p>Lists the users in the specified group.</p>
30
30
  * <note>
31
31
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
- * this operation, you must use IAM credentials to authorize requests, and you must
33
- * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
34
  * <p class="title">
35
35
  * <b>Learn more</b>
36
36
  * </p>