@aws-sdk/client-cognito-identity-provider 3.750.0 → 3.760.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 (93) hide show
  1. package/README.md +4 -61
  2. package/dist-cjs/index.js +39 -6
  3. package/dist-es/models/models_0.js +13 -4
  4. package/dist-es/models/models_1.js +4 -0
  5. package/dist-es/protocols/Aws_json1_1.js +13 -1
  6. package/dist-types/CognitoIdentityProvider.d.ts +5 -62
  7. package/dist-types/CognitoIdentityProviderClient.d.ts +5 -62
  8. package/dist-types/commands/AddCustomAttributesCommand.d.ts +0 -3
  9. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +1 -2
  10. package/dist-types/commands/AdminCreateUserCommand.d.ts +12 -12
  11. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +2 -2
  12. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +10 -13
  13. package/dist-types/commands/AdminEnableUserCommand.d.ts +1 -1
  14. package/dist-types/commands/AdminGetDeviceCommand.d.ts +1 -1
  15. package/dist-types/commands/AdminGetUserCommand.d.ts +4 -3
  16. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +3 -0
  17. package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +11 -12
  18. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +1 -1
  19. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +2 -12
  20. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +0 -3
  21. package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +1 -1
  22. package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +10 -7
  23. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +20 -20
  24. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +0 -12
  25. package/dist-types/commands/ChangePasswordCommand.d.ts +1 -1
  26. package/dist-types/commands/CompleteWebAuthnRegistrationCommand.d.ts +2 -3
  27. package/dist-types/commands/ConfirmDeviceCommand.d.ts +4 -0
  28. package/dist-types/commands/ConfirmSignUpCommand.d.ts +7 -10
  29. package/dist-types/commands/CreateGroupCommand.d.ts +1 -1
  30. package/dist-types/commands/CreateManagedLoginBrandingCommand.d.ts +0 -3
  31. package/dist-types/commands/CreateUserImportJobCommand.d.ts +1 -3
  32. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +4 -5
  33. package/dist-types/commands/CreateUserPoolCommand.d.ts +8 -10
  34. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +3 -3
  35. package/dist-types/commands/DeleteUserAttributesCommand.d.ts +3 -3
  36. package/dist-types/commands/DeleteUserCommand.d.ts +2 -2
  37. package/dist-types/commands/DeleteUserPoolCommand.d.ts +7 -1
  38. package/dist-types/commands/DeleteWebAuthnCredentialCommand.d.ts +1 -1
  39. package/dist-types/commands/DescribeUserPoolCommand.d.ts +1 -1
  40. package/dist-types/commands/ForgetDeviceCommand.d.ts +2 -2
  41. package/dist-types/commands/ForgotPasswordCommand.d.ts +6 -11
  42. package/dist-types/commands/GetCSVHeaderCommand.d.ts +26 -2
  43. package/dist-types/commands/GetDeviceCommand.d.ts +2 -1
  44. package/dist-types/commands/GetGroupCommand.d.ts +23 -2
  45. package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +3 -1
  46. package/dist-types/commands/GetLogDeliveryConfigurationCommand.d.ts +22 -1
  47. package/dist-types/commands/GetSigningCertificateCommand.d.ts +26 -5
  48. package/dist-types/commands/GetUICustomizationCommand.d.ts +5 -5
  49. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +2 -3
  50. package/dist-types/commands/GetUserAuthFactorsCommand.d.ts +9 -3
  51. package/dist-types/commands/GetUserCommand.d.ts +1 -1
  52. package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +39 -1
  53. package/dist-types/commands/InitiateAuthCommand.d.ts +5 -2
  54. package/dist-types/commands/ListDevicesCommand.d.ts +1 -1
  55. package/dist-types/commands/ListGroupsCommand.d.ts +1 -1
  56. package/dist-types/commands/ListIdentityProvidersCommand.d.ts +2 -1
  57. package/dist-types/commands/ListResourceServersCommand.d.ts +2 -1
  58. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -4
  59. package/dist-types/commands/ListUserImportJobsCommand.d.ts +3 -1
  60. package/dist-types/commands/ListUserPoolClientsCommand.d.ts +2 -1
  61. package/dist-types/commands/ListUserPoolsCommand.d.ts +2 -2
  62. package/dist-types/commands/ListUsersCommand.d.ts +2 -1
  63. package/dist-types/commands/ListUsersInGroupCommand.d.ts +2 -1
  64. package/dist-types/commands/ListWebAuthnCredentialsCommand.d.ts +9 -2
  65. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +5 -2
  66. package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +3 -1
  67. package/dist-types/commands/SetRiskConfigurationCommand.d.ts +24 -5
  68. package/dist-types/commands/SetUICustomizationCommand.d.ts +23 -10
  69. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +0 -3
  70. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +2 -1
  71. package/dist-types/commands/SetUserSettingsCommand.d.ts +1 -1
  72. package/dist-types/commands/SignUpCommand.d.ts +3 -5
  73. package/dist-types/commands/StartUserImportJobCommand.d.ts +3 -1
  74. package/dist-types/commands/StartWebAuthnRegistrationCommand.d.ts +4 -6
  75. package/dist-types/commands/StopUserImportJobCommand.d.ts +3 -1
  76. package/dist-types/commands/UntagResourceCommand.d.ts +1 -2
  77. package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +13 -3
  78. package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +6 -2
  79. package/dist-types/commands/UpdateGroupCommand.d.ts +2 -1
  80. package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +4 -1
  81. package/dist-types/commands/UpdateManagedLoginBrandingCommand.d.ts +1 -5
  82. package/dist-types/commands/UpdateResourceServerCommand.d.ts +2 -1
  83. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +4 -5
  84. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +7 -4
  85. package/dist-types/commands/UpdateUserPoolCommand.d.ts +8 -7
  86. package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +4 -3
  87. package/dist-types/commands/VerifyUserAttributeCommand.d.ts +5 -3
  88. package/dist-types/index.d.ts +5 -62
  89. package/dist-types/models/models_0.d.ts +730 -642
  90. package/dist-types/models/models_1.d.ts +834 -558
  91. package/dist-types/ts3.4/models/models_0.d.ts +9 -6
  92. package/dist-types/ts3.4/models/models_1.d.ts +6 -1
  93. package/package.json +12 -12
@@ -1,25 +1,36 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { DocumentType as __DocumentType } from "@smithy/types";
3
3
  import { CognitoIdentityProviderServiceException as __BaseException } from "./CognitoIdentityProviderServiceException";
4
- import { AccountRecoverySettingType, AccountTakeoverRiskConfigurationType, AdminCreateUserConfigType, AnalyticsConfigurationType, AnalyticsMetadataType, AssetType, AttributeType, AuthenticationResultType, AuthFlowType, ChallengeNameType, CodeDeliveryDetailsType, CompromisedCredentialsRiskConfigurationType, CustomDomainConfigType, DeletionProtectionType, DeviceConfigurationType, DeviceRememberedStatusType, DeviceType, EmailConfigurationType, EmailMfaConfigType, EmailMfaSettingsType, ExplicitAuthFlowsType, FeedbackValueType, GroupType, IdentityProviderType, IdentityProviderTypeType, LambdaConfigType, LogConfigurationType, LogDeliveryConfigurationType, ManagedLoginBrandingType, MFAOptionType, OAuthFlowType, PreventUserExistenceErrorTypes, ResourceServerScopeType, ResourceServerType, RiskConfigurationType, RiskExceptionConfigurationType, SmsConfigurationType, SmsMfaConfigType, SMSMfaSettingsType, SoftwareTokenMfaConfigType, SoftwareTokenMfaSettingsType, StatusType, TokenValidityUnitsType, UICustomizationType, UserAttributeUpdateSettingsType, UserContextDataType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolMfaType, UserPoolPolicyType, UserPoolTierType, UserType, UserVerificationType, VerificationMessageTemplateType, VerifiedAttributeType } from "./models_0";
4
+ import { AccountRecoverySettingType, AccountTakeoverRiskConfigurationType, AdminCreateUserConfigType, AnalyticsConfigurationType, AnalyticsMetadataType, AssetType, AttributeType, AuthenticationResultType, AuthFlowType, ChallengeNameType, CodeDeliveryDetailsType, CompromisedCredentialsRiskConfigurationType, CustomDomainConfigType, DeletionProtectionType, DeviceConfigurationType, DeviceRememberedStatusType, DeviceType, EmailConfigurationType, EmailMfaConfigType, EmailMfaSettingsType, ExplicitAuthFlowsType, FeedbackValueType, GroupType, IdentityProviderType, IdentityProviderTypeType, LambdaConfigType, LogConfigurationType, LogDeliveryConfigurationType, ManagedLoginBrandingType, MFAOptionType, OAuthFlowType, PreventUserExistenceErrorTypes, ResourceServerScopeType, ResourceServerType, RiskConfigurationType, RiskExceptionConfigurationType, SmsConfigurationType, SmsMfaConfigType, SMSMfaSettingsType, SoftwareTokenMfaConfigType, SoftwareTokenMfaSettingsType, StatusType, TokenValidityUnitsType, UICustomizationType, UserAttributeUpdateSettingsType, UserContextDataType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolMfaType, UserPoolPolicyType, UserPoolTierType, UserType, VerificationMessageTemplateType, VerifiedAttributeType } from "./models_0";
5
5
  /**
6
- * <p>Settings for multi-factor authentication (MFA) with passkey, or webauthN, biometric
7
- * and security-key devices in a user pool. Configures the following:</p>
6
+ * @public
7
+ * @enum
8
+ */
9
+ export declare const UserVerificationType: {
10
+ readonly PREFERRED: "preferred";
11
+ readonly REQUIRED: "required";
12
+ };
13
+ /**
14
+ * @public
15
+ */
16
+ export type UserVerificationType = (typeof UserVerificationType)[keyof typeof UserVerificationType];
17
+ /**
18
+ * <p>Settings for authentication (MFA) with passkey, or webauthN, biometric and
19
+ * security-key devices in a user pool. Configures the following:</p>
8
20
  * <ul>
9
21
  * <li>
10
- * <p>Configuration at the user-pool level for whether you want to require passkey
11
- * configuration as an MFA factor, or include it as a choice.</p>
22
+ * <p>Configuration for requiring user-verification support in passkeys.</p>
12
23
  * </li>
13
24
  * <li>
14
- * <p>The user pool relying-party ID. This is the user pool domain that user's
15
- * passkey providers should trust as a receiver of passkey authentication.</p>
25
+ * <p>The user pool relying-party ID. This is the domain, typically your user pool
26
+ * domain, that user's passkey providers should trust as a receiver of passkey
27
+ * authentication.</p>
16
28
  * </li>
17
29
  * <li>
18
30
  * <p>The providers that you want to allow as origins for passkey
19
31
  * authentication.</p>
20
32
  * </li>
21
33
  * </ul>
22
- * <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html">GetUserPoolMfaConfig</a>. </p>
23
34
  * @public
24
35
  */
25
36
  export interface WebAuthnConfigurationType {
@@ -58,7 +69,7 @@ export interface WebAuthnConfigurationType {
58
69
  */
59
70
  export interface GetUserPoolMfaConfigResponse {
60
71
  /**
61
- * <p>Shows user pool SMS message configuration for MFA. Includes the message template and
72
+ * <p>Shows user pool configuration for SMS message MFA. Includes the message template and
62
73
  * the SMS message sending configuration for Amazon SNS.</p>
63
74
  * @public
64
75
  */
@@ -70,35 +81,31 @@ export interface GetUserPoolMfaConfigResponse {
70
81
  */
71
82
  SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
72
83
  /**
73
- * <p>Shows user pool email message configuration for MFA. Includes the subject and body of
74
- * the email message template for MFA messages. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
75
- * advanced security features</a> must be active in your user pool.</p>
84
+ * <p>Shows configuration for user pool email message MFA and sign-in with one-time
85
+ * passwords (OTPs). Includes the subject and body of the email message template for
86
+ * sign-in and MFA messages. To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
87
+ * Essentials tier</a> or higher.</p>
76
88
  * @public
77
89
  */
78
90
  EmailMfaConfiguration?: EmailMfaConfigType | undefined;
79
91
  /**
80
- * <p>The multi-factor authentication (MFA) configuration. Valid values include:</p>
81
- * <ul>
82
- * <li>
83
- * <p>
84
- * <code>OFF</code> MFA won't be used for any users.</p>
85
- * </li>
86
- * <li>
87
- * <p>
88
- * <code>ON</code> MFA is required for all users to sign in.</p>
89
- * </li>
90
- * <li>
91
- * <p>
92
- * <code>OPTIONAL</code> MFA will be required only for individual users who have
93
- * an MFA factor activated.</p>
94
- * </li>
95
- * </ul>
92
+ * <p>Displays the state of multi-factor authentication (MFA) as on, off, or optional. When
93
+ * <code>ON</code>, all users must set up MFA before they can sign in. When
94
+ * <code>OPTIONAL</code>, your application must make a client-side determination of
95
+ * whether a user wants to register an MFA device. For user pools with adaptive
96
+ * authentication with threat protection, choose <code>OPTIONAL</code>.</p>
97
+ * <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
98
+ * doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
99
+ * API responses and in managed login for users who have chosen and configured a preferred
100
+ * MFA factor.</p>
96
101
  * @public
97
102
  */
98
103
  MfaConfiguration?: UserPoolMfaType | undefined;
99
104
  /**
100
- * <p>Shows user pool configuration for MFA with passkeys from biometric devices and
101
- * security keys.</p>
105
+ * <p>Shows user pool configuration for sign-in with passkey authenticators like biometric
106
+ * devices and security keys. Passkeys are not eligible MFA factors. They are instead an
107
+ * eligible primary sign-in factor for <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a>, or the
108
+ * <code>USER_AUTH</code> flow.</p>
102
109
  * @public
103
110
  */
104
111
  WebAuthnConfiguration?: WebAuthnConfigurationType | undefined;
@@ -109,7 +116,8 @@ export interface GetUserPoolMfaConfigResponse {
109
116
  */
110
117
  export interface GlobalSignOutRequest {
111
118
  /**
112
- * <p>A valid access token that Amazon Cognito issued to the user who you want to sign out.</p>
119
+ * <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
120
+ * <code>aws.cognito.signin.user.admin</code>.</p>
113
121
  * @public
114
122
  */
115
123
  AccessToken: string | undefined;
@@ -128,42 +136,17 @@ export interface InitiateAuthRequest {
128
136
  /**
129
137
  * <p>The authentication flow that you want to initiate. Each <code>AuthFlow</code> has
130
138
  * linked <code>AuthParameters</code> that you must submit. The following are some example
131
- * flows and their parameters.</p>
132
- * <ul>
133
- * <li>
134
- * <p>
135
- * <code>USER_AUTH</code>: Request a preferred authentication type or review
136
- * available authentication types. From the offered authentication types, select
137
- * one in a challenge response and then authenticate with that method in an
138
- * additional challenge response.</p>
139
- * </li>
140
- * <li>
141
- * <p>
142
- * <code>REFRESH_TOKEN_AUTH</code>: Receive new ID and access tokens when you
143
- * pass a <code>REFRESH_TOKEN</code> parameter with a valid refresh token as the
144
- * value.</p>
145
- * </li>
146
- * <li>
147
- * <p>
148
- * <code>USER_SRP_AUTH</code>: Receive secure remote password (SRP) variables for
149
- * the next challenge, <code>PASSWORD_VERIFIER</code>, when you pass
150
- * <code>USERNAME</code> and <code>SRP_A</code> parameters.</p>
151
- * </li>
152
- * <li>
153
- * <p>
154
- * <code>USER_PASSWORD_AUTH</code>: Receive new tokens or the next challenge, for
155
- * example <code>SOFTWARE_TOKEN_MFA</code>, when you pass <code>USERNAME</code> and
156
- * <code>PASSWORD</code> parameters.</p>
157
- * </li>
158
- * </ul>
159
- * <p>
160
- * <i>All flows</i>
161
- * </p>
139
+ * flows.</p>
162
140
  * <dl>
163
141
  * <dt>USER_AUTH</dt>
164
142
  * <dd>
165
- * <p>The entry point for sign-in with passwords, one-time passwords, and
166
- * WebAuthN authenticators.</p>
143
+ * <p>The entry point for <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a> with passwords,
144
+ * one-time passwords, and WebAuthn authenticators. Request a preferred
145
+ * authentication type or review available authentication types. From the
146
+ * offered authentication types, select one in a challenge response and then
147
+ * authenticate with that method in an additional challenge response.
148
+ * To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
149
+ * Essentials tier</a> or higher.</p>
167
150
  * </dd>
168
151
  * <dt>USER_SRP_AUTH</dt>
169
152
  * <dd>
@@ -173,8 +156,9 @@ export interface InitiateAuthRequest {
173
156
  * </dd>
174
157
  * <dt>REFRESH_TOKEN_AUTH and REFRESH_TOKEN</dt>
175
158
  * <dd>
176
- * <p>Provide a valid refresh token and receive new ID and access tokens. For
177
- * more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-the-refresh-token.html">Using the refresh token</a>.</p>
159
+ * <p>Receive new ID and access tokens when you pass a
160
+ * <code>REFRESH_TOKEN</code> parameter with a valid refresh token as the
161
+ * value. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-the-refresh-token.html">Using the refresh token</a>.</p>
178
162
  * </dd>
179
163
  * <dt>CUSTOM_AUTH</dt>
180
164
  * <dd>
@@ -184,46 +168,51 @@ export interface InitiateAuthRequest {
184
168
  * </dd>
185
169
  * <dt>USER_PASSWORD_AUTH</dt>
186
170
  * <dd>
187
- * <p>Username-password authentication with the password sent directly in the
188
- * request. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#Built-in-authentication-flow-and-challenges">Admin authentication flow</a>.</p>
171
+ * <p>Client-side username-password authentication with the password sent
172
+ * directly in the request. For more information about client-side and
173
+ * server-side authentication, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-public-server-side.html">SDK authorization models</a>.</p>
189
174
  * </dd>
190
175
  * </dl>
191
176
  * <p>
192
- * <code>ADMIN_USER_PASSWORD_AUTH</code> is a flow type of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a> and isn't valid for InitiateAuth.
193
- * <code>ADMIN_NO_SRP_AUTH</code> is a legacy server-side username-password flow and
194
- * isn't valid for InitiateAuth.</p>
177
+ * <code>ADMIN_USER_PASSWORD_AUTH</code> is a flow type of <code>AdminInitiateAuth</code>
178
+ * and isn't valid for InitiateAuth. <code>ADMIN_NO_SRP_AUTH</code> is a legacy server-side
179
+ * username-password flow and isn't valid for InitiateAuth.</p>
195
180
  * @public
196
181
  */
197
182
  AuthFlow: AuthFlowType | undefined;
198
183
  /**
199
184
  * <p>The authentication parameters. These are inputs corresponding to the
200
- * <code>AuthFlow</code> that you're invoking. The required values depend on the value
201
- * of <code>AuthFlow</code>:</p>
185
+ * <code>AuthFlow</code> that you're invoking.</p>
186
+ * <p>The required values are specific to the <a>InitiateAuthRequest$AuthFlow</a>.</p>
187
+ * <p>The following are some authentication flows and their parameters. Add a
188
+ * <code>SECRET_HASH</code> parameter if your app client has a client secret.</p>
202
189
  * <ul>
203
190
  * <li>
204
- * <p>For <code>USER_AUTH</code>: <code>USERNAME</code> (required),
191
+ * <p>
192
+ * <code>USER_AUTH</code>: <code>USERNAME</code> (required),
205
193
  * <code>PREFERRED_CHALLENGE</code>. If you don't provide a value for
206
194
  * <code>PREFERRED_CHALLENGE</code>, Amazon Cognito responds with the
207
195
  * <code>AvailableChallenges</code> parameter that specifies the available
208
196
  * sign-in methods.</p>
209
197
  * </li>
210
198
  * <li>
211
- * <p>For <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required),
212
- * <code>SRP_A</code> (required), <code>SECRET_HASH</code> (required if the app
213
- * client is configured with a client secret), <code>DEVICE_KEY</code>.</p>
199
+ * <p>
200
+ * <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required),
201
+ * <code>SRP_A</code> (required), <code>DEVICE_KEY</code>.</p>
214
202
  * </li>
215
203
  * <li>
216
- * <p>For <code>USER_PASSWORD_AUTH</code>: <code>USERNAME</code> (required),
217
- * <code>PASSWORD</code> (required), <code>SECRET_HASH</code> (required if the
218
- * app client is configured with a client secret), <code>DEVICE_KEY</code>.</p>
204
+ * <p>
205
+ * <code>USER_PASSWORD_AUTH</code>: <code>USERNAME</code> (required),
206
+ * <code>PASSWORD</code> (required), <code>DEVICE_KEY</code>.</p>
219
207
  * </li>
220
208
  * <li>
221
- * <p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
222
- * (required), <code>SECRET_HASH</code> (required if the app client is configured
223
- * with a client secret), <code>DEVICE_KEY</code>.</p>
209
+ * <p>
210
+ * <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
211
+ * (required), <code>DEVICE_KEY</code>.</p>
224
212
  * </li>
225
213
  * <li>
226
- * <p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
214
+ * <p>
215
+ * <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
227
216
  * <code>SECRET_HASH</code> (if app client is configured with client secret),
228
217
  * <code>DEVICE_KEY</code>. To start the authentication flow with password
229
218
  * verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
@@ -239,12 +228,12 @@ export interface InitiateAuthRequest {
239
228
  * <p>A map of custom key-value pairs that you can provide as input for certain custom
240
229
  * workflows that this action triggers.</p>
241
230
  * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
242
- * When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are
243
- * specified for various triggers. The ClientMetadata value is passed as input to the
244
- * functions for only the following triggers:</p>
231
+ * When you send an <code>InitiateAuth</code> request, Amazon Cognito invokes the Lambda functions
232
+ * that are specified for various triggers. The <code>ClientMetadata</code> value is passed
233
+ * as input to the functions for only the following triggers.</p>
245
234
  * <ul>
246
235
  * <li>
247
- * <p>Pre signup</p>
236
+ * <p>Pre sign-up</p>
248
237
  * </li>
249
238
  * <li>
250
239
  * <p>Pre authentication</p>
@@ -253,14 +242,15 @@ export interface InitiateAuthRequest {
253
242
  * <p>User migration</p>
254
243
  * </li>
255
244
  * </ul>
256
- * <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which
257
- * the function receives as input. This payload contains a <code>validationData</code>
258
- * attribute, which provides the data that you assigned to the ClientMetadata parameter in
259
- * your InitiateAuth request. In your function code in Lambda, you can process the
260
- * <code>validationData</code> value to enhance your workflow for your specific
261
- * needs.</p>
262
- * <p>When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the
263
- * following triggers, but it doesn't provide the ClientMetadata value as input:</p>
245
+ * <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload as input
246
+ * to the function. This payload contains a <code>validationData</code> attribute with the
247
+ * data that you assigned to the <code>ClientMetadata</code> parameter in your
248
+ * <code>InitiateAuth</code> request. In your function, <code>validationData</code> can
249
+ * contribute to operations that require data that isn't in the default
250
+ * payload.</p>
251
+ * <p>
252
+ * <code>InitiateAuth</code> requests invokes the following triggers without
253
+ * <code>ClientMetadata</code> as input.</p>
264
254
  * <ul>
265
255
  * <li>
266
256
  * <p>Post authentication</p>
@@ -285,7 +275,7 @@ export interface InitiateAuthRequest {
285
275
  * </li>
286
276
  * </ul>
287
277
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
288
- * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
278
+ * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
289
279
  * <note>
290
280
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
291
281
  * following:</p>
@@ -309,19 +299,20 @@ export interface InitiateAuthRequest {
309
299
  */
310
300
  ClientMetadata?: Record<string, string> | undefined;
311
301
  /**
312
- * <p>The app client ID.</p>
302
+ * <p>The ID of the app client that your user wants to sign in to.</p>
313
303
  * @public
314
304
  */
315
305
  ClientId: string | undefined;
316
306
  /**
317
- * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
318
- * <code>InitiateAuth</code> calls.</p>
307
+ * <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
308
+ * user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
309
+ * email address, or phone number.</p>
319
310
  * @public
320
311
  */
321
312
  AnalyticsMetadata?: AnalyticsMetadataType | undefined;
322
313
  /**
323
- * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
324
- * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
314
+ * <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
315
+ * protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
325
316
  * when it makes API requests.</p>
326
317
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
327
318
  * applications</a>.</p>
@@ -331,7 +322,12 @@ export interface InitiateAuthRequest {
331
322
  /**
332
323
  * <p>The optional session ID from a <code>ConfirmSignUp</code> API request. You can sign in
333
324
  * a user directly from the sign-up process with the <code>USER_AUTH</code> authentication
334
- * flow.</p>
325
+ * flow. When you pass the session ID to <code>InitiateAuth</code>, Amazon Cognito assumes the SMS
326
+ * or email message one-time verification password from <code>ConfirmSignUp</code> as the
327
+ * primary authentication factor. You're not required to submit this code a second
328
+ * time. This option is only valid for users who have confirmed their sign-up and are
329
+ * signing in for the first time within the authentication flow session duration of the
330
+ * session ID.</p>
335
331
  * @public
336
332
  */
337
333
  Session?: string | undefined;
@@ -342,20 +338,18 @@ export interface InitiateAuthRequest {
342
338
  */
343
339
  export interface InitiateAuthResponse {
344
340
  /**
345
- * <p>The name of the challenge that you're responding to with this call. This name is
346
- * returned in the <code>InitiateAuth</code> response if you must pass another
347
- * challenge.</p>
348
- * <p>Valid values include the following:</p>
341
+ * <p>The name of an additional authentication challenge that you must respond to.</p>
342
+ * <p>Possible challenges include the following:</p>
349
343
  * <note>
350
- * <p>All of the following challenges require <code>USERNAME</code> and
351
- * <code>SECRET_HASH</code> (if applicable) in the parameters.</p>
344
+ * <p>All of the following challenges require <code>USERNAME</code> and, when the app
345
+ * client has a client secret, <code>SECRET_HASH</code> in the parameters.</p>
352
346
  * </note>
353
347
  * <ul>
354
348
  * <li>
355
349
  * <p>
356
350
  * <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
357
- * successful authentication with a passkey, or webauthN, factor. These are
358
- * typically biometric devices or security keys.</p>
351
+ * successful authentication with a WebAuthn authenticator, or passkey. Examples
352
+ * of WebAuthn authenticators include biometric devices and security keys.</p>
359
353
  * </li>
360
354
  * <li>
361
355
  * <p>
@@ -380,58 +374,56 @@ export interface InitiateAuthResponse {
380
374
  * </li>
381
375
  * <li>
382
376
  * <p>
383
- * <code>SMS_MFA</code>: Next challenge is to supply an
384
- * <code>SMS_MFA_CODE</code>that your user pool delivered in an SMS message.</p>
377
+ * <code>SMS_MFA</code>: Respond with an
378
+ * <code>SMS_MFA_CODE</code> that your user pool delivered in an SMS message.</p>
385
379
  * </li>
386
380
  * <li>
387
381
  * <p>
388
- * <code>EMAIL_OTP</code>: Next challenge is to supply an
382
+ * <code>EMAIL_OTP</code>: Respond with an
389
383
  * <code>EMAIL_OTP_CODE</code> that your user pool delivered in an email
390
384
  * message.</p>
391
385
  * </li>
392
386
  * <li>
393
387
  * <p>
394
- * <code>PASSWORD_VERIFIER</code>: Next challenge is to supply
388
+ * <code>PASSWORD_VERIFIER</code>: Respond with
395
389
  * <code>PASSWORD_CLAIM_SIGNATURE</code>,
396
390
  * <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
397
- * the client-side SRP calculations.</p>
391
+ * client-side SRP calculations.</p>
398
392
  * </li>
399
393
  * <li>
400
394
  * <p>
401
395
  * <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
402
396
  * flow determines that the user should pass another challenge before tokens are
403
- * issued.</p>
397
+ * issued. The parameters of the challenge are determined by your Lambda function.</p>
404
398
  * </li>
405
399
  * <li>
406
400
  * <p>
407
- * <code>DEVICE_SRP_AUTH</code>: If device tracking was activated on your user
408
- * pool and the previous challenges were passed, this challenge is returned so that
409
- * Amazon Cognito can start tracking this device.</p>
401
+ * <code>DEVICE_SRP_AUTH</code>: Respond with the initial parameters of device SRP
402
+ * authentication. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
410
403
  * </li>
411
404
  * <li>
412
405
  * <p>
413
- * <code>DEVICE_PASSWORD_VERIFIER</code>: Similar to
414
- * <code>PASSWORD_VERIFIER</code>, but for devices only.</p>
406
+ * <code>DEVICE_PASSWORD_VERIFIER</code>: Respond with
407
+ * <code>PASSWORD_CLAIM_SIGNATURE</code>,
408
+ * <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
409
+ * client-side SRP calculations. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
415
410
  * </li>
416
411
  * <li>
417
412
  * <p>
418
413
  * <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
419
- * passwords after successful first login.</p>
420
- * <p>Respond to this challenge with <code>NEW_PASSWORD</code> and any required
421
- * attributes that Amazon Cognito returned in the <code>requiredAttributes</code> parameter.
422
- * You can also set values for attributes that aren't required by your user pool
423
- * and that your app client can write. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html">RespondToAuthChallenge</a>.</p>
414
+ * passwords after successful first login. Respond to this challenge with
415
+ * <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in
416
+ * the <code>requiredAttributes</code> parameter. You can also set values for
417
+ * attributes that aren't required by your user pool and that your app client
418
+ * can write.</p>
424
419
  * <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
425
- * Because of this, and because in some cases you can create users who don't have
426
- * values for required attributes, take care to collect and submit
427
- * required-attribute values for all users who don't have passwords. You can create
428
- * a user in the Amazon Cognito console without, for example, a required
429
- * <code>birthdate</code> attribute. The API response from Amazon Cognito won't prompt
430
- * you to submit a birthdate for the user if they don't have a password.</p>
420
+ * When you create passwordless users, you must provide values for all required
421
+ * attributes.</p>
431
422
  * <note>
432
423
  * <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
433
- * In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter,
434
- * then use the <code>UpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p>
424
+ * In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
425
+ * <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
426
+ * operation to modify the value of any additional attributes.</p>
435
427
  * </note>
436
428
  * </li>
437
429
  * <li>
@@ -439,49 +431,50 @@ export interface InitiateAuthResponse {
439
431
  * <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
440
432
  * before they can sign in. The MFA types activated for the user pool will be
441
433
  * listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
442
- * <p> To set up software token MFA, use the session returned here from
443
- * <code>InitiateAuth</code> as an input to
444
- * <code>AssociateSoftwareToken</code>. Use the session returned by
445
- * <code>VerifySoftwareToken</code> as an input to
446
- * <code>RespondToAuthChallenge</code> with challenge name
447
- * <code>MFA_SETUP</code> to complete sign-in. To set up SMS MFA, an
448
- * administrator should help the user to add a phone number to their account, and
449
- * then the user should call <code>InitiateAuth</code> again to restart
450
- * sign-in.</p>
434
+ * <p>To set up time-based one-time password (TOTP) MFA, use the session returned
435
+ * in this challenge from <code>InitiateAuth</code> or <code>AdminInitiateAuth</code>
436
+ * as an input to <code>AssociateSoftwareToken</code>. Then, use the session returned
437
+ * by <code>VerifySoftwareToken</code> as an input to
438
+ * <code>RespondToAuthChallenge</code> or <code>AdminRespondToAuthChallenge</code>
439
+ * with challenge name <code>MFA_SETUP</code> to complete sign-in.
440
+ * </p>
441
+ * <p>To set up SMS or email MFA, collect a <code>phone_number</code> or
442
+ * <code>email</code> attribute for the user. Then restart the authentication
443
+ * flow with an <code>InitiateAuth</code> or <code>AdminInitiateAuth</code> request.
444
+ * </p>
451
445
  * </li>
452
446
  * </ul>
453
447
  * @public
454
448
  */
455
449
  ChallengeName?: ChallengeNameType | undefined;
456
450
  /**
457
- * <p>The session that should pass both ways in challenge-response calls to the service. If
458
- * the caller must pass another challenge, they return a session with other challenge
459
- * parameters. Include this session identifier in a <code>RespondToAuthChallenge</code> API
460
- * request.</p>
451
+ * <p>The session identifier that links a challenge response to the initial authentication
452
+ * request. If the user must pass another challenge, Amazon Cognito returns a session ID and
453
+ * challenge parameters.</p>
461
454
  * @public
462
455
  */
463
456
  Session?: string | undefined;
464
457
  /**
465
- * <p>The challenge parameters. These are returned in the <code>InitiateAuth</code> response
466
- * if you must pass another challenge. The responses in this parameter should be used to
467
- * compute inputs to the next call (<code>RespondToAuthChallenge</code>). </p>
458
+ * <p>The required parameters of the <code>ChallengeName</code> challenge.</p>
468
459
  * <p>All challenges require <code>USERNAME</code>. They also require
469
460
  * <code>SECRET_HASH</code> if your app client has a client secret.</p>
470
461
  * @public
471
462
  */
472
463
  ChallengeParameters?: Record<string, string> | undefined;
473
464
  /**
474
- * <p>The result of the authentication response. This result is only returned if the caller
475
- * doesn't need to pass another challenge. If the caller does need to pass another
476
- * challenge before it gets tokens, <code>ChallengeName</code>,
477
- * <code>ChallengeParameters</code>, and <code>Session</code> are returned.</p>
465
+ * <p>The result of a successful and complete authentication request. This result is only
466
+ * returned if the user doesn't need to pass another challenge. If they must pass another
467
+ * challenge before they get tokens, Amazon Cognito returns a challenge in
468
+ * <code>ChallengeName</code>, <code>ChallengeParameters</code>, and
469
+ * <code>Session</code> response parameters.</p>
478
470
  * @public
479
471
  */
480
472
  AuthenticationResult?: AuthenticationResultType | undefined;
481
473
  /**
482
- * <p>This response parameter prompts a user to select from multiple available challenges
483
- * that they can complete authentication with. For example, they might be able to continue
484
- * with passwordless authentication or with a one-time password from an SMS message.</p>
474
+ * <p>This response parameter lists the available authentication challenges that users can
475
+ * select from in <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a>. For example, they might be
476
+ * able to choose between passkey authentication, a one-time password from an SMS message,
477
+ * and a traditional password.</p>
485
478
  * @public
486
479
  */
487
480
  AvailableChallenges?: ChallengeNameType[] | undefined;
@@ -492,13 +485,13 @@ export interface InitiateAuthResponse {
492
485
  */
493
486
  export interface ListDevicesRequest {
494
487
  /**
495
- * <p>A valid access token that Amazon Cognito issued to the user whose list of devices you want to
496
- * view.</p>
488
+ * <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
489
+ * <code>aws.cognito.signin.user.admin</code>.</p>
497
490
  * @public
498
491
  */
499
492
  AccessToken: string | undefined;
500
493
  /**
501
- * <p>The limit of the device request.</p>
494
+ * <p>The maximum number of devices that you want Amazon Cognito to return in the response.</p>
502
495
  * @public
503
496
  */
504
497
  Limit?: number | undefined;
@@ -518,7 +511,8 @@ export interface ListDevicesRequest {
518
511
  */
519
512
  export interface ListDevicesResponse {
520
513
  /**
521
- * <p>The devices returned in the list devices response.</p>
514
+ * <p>An array of devices and their details. Each entry that's returned includes device
515
+ * information, last-accessed and created dates, and the device key.</p>
522
516
  * @public
523
517
  */
524
518
  Devices?: DeviceType[] | undefined;
@@ -535,18 +529,21 @@ export interface ListDevicesResponse {
535
529
  */
536
530
  export interface ListGroupsRequest {
537
531
  /**
538
- * <p>The ID of the user pool.</p>
532
+ * <p>The ID of the user pool where you want to list user groups.</p>
539
533
  * @public
540
534
  */
541
535
  UserPoolId: string | undefined;
542
536
  /**
543
- * <p>The limit of the request to list groups.</p>
537
+ * <p>The maximum number of groups that you want Amazon Cognito to return in the response.</p>
544
538
  * @public
545
539
  */
546
540
  Limit?: number | undefined;
547
541
  /**
548
- * <p>An identifier that was returned from the previous call to this operation, which can be
549
- * used to return the next set of items in the list.</p>
542
+ * <p>This API operation returns a limited number of results. The pagination token is
543
+ * an identifier that you can present in an additional API request with the same parameters. When
544
+ * you include the pagination token, Amazon Cognito returns the next set of items after the current list.
545
+ * Subsequent requests return a new pagination token. By use of this token, you can paginate
546
+ * through the full list of items.</p>
550
547
  * @public
551
548
  */
552
549
  NextToken?: string | undefined;
@@ -556,13 +553,15 @@ export interface ListGroupsRequest {
556
553
  */
557
554
  export interface ListGroupsResponse {
558
555
  /**
559
- * <p>The group objects for the groups.</p>
556
+ * <p>An array of groups and their details. Each entry that's returned includes
557
+ * description, precedence, and IAM role values.</p>
560
558
  * @public
561
559
  */
562
560
  Groups?: GroupType[] | undefined;
563
561
  /**
564
- * <p>An identifier that was returned from the previous call to this operation, which can be
565
- * used to return the next set of items in the list.</p>
562
+ * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
563
+ * you include a pagination token in your request, Amazon Cognito returns the next set of items in
564
+ * the list. By use of this token, you can paginate through the full list of items.</p>
566
565
  * @public
567
566
  */
568
567
  NextToken?: string | undefined;
@@ -572,24 +571,27 @@ export interface ListGroupsResponse {
572
571
  */
573
572
  export interface ListIdentityProvidersRequest {
574
573
  /**
575
- * <p>The user pool ID.</p>
574
+ * <p>The ID of the user pool where you want to list IdPs.</p>
576
575
  * @public
577
576
  */
578
577
  UserPoolId: string | undefined;
579
578
  /**
580
- * <p>The maximum number of IdPs to return.</p>
579
+ * <p>The maximum number of IdPs that you want Amazon Cognito to return in the response.</p>
581
580
  * @public
582
581
  */
583
582
  MaxResults?: number | undefined;
584
583
  /**
585
- * <p>A pagination token.</p>
584
+ * <p>This API operation returns a limited number of results. The pagination token is
585
+ * an identifier that you can present in an additional API request with the same parameters. When
586
+ * you include the pagination token, Amazon Cognito returns the next set of items after the current list.
587
+ * Subsequent requests return a new pagination token. By use of this token, you can paginate
588
+ * through the full list of items.</p>
586
589
  * @public
587
590
  */
588
591
  NextToken?: string | undefined;
589
592
  }
590
593
  /**
591
594
  * <p>The details of a user pool identity provider (IdP), including name and type.</p>
592
- * <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListIdentityProviders.html">ListIdentityProviders</a>.</p>
593
595
  * @public
594
596
  */
595
597
  export interface ProviderDescription {
@@ -623,12 +625,15 @@ export interface ProviderDescription {
623
625
  */
624
626
  export interface ListIdentityProvidersResponse {
625
627
  /**
626
- * <p>A list of IdP objects.</p>
628
+ * <p>An array of the IdPs in your user pool. For each, the response includes identifiers,
629
+ * the IdP name and type, and trust-relationship details like the issuer URL.</p>
627
630
  * @public
628
631
  */
629
632
  Providers: ProviderDescription[] | undefined;
630
633
  /**
631
- * <p>A pagination token.</p>
634
+ * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
635
+ * you include a pagination token in your request, Amazon Cognito returns the next set of items in
636
+ * the list. By use of this token, you can paginate through the full list of items.</p>
632
637
  * @public
633
638
  */
634
639
  NextToken?: string | undefined;
@@ -638,17 +643,22 @@ export interface ListIdentityProvidersResponse {
638
643
  */
639
644
  export interface ListResourceServersRequest {
640
645
  /**
641
- * <p>The ID of the user pool.</p>
646
+ * <p>The ID of the user pool where you want to list resource servers.</p>
642
647
  * @public
643
648
  */
644
649
  UserPoolId: string | undefined;
645
650
  /**
646
- * <p>The maximum number of resource servers to return.</p>
651
+ * <p>The maximum number of resource servers that you want Amazon Cognito to return in the
652
+ * response.</p>
647
653
  * @public
648
654
  */
649
655
  MaxResults?: number | undefined;
650
656
  /**
651
- * <p>A pagination token.</p>
657
+ * <p>This API operation returns a limited number of results. The pagination token is
658
+ * an identifier that you can present in an additional API request with the same parameters. When
659
+ * you include the pagination token, Amazon Cognito returns the next set of items after the current list.
660
+ * Subsequent requests return a new pagination token. By use of this token, you can paginate
661
+ * through the full list of items.</p>
652
662
  * @public
653
663
  */
654
664
  NextToken?: string | undefined;
@@ -658,12 +668,15 @@ export interface ListResourceServersRequest {
658
668
  */
659
669
  export interface ListResourceServersResponse {
660
670
  /**
661
- * <p>The resource servers.</p>
671
+ * <p>An array of resource servers and the details of their configuration. For each, the
672
+ * response includes names, identifiers, and custom scopes.</p>
662
673
  * @public
663
674
  */
664
675
  ResourceServers: ResourceServerType[] | undefined;
665
676
  /**
666
- * <p>A pagination token.</p>
677
+ * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
678
+ * you include a pagination token in your request, Amazon Cognito returns the next set of items in
679
+ * the list. By use of this token, you can paginate through the full list of items.</p>
667
680
  * @public
668
681
  */
669
682
  NextToken?: string | undefined;
@@ -694,12 +707,13 @@ export interface ListTagsForResourceResponse {
694
707
  */
695
708
  export interface ListUserImportJobsRequest {
696
709
  /**
697
- * <p>The ID of the user pool that the users are being imported into.</p>
710
+ * <p>The ID of the user pool where you want to list import jobs.</p>
698
711
  * @public
699
712
  */
700
713
  UserPoolId: string | undefined;
701
714
  /**
702
- * <p>The maximum number of import jobs you want the request to return.</p>
715
+ * <p>The maximum number of import jobs that you want Amazon Cognito to return in the
716
+ * response.</p>
703
717
  * @public
704
718
  */
705
719
  MaxResults: number | undefined;
@@ -720,7 +734,8 @@ export interface ListUserImportJobsRequest {
720
734
  */
721
735
  export interface ListUserImportJobsResponse {
722
736
  /**
723
- * <p>The user import jobs.</p>
737
+ * <p>An array of user import jobs from the requested user pool. For each, the response
738
+ * includes logging destination, status, and the Amazon S3 pre-signed URL for CSV upload.</p>
724
739
  * @public
725
740
  */
726
741
  UserImportJobs?: UserImportJobType[] | undefined;
@@ -743,21 +758,23 @@ export interface ListUserPoolClientsRequest {
743
758
  */
744
759
  UserPoolId: string | undefined;
745
760
  /**
746
- * <p>The maximum number of results you want the request to return when listing the user
747
- * pool clients.</p>
761
+ * <p>The maximum number of app clients that you want Amazon Cognito to return in the
762
+ * response.</p>
748
763
  * @public
749
764
  */
750
765
  MaxResults?: number | undefined;
751
766
  /**
752
- * <p>An identifier that was returned from the previous call to this operation, which can be
753
- * used to return the next set of items in the list.</p>
767
+ * <p>This API operation returns a limited number of results. The pagination token is
768
+ * an identifier that you can present in an additional API request with the same parameters. When
769
+ * you include the pagination token, Amazon Cognito returns the next set of items after the current list.
770
+ * Subsequent requests return a new pagination token. By use of this token, you can paginate
771
+ * through the full list of items.</p>
754
772
  * @public
755
773
  */
756
774
  NextToken?: string | undefined;
757
775
  }
758
776
  /**
759
777
  * <p>A short description of a user pool app client.</p>
760
- * <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserPoolClients.html">ListUserPoolClients</a>. </p>
761
778
  * @public
762
779
  */
763
780
  export interface UserPoolClientDescription {
@@ -783,13 +800,14 @@ export interface UserPoolClientDescription {
783
800
  */
784
801
  export interface ListUserPoolClientsResponse {
785
802
  /**
786
- * <p>The user pool clients in the response that lists user pool clients.</p>
803
+ * <p>An array of app clients and their details. Includes app client ID and name.</p>
787
804
  * @public
788
805
  */
789
806
  UserPoolClients?: UserPoolClientDescription[] | undefined;
790
807
  /**
791
- * <p>An identifier that was returned from the previous call to this operation, which can be
792
- * used to return the next set of items in the list.</p>
808
+ * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
809
+ * you include a pagination token in your request, Amazon Cognito returns the next set of items in
810
+ * the list. By use of this token, you can paginate through the full list of items.</p>
793
811
  * @public
794
812
  */
795
813
  NextToken?: string | undefined;
@@ -800,21 +818,22 @@ export interface ListUserPoolClientsResponse {
800
818
  */
801
819
  export interface ListUserPoolsRequest {
802
820
  /**
803
- * <p>An identifier that was returned from the previous call to this operation, which can be
804
- * used to return the next set of items in the list.</p>
821
+ * <p>This API operation returns a limited number of results. The pagination token is
822
+ * an identifier that you can present in an additional API request with the same parameters. When
823
+ * you include the pagination token, Amazon Cognito returns the next set of items after the current list.
824
+ * Subsequent requests return a new pagination token. By use of this token, you can paginate
825
+ * through the full list of items.</p>
805
826
  * @public
806
827
  */
807
828
  NextToken?: string | undefined;
808
829
  /**
809
- * <p>The maximum number of results you want the request to return when listing the user
810
- * pools.</p>
830
+ * <p>The maximum number of user pools that you want Amazon Cognito to return in the response.</p>
811
831
  * @public
812
832
  */
813
833
  MaxResults: number | undefined;
814
834
  }
815
835
  /**
816
836
  * <p>A short description of a user pool.</p>
817
- * <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserPools.html">ListUserPools</a>. </p>
818
837
  * @public
819
838
  */
820
839
  export interface UserPoolDescriptionType {
@@ -861,13 +880,14 @@ export interface UserPoolDescriptionType {
861
880
  */
862
881
  export interface ListUserPoolsResponse {
863
882
  /**
864
- * <p>The user pools from the response to list users.</p>
883
+ * <p>An array of user pools and their configuration details.</p>
865
884
  * @public
866
885
  */
867
886
  UserPools?: UserPoolDescriptionType[] | undefined;
868
887
  /**
869
- * <p>An identifier that was returned from the previous call to this operation, which can be
870
- * used to return the next set of items in the list.</p>
888
+ * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
889
+ * you include a pagination token in your request, Amazon Cognito returns the next set of items in
890
+ * the list. By use of this token, you can paginate through the full list of items.</p>
871
891
  * @public
872
892
  */
873
893
  NextToken?: string | undefined;
@@ -878,7 +898,7 @@ export interface ListUserPoolsResponse {
878
898
  */
879
899
  export interface ListUsersRequest {
880
900
  /**
881
- * <p>The ID of the user pool on which the search should be performed.</p>
901
+ * <p>The ID of the user pool where you want to display or search for users.</p>
882
902
  * @public
883
903
  */
884
904
  UserPoolId: string | undefined;
@@ -896,7 +916,7 @@ export interface ListUsersRequest {
896
916
  */
897
917
  AttributesToGet?: string[] | undefined;
898
918
  /**
899
- * <p>Maximum number of users to be returned.</p>
919
+ * <p>The maximum number of users that you want Amazon Cognito to return in the response.</p>
900
920
  * @public
901
921
  */
902
922
  Limit?: number | undefined;
@@ -1011,15 +1031,7 @@ export interface ListUsersRequest {
1011
1031
  */
1012
1032
  export interface ListUsersResponse {
1013
1033
  /**
1014
- * <p>A list of the user pool users, and their attributes, that match your query.</p>
1015
- * <note>
1016
- * <p>Amazon Cognito creates a profile in your user pool for each native user in your user pool,
1017
- * and each unique user ID from your third-party identity providers (IdPs). When you
1018
- * link users with the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a> API operation, the output of
1019
- * <code>ListUsers</code> displays both the IdP user and the native user that you
1020
- * linked. You can identify IdP users in the <code>Users</code> object of this API
1021
- * response by the IdP prefix that Amazon Cognito appends to <code>Username</code>.</p>
1022
- * </note>
1034
+ * <p>An array of user pool users who match your query, and their attributes.</p>
1023
1035
  * @public
1024
1036
  */
1025
1037
  Users?: UserType[] | undefined;
@@ -1036,23 +1048,27 @@ export interface ListUsersResponse {
1036
1048
  */
1037
1049
  export interface ListUsersInGroupRequest {
1038
1050
  /**
1039
- * <p>The ID of the user pool.</p>
1051
+ * <p>The ID of the user pool where you want to view the membership of the requested
1052
+ * group.</p>
1040
1053
  * @public
1041
1054
  */
1042
1055
  UserPoolId: string | undefined;
1043
1056
  /**
1044
- * <p>The name of the group.</p>
1057
+ * <p>The name of the group that you want to query for user membership.</p>
1045
1058
  * @public
1046
1059
  */
1047
1060
  GroupName: string | undefined;
1048
1061
  /**
1049
- * <p>The maximum number of users that you want to retrieve before pagination.</p>
1062
+ * <p>The maximum number of groups that you want Amazon Cognito to return in the response.</p>
1050
1063
  * @public
1051
1064
  */
1052
1065
  Limit?: number | undefined;
1053
1066
  /**
1054
- * <p>An identifier that was returned from the previous call to this operation, which can be
1055
- * used to return the next set of items in the list.</p>
1067
+ * <p>This API operation returns a limited number of results. The pagination token is
1068
+ * an identifier that you can present in an additional API request with the same parameters. When
1069
+ * you include the pagination token, Amazon Cognito returns the next set of items after the current list.
1070
+ * Subsequent requests return a new pagination token. By use of this token, you can paginate
1071
+ * through the full list of items.</p>
1056
1072
  * @public
1057
1073
  */
1058
1074
  NextToken?: string | undefined;
@@ -1062,13 +1078,14 @@ export interface ListUsersInGroupRequest {
1062
1078
  */
1063
1079
  export interface ListUsersInGroupResponse {
1064
1080
  /**
1065
- * <p>A list of users in the group, and their attributes.</p>
1081
+ * <p>An array of users who are members in the group, and their attributes.</p>
1066
1082
  * @public
1067
1083
  */
1068
1084
  Users?: UserType[] | undefined;
1069
1085
  /**
1070
- * <p>An identifier that you can use in a later request to return the next set of items in
1071
- * the list.</p>
1086
+ * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
1087
+ * you include a pagination token in your request, Amazon Cognito returns the next set of items in
1088
+ * the list. By use of this token, you can paginate through the full list of items.</p>
1072
1089
  * @public
1073
1090
  */
1074
1091
  NextToken?: string | undefined;
@@ -1078,14 +1095,17 @@ export interface ListUsersInGroupResponse {
1078
1095
  */
1079
1096
  export interface ListWebAuthnCredentialsRequest {
1080
1097
  /**
1081
- * <p>A valid access token that Amazon Cognito issued to the user whose registered passkeys you want
1082
- * to list.</p>
1098
+ * <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
1099
+ * <code>aws.cognito.signin.user.admin</code>.</p>
1083
1100
  * @public
1084
1101
  */
1085
1102
  AccessToken: string | undefined;
1086
1103
  /**
1087
- * <p>An identifier that was returned from the previous call to this operation, which can be
1088
- * used to return the next set of items in the list.</p>
1104
+ * <p>This API operation returns a limited number of results. The pagination token is
1105
+ * an identifier that you can present in an additional API request with the same parameters. When
1106
+ * you include the pagination token, Amazon Cognito returns the next set of items after the current list.
1107
+ * Subsequent requests return a new pagination token. By use of this token, you can paginate
1108
+ * through the full list of items.</p>
1089
1109
  * @public
1090
1110
  */
1091
1111
  NextToken?: string | undefined;
@@ -1099,7 +1119,6 @@ export interface ListWebAuthnCredentialsRequest {
1099
1119
  /**
1100
1120
  * <p>The details of a passkey, or webauthN, biometric or security-key authentication factor
1101
1121
  * for a user.</p>
1102
- * <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListWebAuthnCredentials.html">ListWebAuthnCredentials</a>.</p>
1103
1122
  * @public
1104
1123
  */
1105
1124
  export interface WebAuthnCredentialDescription {
@@ -1148,8 +1167,9 @@ export interface ListWebAuthnCredentialsResponse {
1148
1167
  */
1149
1168
  Credentials: WebAuthnCredentialDescription[] | undefined;
1150
1169
  /**
1151
- * <p>An identifier that you can use in a later request to return the next set of items in
1152
- * the list.</p>
1170
+ * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
1171
+ * you include a pagination token in your request, Amazon Cognito returns the next set of items in
1172
+ * the list. By use of this token, you can paginate through the full list of items.</p>
1153
1173
  * @public
1154
1174
  */
1155
1175
  NextToken?: string | undefined;
@@ -1160,7 +1180,7 @@ export interface ListWebAuthnCredentialsResponse {
1160
1180
  */
1161
1181
  export interface ResendConfirmationCodeRequest {
1162
1182
  /**
1163
- * <p>The ID of the client associated with the user pool.</p>
1183
+ * <p>The ID of the user pool app client where the user signed up.</p>
1164
1184
  * @public
1165
1185
  */
1166
1186
  ClientId: string | undefined;
@@ -1172,8 +1192,8 @@ export interface ResendConfirmationCodeRequest {
1172
1192
  */
1173
1193
  SecretHash?: string | undefined;
1174
1194
  /**
1175
- * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
1176
- * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
1195
+ * <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
1196
+ * protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
1177
1197
  * when it makes API requests.</p>
1178
1198
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
1179
1199
  * applications</a>.</p>
@@ -1181,7 +1201,7 @@ export interface ResendConfirmationCodeRequest {
1181
1201
  */
1182
1202
  UserContextData?: UserContextDataType | undefined;
1183
1203
  /**
1184
- * <p>The username of the user that you want to query or modify. The value of this parameter
1204
+ * <p>The name of the user that you want to query or modify. The value of this parameter
1185
1205
  * is typically your user's username, but it can be any of their alias attributes. If
1186
1206
  * <code>username</code> isn't an alias attribute in your user pool, this value
1187
1207
  * must be the <code>sub</code> of a local user or the username of a user from a
@@ -1190,8 +1210,9 @@ export interface ResendConfirmationCodeRequest {
1190
1210
  */
1191
1211
  Username: string | undefined;
1192
1212
  /**
1193
- * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
1194
- * <code>ResendConfirmationCode</code> calls.</p>
1213
+ * <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
1214
+ * user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
1215
+ * email address, or phone number.</p>
1195
1216
  * @public
1196
1217
  */
1197
1218
  AnalyticsMetadata?: AnalyticsMetadataType | undefined;
@@ -1207,7 +1228,7 @@ export interface ResendConfirmationCodeRequest {
1207
1228
  * function code in Lambda, you can process the <code>clientMetadata</code> value to enhance
1208
1229
  * your workflow for your specific needs.</p>
1209
1230
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
1210
- * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
1231
+ * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
1211
1232
  * <note>
1212
1233
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
1213
1234
  * following:</p>
@@ -1238,8 +1259,8 @@ export interface ResendConfirmationCodeRequest {
1238
1259
  */
1239
1260
  export interface ResendConfirmationCodeResponse {
1240
1261
  /**
1241
- * <p>The code delivery details returned by the server in response to the request to resend
1242
- * the confirmation code.</p>
1262
+ * <p>Information about the phone number or email address that Amazon Cognito sent the confirmation
1263
+ * code to.</p>
1243
1264
  * @public
1244
1265
  */
1245
1266
  CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
@@ -1250,23 +1271,131 @@ export interface ResendConfirmationCodeResponse {
1250
1271
  */
1251
1272
  export interface RespondToAuthChallengeRequest {
1252
1273
  /**
1253
- * <p>The app client ID.</p>
1274
+ * <p>The ID of the app client where the user is signing in.</p>
1254
1275
  * @public
1255
1276
  */
1256
1277
  ClientId: string | undefined;
1257
1278
  /**
1258
- * <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
1259
- * <p>
1260
- * <code>ADMIN_NO_SRP_AUTH</code> isn't a valid value.</p>
1279
+ * <p>The name of the challenge that you are responding to.</p>
1280
+ * <note>
1281
+ * <p>You can't respond to an <code>ADMIN_NO_SRP_AUTH</code> challenge with this
1282
+ * operation.</p>
1283
+ * </note>
1284
+ * <p>Possible challenges include the following:</p>
1285
+ * <note>
1286
+ * <p>All of the following challenges require <code>USERNAME</code> and, when the app
1287
+ * client has a client secret, <code>SECRET_HASH</code> in the parameters.</p>
1288
+ * </note>
1289
+ * <ul>
1290
+ * <li>
1291
+ * <p>
1292
+ * <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
1293
+ * successful authentication with a WebAuthn authenticator, or passkey. Examples
1294
+ * of WebAuthn authenticators include biometric devices and security keys.</p>
1295
+ * </li>
1296
+ * <li>
1297
+ * <p>
1298
+ * <code>PASSWORD</code>: Respond with <code>USER_PASSWORD_AUTH</code>
1299
+ * parameters: <code>USERNAME</code> (required), <code>PASSWORD</code> (required),
1300
+ * <code>SECRET_HASH</code> (required if the app client is configured with a
1301
+ * client secret), <code>DEVICE_KEY</code>.</p>
1302
+ * </li>
1303
+ * <li>
1304
+ * <p>
1305
+ * <code>PASSWORD_SRP</code>: Respond with <code>USER_SRP_AUTH</code> parameters:
1306
+ * <code>USERNAME</code> (required), <code>SRP_A</code> (required),
1307
+ * <code>SECRET_HASH</code> (required if the app client is configured with a
1308
+ * client secret), <code>DEVICE_KEY</code>.</p>
1309
+ * </li>
1310
+ * <li>
1311
+ * <p>
1312
+ * <code>SELECT_CHALLENGE</code>: Respond to the challenge with
1313
+ * <code>USERNAME</code> and an <code>ANSWER</code> that matches one of the
1314
+ * challenge types in the <code>AvailableChallenges</code> response
1315
+ * parameter.</p>
1316
+ * </li>
1317
+ * <li>
1318
+ * <p>
1319
+ * <code>SMS_MFA</code>: Respond with an
1320
+ * <code>SMS_MFA_CODE</code> that your user pool delivered in an SMS message.</p>
1321
+ * </li>
1322
+ * <li>
1323
+ * <p>
1324
+ * <code>EMAIL_OTP</code>: Respond with an
1325
+ * <code>EMAIL_OTP_CODE</code> that your user pool delivered in an email
1326
+ * message.</p>
1327
+ * </li>
1328
+ * <li>
1329
+ * <p>
1330
+ * <code>PASSWORD_VERIFIER</code>: Respond with
1331
+ * <code>PASSWORD_CLAIM_SIGNATURE</code>,
1332
+ * <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
1333
+ * client-side SRP calculations.</p>
1334
+ * </li>
1335
+ * <li>
1336
+ * <p>
1337
+ * <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
1338
+ * flow determines that the user should pass another challenge before tokens are
1339
+ * issued. The parameters of the challenge are determined by your Lambda function.</p>
1340
+ * </li>
1341
+ * <li>
1342
+ * <p>
1343
+ * <code>DEVICE_SRP_AUTH</code>: Respond with the initial parameters of device SRP
1344
+ * authentication. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
1345
+ * </li>
1346
+ * <li>
1347
+ * <p>
1348
+ * <code>DEVICE_PASSWORD_VERIFIER</code>: Respond with
1349
+ * <code>PASSWORD_CLAIM_SIGNATURE</code>,
1350
+ * <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
1351
+ * client-side SRP calculations. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
1352
+ * </li>
1353
+ * <li>
1354
+ * <p>
1355
+ * <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
1356
+ * passwords after successful first login. Respond to this challenge with
1357
+ * <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in
1358
+ * the <code>requiredAttributes</code> parameter. You can also set values for
1359
+ * attributes that aren't required by your user pool and that your app client
1360
+ * can write.</p>
1361
+ * <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
1362
+ * When you create passwordless users, you must provide values for all required
1363
+ * attributes.</p>
1364
+ * <note>
1365
+ * <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
1366
+ * In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
1367
+ * <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
1368
+ * operation to modify the value of any additional attributes.</p>
1369
+ * </note>
1370
+ * </li>
1371
+ * <li>
1372
+ * <p>
1373
+ * <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
1374
+ * before they can sign in. The MFA types activated for the user pool will be
1375
+ * listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
1376
+ * <p>To set up time-based one-time password (TOTP) MFA, use the session returned
1377
+ * in this challenge from <code>InitiateAuth</code> or <code>AdminInitiateAuth</code>
1378
+ * as an input to <code>AssociateSoftwareToken</code>. Then, use the session returned
1379
+ * by <code>VerifySoftwareToken</code> as an input to
1380
+ * <code>RespondToAuthChallenge</code> or <code>AdminRespondToAuthChallenge</code>
1381
+ * with challenge name <code>MFA_SETUP</code> to complete sign-in.
1382
+ * </p>
1383
+ * <p>To set up SMS or email MFA, collect a <code>phone_number</code> or
1384
+ * <code>email</code> attribute for the user. Then restart the authentication
1385
+ * flow with an <code>InitiateAuth</code> or <code>AdminInitiateAuth</code> request.
1386
+ * </p>
1387
+ * </li>
1388
+ * </ul>
1261
1389
  * @public
1262
1390
  */
1263
1391
  ChallengeName: ChallengeNameType | undefined;
1264
1392
  /**
1265
- * <p>The session that should be passed both ways in challenge-response calls to the
1266
- * service. If <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call
1267
- * determines that the caller must pass another challenge, they return a session with other
1268
- * challenge parameters. This session should be passed as it is to the next
1269
- * <code>RespondToAuthChallenge</code> API call.</p>
1393
+ * <p>The session identifier that maintains the state of authentication requests and
1394
+ * challenge responses. If an <code>AdminInitiateAuth</code> or
1395
+ * <code>AdminRespondToAuthChallenge</code> API request results in a determination that
1396
+ * your application must pass another challenge, Amazon Cognito returns a session with other
1397
+ * challenge parameters. Send this session identifier, unmodified, to the next
1398
+ * <code>AdminRespondToAuthChallenge</code> request.</p>
1270
1399
  * @public
1271
1400
  */
1272
1401
  Session?: string | undefined;
@@ -1299,7 +1428,7 @@ export interface RespondToAuthChallengeRequest {
1299
1428
  * "USERNAME": "[username]",
1300
1429
  * "CREDENTIAL": "[AuthenticationResponseJSON]"\}</code>
1301
1430
  * </p>
1302
- * <p>See <a href="https://www.w3.org/TR/webauthn-3/#dictdef-authenticationresponsejson">
1431
+ * <p>See <a href="https://www.w3.org/TR/WebAuthn-3/#dictdef-authenticationresponsejson">
1303
1432
  * AuthenticationResponseJSON</a>.</p>
1304
1433
  * </li>
1305
1434
  * <li>
@@ -1398,8 +1527,9 @@ export interface RespondToAuthChallengeRequest {
1398
1527
  * required by your user pool.</p>
1399
1528
  * <note>
1400
1529
  * <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
1401
- * In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter,
1402
- * then use the <code>UpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p>
1530
+ * In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
1531
+ * <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
1532
+ * operation to modify the value of any additional attributes.</p>
1403
1533
  * </note>
1404
1534
  * </dd>
1405
1535
  * <dt>SOFTWARE_TOKEN_MFA</dt>
@@ -1449,14 +1579,15 @@ export interface RespondToAuthChallengeRequest {
1449
1579
  */
1450
1580
  ChallengeResponses?: Record<string, string> | undefined;
1451
1581
  /**
1452
- * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
1453
- * <code>RespondToAuthChallenge</code> calls.</p>
1582
+ * <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
1583
+ * user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
1584
+ * email address, or phone number.</p>
1454
1585
  * @public
1455
1586
  */
1456
1587
  AnalyticsMetadata?: AnalyticsMetadataType | undefined;
1457
1588
  /**
1458
- * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
1459
- * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
1589
+ * <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
1590
+ * protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
1460
1591
  * when it makes API requests.</p>
1461
1592
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
1462
1593
  * applications</a>.</p>
@@ -1479,7 +1610,7 @@ export interface RespondToAuthChallengeRequest {
1479
1610
  * <code>clientMetadata</code> value to enhance your workflow for your specific
1480
1611
  * needs.</p>
1481
1612
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
1482
- * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
1613
+ * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
1483
1614
  * <note>
1484
1615
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
1485
1616
  * following:</p>
@@ -1509,26 +1640,134 @@ export interface RespondToAuthChallengeRequest {
1509
1640
  */
1510
1641
  export interface RespondToAuthChallengeResponse {
1511
1642
  /**
1512
- * <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
1643
+ * <p>The name of the next challenge that you must respond to.</p>
1644
+ * <p>Possible challenges include the following:</p>
1645
+ * <note>
1646
+ * <p>All of the following challenges require <code>USERNAME</code> and, when the app
1647
+ * client has a client secret, <code>SECRET_HASH</code> in the parameters.</p>
1648
+ * </note>
1649
+ * <ul>
1650
+ * <li>
1651
+ * <p>
1652
+ * <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
1653
+ * successful authentication with a WebAuthn authenticator, or passkey. Examples
1654
+ * of WebAuthn authenticators include biometric devices and security keys.</p>
1655
+ * </li>
1656
+ * <li>
1657
+ * <p>
1658
+ * <code>PASSWORD</code>: Respond with <code>USER_PASSWORD_AUTH</code>
1659
+ * parameters: <code>USERNAME</code> (required), <code>PASSWORD</code> (required),
1660
+ * <code>SECRET_HASH</code> (required if the app client is configured with a
1661
+ * client secret), <code>DEVICE_KEY</code>.</p>
1662
+ * </li>
1663
+ * <li>
1664
+ * <p>
1665
+ * <code>PASSWORD_SRP</code>: Respond with <code>USER_SRP_AUTH</code> parameters:
1666
+ * <code>USERNAME</code> (required), <code>SRP_A</code> (required),
1667
+ * <code>SECRET_HASH</code> (required if the app client is configured with a
1668
+ * client secret), <code>DEVICE_KEY</code>.</p>
1669
+ * </li>
1670
+ * <li>
1671
+ * <p>
1672
+ * <code>SELECT_CHALLENGE</code>: Respond to the challenge with
1673
+ * <code>USERNAME</code> and an <code>ANSWER</code> that matches one of the
1674
+ * challenge types in the <code>AvailableChallenges</code> response
1675
+ * parameter.</p>
1676
+ * </li>
1677
+ * <li>
1678
+ * <p>
1679
+ * <code>SMS_MFA</code>: Respond with an
1680
+ * <code>SMS_MFA_CODE</code> that your user pool delivered in an SMS message.</p>
1681
+ * </li>
1682
+ * <li>
1683
+ * <p>
1684
+ * <code>EMAIL_OTP</code>: Respond with an
1685
+ * <code>EMAIL_OTP_CODE</code> that your user pool delivered in an email
1686
+ * message.</p>
1687
+ * </li>
1688
+ * <li>
1689
+ * <p>
1690
+ * <code>PASSWORD_VERIFIER</code>: Respond with
1691
+ * <code>PASSWORD_CLAIM_SIGNATURE</code>,
1692
+ * <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
1693
+ * client-side SRP calculations.</p>
1694
+ * </li>
1695
+ * <li>
1696
+ * <p>
1697
+ * <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
1698
+ * flow determines that the user should pass another challenge before tokens are
1699
+ * issued. The parameters of the challenge are determined by your Lambda function.</p>
1700
+ * </li>
1701
+ * <li>
1702
+ * <p>
1703
+ * <code>DEVICE_SRP_AUTH</code>: Respond with the initial parameters of device SRP
1704
+ * authentication. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
1705
+ * </li>
1706
+ * <li>
1707
+ * <p>
1708
+ * <code>DEVICE_PASSWORD_VERIFIER</code>: Respond with
1709
+ * <code>PASSWORD_CLAIM_SIGNATURE</code>,
1710
+ * <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
1711
+ * client-side SRP calculations. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
1712
+ * </li>
1713
+ * <li>
1714
+ * <p>
1715
+ * <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
1716
+ * passwords after successful first login. Respond to this challenge with
1717
+ * <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in
1718
+ * the <code>requiredAttributes</code> parameter. You can also set values for
1719
+ * attributes that aren't required by your user pool and that your app client
1720
+ * can write.</p>
1721
+ * <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
1722
+ * When you create passwordless users, you must provide values for all required
1723
+ * attributes.</p>
1724
+ * <note>
1725
+ * <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
1726
+ * In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
1727
+ * <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
1728
+ * operation to modify the value of any additional attributes.</p>
1729
+ * </note>
1730
+ * </li>
1731
+ * <li>
1732
+ * <p>
1733
+ * <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
1734
+ * before they can sign in. The MFA types activated for the user pool will be
1735
+ * listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
1736
+ * <p>To set up time-based one-time password (TOTP) MFA, use the session returned
1737
+ * in this challenge from <code>InitiateAuth</code> or <code>AdminInitiateAuth</code>
1738
+ * as an input to <code>AssociateSoftwareToken</code>. Then, use the session returned
1739
+ * by <code>VerifySoftwareToken</code> as an input to
1740
+ * <code>RespondToAuthChallenge</code> or <code>AdminRespondToAuthChallenge</code>
1741
+ * with challenge name <code>MFA_SETUP</code> to complete sign-in.
1742
+ * </p>
1743
+ * <p>To set up SMS or email MFA, collect a <code>phone_number</code> or
1744
+ * <code>email</code> attribute for the user. Then restart the authentication
1745
+ * flow with an <code>InitiateAuth</code> or <code>AdminInitiateAuth</code> request.
1746
+ * </p>
1747
+ * </li>
1748
+ * </ul>
1513
1749
  * @public
1514
1750
  */
1515
1751
  ChallengeName?: ChallengeNameType | undefined;
1516
1752
  /**
1517
- * <p>The session that should be passed both ways in challenge-response calls to the
1518
- * service. If the caller must pass another challenge, they return a session with other
1519
- * challenge parameters. This session should be passed as it is to the next
1520
- * <code>RespondToAuthChallenge</code> API call.</p>
1753
+ * <p>The session identifier that maintains the state of authentication requests and
1754
+ * challenge responses. If an <code>InitiateAuth</code> or
1755
+ * <code>RespondToAuthChallenge</code> API request results in a determination that your
1756
+ * application must pass another challenge, Amazon Cognito returns a session with other challenge
1757
+ * parameters. Send this session identifier, unmodified, to the next
1758
+ * <code>RespondToAuthChallenge</code> request.</p>
1521
1759
  * @public
1522
1760
  */
1523
1761
  Session?: string | undefined;
1524
1762
  /**
1525
- * <p>The challenge parameters. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
1763
+ * <p>The parameters that define your response to the next challenge.</p>
1526
1764
  * @public
1527
1765
  */
1528
1766
  ChallengeParameters?: Record<string, string> | undefined;
1529
1767
  /**
1530
- * <p>The result returned by the server in response to the request to respond to the
1531
- * authentication challenge.</p>
1768
+ * <p>The outcome of a successful authentication process. After your application has passed
1769
+ * all challenges, Amazon Cognito returns an <code>AuthenticationResult</code> with the JSON web
1770
+ * tokens (JWTs) that indicate successful sign-in.</p>
1532
1771
  * @public
1533
1772
  */
1534
1773
  AuthenticationResult?: AuthenticationResultType | undefined;
@@ -1543,13 +1782,12 @@ export interface RevokeTokenRequest {
1543
1782
  */
1544
1783
  Token: string | undefined;
1545
1784
  /**
1546
- * <p>The client ID for the token that you want to revoke.</p>
1785
+ * <p>The ID of the app client where the token that you want to revoke was issued.</p>
1547
1786
  * @public
1548
1787
  */
1549
1788
  ClientId: string | undefined;
1550
1789
  /**
1551
- * <p>The secret for the client ID. This is required only if the client ID has a
1552
- * secret.</p>
1790
+ * <p>The client secret of the requested app client, if the client has a secret.</p>
1553
1791
  * @public
1554
1792
  */
1555
1793
  ClientSecret?: string | undefined;
@@ -1617,8 +1855,7 @@ export interface SetLogDeliveryConfigurationRequest {
1617
1855
  */
1618
1856
  export interface SetLogDeliveryConfigurationResponse {
1619
1857
  /**
1620
- * <p>The detailed activity logging configuration that you applied to the requested user
1621
- * pool.</p>
1858
+ * <p>The logging configuration that you applied to the requested user pool.</p>
1622
1859
  * @public
1623
1860
  */
1624
1861
  LogDeliveryConfiguration?: LogDeliveryConfigurationType | undefined;
@@ -1628,32 +1865,41 @@ export interface SetLogDeliveryConfigurationResponse {
1628
1865
  */
1629
1866
  export interface SetRiskConfigurationRequest {
1630
1867
  /**
1631
- * <p>The user pool ID. </p>
1868
+ * <p>The ID of the user pool where you want to set a risk configuration. If you include
1869
+ * <code>UserPoolId</code> in your request, don't include <code>ClientId</code>.
1870
+ * When the client ID is null, the same risk configuration is applied to all the clients in
1871
+ * the userPool. When you include both <code>ClientId</code> and <code>UserPoolId</code>,
1872
+ * Amazon Cognito maps the configuration to the app client only.</p>
1632
1873
  * @public
1633
1874
  */
1634
1875
  UserPoolId: string | undefined;
1635
1876
  /**
1636
- * <p>The app client ID. If <code>ClientId</code> is null, then the risk configuration is
1637
- * mapped to <code>userPoolId</code>. When the client ID is null, the same risk
1638
- * configuration is applied to all the clients in the userPool.</p>
1639
- * <p>Otherwise, <code>ClientId</code> is mapped to the client. When the client ID isn't
1640
- * null, the user pool configuration is overridden and the risk configuration for the
1641
- * client is used instead.</p>
1877
+ * <p>The ID of the app client where you want to set a risk configuration. If
1878
+ * <code>ClientId</code> is null, then the risk configuration is mapped to
1879
+ * <code>UserPoolId</code>. When the client ID is null, the same risk configuration is
1880
+ * applied to all the clients in the userPool.</p>
1881
+ * <p>When you include a <code>ClientId</code> parameter, Amazon Cognito maps the configuration to
1882
+ * the app client. When you include both <code>ClientId</code> and <code>UserPoolId</code>,
1883
+ * Amazon Cognito maps the configuration to the app client only.</p>
1642
1884
  * @public
1643
1885
  */
1644
1886
  ClientId?: string | undefined;
1645
1887
  /**
1646
- * <p>The compromised credentials risk configuration.</p>
1888
+ * <p>The configuration of automated reactions to detected compromised credentials. Includes
1889
+ * settings for blocking future sign-in requests and for the types of password-submission
1890
+ * events you want to monitor.</p>
1647
1891
  * @public
1648
1892
  */
1649
1893
  CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType | undefined;
1650
1894
  /**
1651
- * <p>The account takeover risk configuration.</p>
1895
+ * <p>The settings for automated responses and notification templates for adaptive
1896
+ * authentication with threat protection.</p>
1652
1897
  * @public
1653
1898
  */
1654
1899
  AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType | undefined;
1655
1900
  /**
1656
- * <p>The configuration to override the risk decision.</p>
1901
+ * <p>A set of IP-address overrides to threat protection. You can set up IP-address
1902
+ * always-block and always-allow lists.</p>
1657
1903
  * @public
1658
1904
  */
1659
1905
  RiskExceptionConfiguration?: RiskExceptionConfigurationType | undefined;
@@ -1663,7 +1909,8 @@ export interface SetRiskConfigurationRequest {
1663
1909
  */
1664
1910
  export interface SetRiskConfigurationResponse {
1665
1911
  /**
1666
- * <p>The risk configuration.</p>
1912
+ * <p>The API response that contains the risk configuration that you set and the timestamp
1913
+ * of the most recent change.</p>
1667
1914
  * @public
1668
1915
  */
1669
1916
  RiskConfiguration: RiskConfigurationType | undefined;
@@ -1673,22 +1920,30 @@ export interface SetRiskConfigurationResponse {
1673
1920
  */
1674
1921
  export interface SetUICustomizationRequest {
1675
1922
  /**
1676
- * <p>The ID of the user pool.</p>
1923
+ * <p>The ID of the user pool where you want to apply branding to the classic hosted
1924
+ * UI.</p>
1677
1925
  * @public
1678
1926
  */
1679
1927
  UserPoolId: string | undefined;
1680
1928
  /**
1681
- * <p>The client ID for the client app.</p>
1929
+ * <p>The ID of the app client that you want to customize. To apply a default style to all
1930
+ * app clients not configured with client-level branding, set this parameter value to
1931
+ * <code>ALL</code>.</p>
1682
1932
  * @public
1683
1933
  */
1684
1934
  ClientId?: string | undefined;
1685
1935
  /**
1686
- * <p>The CSS values in the UI customization.</p>
1936
+ * <p>A plaintext CSS file that contains the custom fields that you want to apply to your
1937
+ * user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to
1938
+ * your user pool <i>App clients</i> tab, select <i>Login
1939
+ * pages</i>, edit <i>Hosted UI (classic) style</i>, and select
1940
+ * the link to <code>CSS template.css</code>.</p>
1687
1941
  * @public
1688
1942
  */
1689
1943
  CSS?: string | undefined;
1690
1944
  /**
1691
- * <p>The uploaded logo image for the UI customization.</p>
1945
+ * <p>The image that you want to set as your login in the classic hosted UI, as a
1946
+ * Base64-formatted binary object.</p>
1692
1947
  * @public
1693
1948
  */
1694
1949
  ImageFile?: Uint8Array | undefined;
@@ -1698,7 +1953,7 @@ export interface SetUICustomizationRequest {
1698
1953
  */
1699
1954
  export interface SetUICustomizationResponse {
1700
1955
  /**
1701
- * <p>The UI customization information.</p>
1956
+ * <p>Information about the hosted UI branding that you applied.</p>
1702
1957
  * @public
1703
1958
  */
1704
1959
  UICustomization: UICustomizationType | undefined;
@@ -1722,14 +1977,15 @@ export interface SetUserMFAPreferenceRequest {
1722
1977
  SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType | undefined;
1723
1978
  /**
1724
1979
  * <p>User preferences for email message MFA. Activates or deactivates email MFA and sets it
1725
- * as the preferred MFA method when multiple methods are available. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
1726
- * advanced security features</a> must be active in your user pool.</p>
1980
+ * as the preferred MFA method when multiple methods are available.
1981
+ * To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
1982
+ * Essentials tier</a> or higher.</p>
1727
1983
  * @public
1728
1984
  */
1729
1985
  EmailMfaSettings?: EmailMfaSettingsType | undefined;
1730
1986
  /**
1731
- * <p>A valid access token that Amazon Cognito issued to the user whose MFA preference you want to
1732
- * set.</p>
1987
+ * <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
1988
+ * <code>aws.cognito.signin.user.admin</code>.</p>
1733
1989
  * @public
1734
1990
  */
1735
1991
  AccessToken: string | undefined;
@@ -1761,36 +2017,28 @@ export interface SetUserPoolMfaConfigRequest {
1761
2017
  */
1762
2018
  SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
1763
2019
  /**
1764
- * <p>Configures user pool email messages for MFA. Sets the subject and body of the email
1765
- * message template for MFA messages. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
1766
- * advanced security features</a> must be active in your user pool.</p>
2020
+ * <p>Sets configuration for user pool email message MFA and sign-in with one-time passwords
2021
+ * (OTPs). Includes the subject and body of the email message template for sign-in and MFA
2022
+ * messages. To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
2023
+ * Essentials tier</a> or higher.</p>
1767
2024
  * @public
1768
2025
  */
1769
2026
  EmailMfaConfiguration?: EmailMfaConfigType | undefined;
1770
2027
  /**
1771
- * <p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who
1772
- * have set up an MFA factor can sign in. To learn more, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html">Adding Multi-Factor
1773
- * Authentication (MFA) to a user pool</a>. Valid values include:</p>
1774
- * <ul>
1775
- * <li>
1776
- * <p>
1777
- * <code>OFF</code> MFA won't be used for any users.</p>
1778
- * </li>
1779
- * <li>
1780
- * <p>
1781
- * <code>ON</code> MFA is required for all users to sign in.</p>
1782
- * </li>
1783
- * <li>
1784
- * <p>
1785
- * <code>OPTIONAL</code> MFA will be required only for individual users who have
1786
- * an MFA factor activated.</p>
1787
- * </li>
1788
- * </ul>
2028
+ * <p>Sets multi-factor authentication (MFA) to be on, off, or optional. When
2029
+ * <code>ON</code>, all users must set up MFA before they can sign in. When
2030
+ * <code>OPTIONAL</code>, your application must make a client-side determination of
2031
+ * whether a user wants to register an MFA device. For user pools with adaptive
2032
+ * authentication with threat protection, choose <code>OPTIONAL</code>.</p>
2033
+ * <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
2034
+ * doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
2035
+ * API responses and in managed login for users who have chosen and configured a preferred
2036
+ * MFA factor.</p>
1789
2037
  * @public
1790
2038
  */
1791
2039
  MfaConfiguration?: UserPoolMfaType | undefined;
1792
2040
  /**
1793
- * <p>The configuration of your user pool for passkey, or webauthN, authentication and
2041
+ * <p>The configuration of your user pool for passkey, or WebAuthn, authentication and
1794
2042
  * registration. You can set this configuration independent of the MFA configuration
1795
2043
  * options in this operation.</p>
1796
2044
  * @public
@@ -1802,8 +2050,9 @@ export interface SetUserPoolMfaConfigRequest {
1802
2050
  */
1803
2051
  export interface SetUserPoolMfaConfigResponse {
1804
2052
  /**
1805
- * <p>Shows user pool SMS message configuration for MFA. Includes the message template and
1806
- * the SMS message sending configuration for Amazon SNS.</p>
2053
+ * <p>Shows user pool SMS message configuration for MFA and sign-in with SMS-message OTPs.
2054
+ * Includes the message template and the SMS message sending configuration for
2055
+ * Amazon SNS.</p>
1807
2056
  * @public
1808
2057
  */
1809
2058
  SmsMfaConfiguration?: SmsMfaConfigType | undefined;
@@ -1814,35 +2063,30 @@ export interface SetUserPoolMfaConfigResponse {
1814
2063
  */
1815
2064
  SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
1816
2065
  /**
1817
- * <p>Shows user pool email message configuration for MFA. Includes the subject and body of
1818
- * the email message template for MFA messages. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
1819
- * advanced security features</a> must be active in your user pool.</p>
2066
+ * <p>Shows configuration for user pool email message MFA and sign-in with one-time
2067
+ * passwords (OTPs). Includes the subject and body of the email message template for
2068
+ * sign-in and MFA messages. To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
2069
+ * Essentials tier</a> or higher.</p>
1820
2070
  * @public
1821
2071
  */
1822
2072
  EmailMfaConfiguration?: EmailMfaConfigType | undefined;
1823
2073
  /**
1824
- * <p>The MFA configuration. Valid values include:</p>
1825
- * <ul>
1826
- * <li>
1827
- * <p>
1828
- * <code>OFF</code> MFA won't be used for any users.</p>
1829
- * </li>
1830
- * <li>
1831
- * <p>
1832
- * <code>ON</code> MFA is required for all users to sign in.</p>
1833
- * </li>
1834
- * <li>
1835
- * <p>
1836
- * <code>OPTIONAL</code> MFA will be required only for individual users who have
1837
- * an MFA factor enabled.</p>
1838
- * </li>
1839
- * </ul>
2074
+ * <p>Displays multi-factor authentication (MFA) as on, off, or optional. When
2075
+ * <code>ON</code>, all users must set up MFA before they can sign in. When
2076
+ * <code>OPTIONAL</code>, your application must make a client-side determination of
2077
+ * whether a user wants to register an MFA device. For user pools with adaptive
2078
+ * authentication with threat protection, choose <code>OPTIONAL</code>.</p>
2079
+ * <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
2080
+ * doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
2081
+ * API responses and in managed login for users who have chosen and configured a preferred
2082
+ * MFA factor.</p>
1840
2083
  * @public
1841
2084
  */
1842
2085
  MfaConfiguration?: UserPoolMfaType | undefined;
1843
2086
  /**
1844
- * <p>The configuration of your user pool for passkey, or webauthN, biometric and
1845
- * security-key devices.</p>
2087
+ * <p>The configuration of your user pool for passkey, or WebAuthn, sign-in with
2088
+ * authenticators like biometric and security-key devices. Includes relying-party
2089
+ * configuration and settings for user-verification requirements.</p>
1846
2090
  * @public
1847
2091
  */
1848
2092
  WebAuthnConfiguration?: WebAuthnConfigurationType | undefined;
@@ -1853,8 +2097,8 @@ export interface SetUserPoolMfaConfigResponse {
1853
2097
  */
1854
2098
  export interface SetUserSettingsRequest {
1855
2099
  /**
1856
- * <p>A valid access token that Amazon Cognito issued to the user whose user settings you want to
1857
- * configure.</p>
2100
+ * <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
2101
+ * <code>aws.cognito.signin.user.admin</code>.</p>
1858
2102
  * @public
1859
2103
  */
1860
2104
  AccessToken: string | undefined;
@@ -1877,7 +2121,7 @@ export interface SetUserSettingsResponse {
1877
2121
  */
1878
2122
  export interface SignUpRequest {
1879
2123
  /**
1880
- * <p>The ID of the client associated with the user pool.</p>
2124
+ * <p>The ID of the app client where the user wants to sign up.</p>
1881
2125
  * @public
1882
2126
  */
1883
2127
  ClientId: string | undefined;
@@ -1895,18 +2139,18 @@ export interface SignUpRequest {
1895
2139
  */
1896
2140
  Username: string | undefined;
1897
2141
  /**
1898
- * <p>The password of the user you want to register.</p>
2142
+ * <p>The user's proposed password. The password must comply with the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users-passwords.html">password requirements</a> of your user pool.</p>
1899
2143
  * <p>Users can sign up without a password when your user pool supports passwordless sign-in
1900
2144
  * with email or SMS OTPs. To create a user with no password, omit this parameter or submit
1901
2145
  * a blank value. You can only create a passwordless user when passwordless sign-in is
1902
- * available. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignInPolicyType.html">the SignInPolicyType</a> property of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>.</p>
2146
+ * available.</p>
1903
2147
  * @public
1904
2148
  */
1905
2149
  Password?: string | undefined;
1906
2150
  /**
1907
2151
  * <p>An array of name-value pairs representing user attributes.</p>
1908
- * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
1909
- * attribute name.</p>
2152
+ * <p>For custom attributes, include a <code>custom:</code> prefix in the attribute name,
2153
+ * for example <code>custom:department</code>.</p>
1910
2154
  * @public
1911
2155
  */
1912
2156
  UserAttributes?: AttributeType[] | undefined;
@@ -1915,23 +2159,22 @@ export interface SignUpRequest {
1915
2159
  * trigger. This set of key-value pairs are for custom validation of information that you
1916
2160
  * collect from your users but don't need to retain.</p>
1917
2161
  * <p>Your Lambda function can analyze this additional data and act on it. Your function
1918
- * might perform external API operations like logging user attributes and validation data
1919
- * to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns
1920
- * to Amazon Cognito, like automatically confirming the user if they sign up from within your
1921
- * network.</p>
2162
+ * can automatically confirm and verify select users or perform external API operations
2163
+ * like logging user attributes and validation data to Amazon CloudWatch Logs.</p>
1922
2164
  * <p>For more information about the pre sign-up Lambda trigger, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html">Pre sign-up Lambda trigger</a>.</p>
1923
2165
  * @public
1924
2166
  */
1925
2167
  ValidationData?: AttributeType[] | undefined;
1926
2168
  /**
1927
- * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
1928
- * <code>SignUp</code> calls.</p>
2169
+ * <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
2170
+ * user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
2171
+ * email address, or phone number.</p>
1929
2172
  * @public
1930
2173
  */
1931
2174
  AnalyticsMetadata?: AnalyticsMetadataType | undefined;
1932
2175
  /**
1933
- * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
1934
- * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
2176
+ * <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
2177
+ * protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
1935
2178
  * when it makes API requests.</p>
1936
2179
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
1937
2180
  * applications</a>.</p>
@@ -1951,7 +2194,7 @@ export interface SignUpRequest {
1951
2194
  * function code in Lambda, you can process the <code>clientMetadata</code> value to enhance
1952
2195
  * your workflow for your specific needs.</p>
1953
2196
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
1954
- * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2197
+ * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
1955
2198
  * <note>
1956
2199
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
1957
2200
  * following:</p>
@@ -1981,20 +2224,22 @@ export interface SignUpRequest {
1981
2224
  */
1982
2225
  export interface SignUpResponse {
1983
2226
  /**
1984
- * <p>A response from the server indicating that a user registration has been
1985
- * confirmed.</p>
2227
+ * <p>Indicates whether the user was automatically confirmed. You can auto-confirm users
2228
+ * with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html">pre sign-up Lambda trigger</a>.</p>
1986
2229
  * @public
1987
2230
  */
1988
2231
  UserConfirmed: boolean | undefined;
1989
2232
  /**
1990
- * <p>The code delivery details returned by the server response to the user registration
1991
- * request.</p>
2233
+ * <p>In user pools that automatically verify and confirm new users, Amazon Cognito sends users a
2234
+ * message with a code or link that confirms ownership of the phone number or email address
2235
+ * that they entered. The <code>CodeDeliveryDetails</code> object is information about the
2236
+ * delivery destination for that link or code.</p>
1992
2237
  * @public
1993
2238
  */
1994
2239
  CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
1995
2240
  /**
1996
- * <p>The 128-bit ID of the authenticated user. This isn't the same as
1997
- * <code>username</code>.</p>
2241
+ * <p>The unique identifier of the new user, for example
2242
+ * <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
1998
2243
  * @public
1999
2244
  */
2000
2245
  UserSub: string | undefined;
@@ -2012,12 +2257,12 @@ export interface SignUpResponse {
2012
2257
  */
2013
2258
  export interface StartUserImportJobRequest {
2014
2259
  /**
2015
- * <p>The ID of the user pool that the users are being imported into.</p>
2260
+ * <p>The ID of the user pool that you want to start importing users into.</p>
2016
2261
  * @public
2017
2262
  */
2018
2263
  UserPoolId: string | undefined;
2019
2264
  /**
2020
- * <p>The job ID for the user import job.</p>
2265
+ * <p>The ID of a user import job that you previously created.</p>
2021
2266
  * @public
2022
2267
  */
2023
2268
  JobId: string | undefined;
@@ -2029,7 +2274,8 @@ export interface StartUserImportJobRequest {
2029
2274
  */
2030
2275
  export interface StartUserImportJobResponse {
2031
2276
  /**
2032
- * <p>The job object that represents the user import job.</p>
2277
+ * <p>The details of the user import job. Includes logging destination, status, and the Amazon S3
2278
+ * pre-signed URL for CSV upload.</p>
2033
2279
  * @public
2034
2280
  */
2035
2281
  UserImportJob?: UserImportJobType | undefined;
@@ -2039,8 +2285,8 @@ export interface StartUserImportJobResponse {
2039
2285
  */
2040
2286
  export interface StartWebAuthnRegistrationRequest {
2041
2287
  /**
2042
- * <p>A valid access token that Amazon Cognito issued to the user whose passkey metadata you want to
2043
- * generate.</p>
2288
+ * <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
2289
+ * <code>aws.cognito.signin.user.admin</code>.</p>
2044
2290
  * @public
2045
2291
  */
2046
2292
  AccessToken: string | undefined;
@@ -2075,12 +2321,12 @@ export declare class WebAuthnConfigurationMissingException extends __BaseExcepti
2075
2321
  */
2076
2322
  export interface StopUserImportJobRequest {
2077
2323
  /**
2078
- * <p>The ID of the user pool that the users are being imported into.</p>
2324
+ * <p>The ID of the user pool that you want to stop.</p>
2079
2325
  * @public
2080
2326
  */
2081
2327
  UserPoolId: string | undefined;
2082
2328
  /**
2083
- * <p>The job ID for the user import job.</p>
2329
+ * <p>The ID of a running user import job.</p>
2084
2330
  * @public
2085
2331
  */
2086
2332
  JobId: string | undefined;
@@ -2092,7 +2338,8 @@ export interface StopUserImportJobRequest {
2092
2338
  */
2093
2339
  export interface StopUserImportJobResponse {
2094
2340
  /**
2095
- * <p>The job object that represents the user import job.</p>
2341
+ * <p>The details of the user import job. Includes logging destination, status, and the Amazon S3
2342
+ * pre-signed URL for CSV upload.</p>
2096
2343
  * @public
2097
2344
  */
2098
2345
  UserImportJob?: UserImportJobType | undefined;
@@ -2107,7 +2354,7 @@ export interface TagResourceRequest {
2107
2354
  */
2108
2355
  ResourceArn: string | undefined;
2109
2356
  /**
2110
- * <p>The tags to assign to the user pool.</p>
2357
+ * <p>An array of tag keys and values that you want to assign to the user pool.</p>
2111
2358
  * @public
2112
2359
  */
2113
2360
  Tags: Record<string, string> | undefined;
@@ -2127,7 +2374,7 @@ export interface UntagResourceRequest {
2127
2374
  */
2128
2375
  ResourceArn: string | undefined;
2129
2376
  /**
2130
- * <p>The keys of the tags to remove from the user pool.</p>
2377
+ * <p>An array of tag keys that you want to remove from the user pool.</p>
2131
2378
  * @public
2132
2379
  */
2133
2380
  TagKeys: string[] | undefined;
@@ -2142,12 +2389,12 @@ export interface UntagResourceResponse {
2142
2389
  */
2143
2390
  export interface UpdateAuthEventFeedbackRequest {
2144
2391
  /**
2145
- * <p>The user pool ID.</p>
2392
+ * <p>The ID of the user pool where you want to update auth event feedback.</p>
2146
2393
  * @public
2147
2394
  */
2148
2395
  UserPoolId: string | undefined;
2149
2396
  /**
2150
- * <p>The username of the user that you want to query or modify. The value of this parameter
2397
+ * <p>The name of the user that you want to query or modify. The value of this parameter
2151
2398
  * is typically your user's username, but it can be any of their alias attributes. If
2152
2399
  * <code>username</code> isn't an alias attribute in your user pool, this value
2153
2400
  * must be the <code>sub</code> of a local user or the username of a user from a
@@ -2156,17 +2403,18 @@ export interface UpdateAuthEventFeedbackRequest {
2156
2403
  */
2157
2404
  Username: string | undefined;
2158
2405
  /**
2159
- * <p>The event ID.</p>
2406
+ * <p>The ID of the authentication event that you want to submit feedback for.</p>
2160
2407
  * @public
2161
2408
  */
2162
2409
  EventId: string | undefined;
2163
2410
  /**
2164
- * <p>The feedback token.</p>
2411
+ * <p>The feedback token, an encrypted object generated by Amazon Cognito and passed to your user in
2412
+ * the notification email message from the event.</p>
2165
2413
  * @public
2166
2414
  */
2167
2415
  FeedbackToken: string | undefined;
2168
2416
  /**
2169
- * <p>The authentication event feedback value. When you provide a <code>FeedbackValue</code>
2417
+ * <p>Your feedback to the authentication event. When you provide a <code>FeedbackValue</code>
2170
2418
  * value of <code>valid</code>, you tell Amazon Cognito that you trust a user session where Amazon Cognito
2171
2419
  * has evaluated some level of risk. When you provide a <code>FeedbackValue</code> value of
2172
2420
  * <code>invalid</code>, you tell Amazon Cognito that you don't trust a user session, or you
@@ -2186,18 +2434,20 @@ export interface UpdateAuthEventFeedbackResponse {
2186
2434
  */
2187
2435
  export interface UpdateDeviceStatusRequest {
2188
2436
  /**
2189
- * <p>A valid access token that Amazon Cognito issued to the user whose device status you want to
2190
- * update.</p>
2437
+ * <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
2438
+ * <code>aws.cognito.signin.user.admin</code>.</p>
2191
2439
  * @public
2192
2440
  */
2193
2441
  AccessToken: string | undefined;
2194
2442
  /**
2195
- * <p>The device key.</p>
2443
+ * <p>The device key of the device you want to update, for example
2444
+ * <code>us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
2196
2445
  * @public
2197
2446
  */
2198
2447
  DeviceKey: string | undefined;
2199
2448
  /**
2200
- * <p>The status of whether a device is remembered.</p>
2449
+ * <p>To enable device authentication with the specified device, set to
2450
+ * <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p>
2201
2451
  * @public
2202
2452
  */
2203
2453
  DeviceRememberedStatus?: DeviceRememberedStatusType | undefined;
@@ -2213,30 +2463,43 @@ export interface UpdateDeviceStatusResponse {
2213
2463
  */
2214
2464
  export interface UpdateGroupRequest {
2215
2465
  /**
2216
- * <p>The name of the group.</p>
2466
+ * <p>The name of the group that you want to update.</p>
2217
2467
  * @public
2218
2468
  */
2219
2469
  GroupName: string | undefined;
2220
2470
  /**
2221
- * <p>The ID of the user pool.</p>
2471
+ * <p>The ID of the user pool that contains the group you want to update.</p>
2222
2472
  * @public
2223
2473
  */
2224
2474
  UserPoolId: string | undefined;
2225
2475
  /**
2226
- * <p>A string containing the new description of the group.</p>
2476
+ * <p>A new description of the existing group.</p>
2227
2477
  * @public
2228
2478
  */
2229
2479
  Description?: string | undefined;
2230
2480
  /**
2231
- * <p>The new role Amazon Resource Name (ARN) for the group. This is used for setting the
2232
- * <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims in the
2233
- * token.</p>
2481
+ * <p>The Amazon Resource Name (ARN) of an IAM role that you want to associate with the
2482
+ * group. The role assignment contributes to the <code>cognito:roles</code> and
2483
+ * <code>cognito:preferred_role</code> claims in group members' tokens.</p>
2234
2484
  * @public
2235
2485
  */
2236
2486
  RoleArn?: string | undefined;
2237
2487
  /**
2238
- * <p>The new precedence value for the group. For more information about this parameter, see
2239
- * <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html">CreateGroup</a>.</p>
2488
+ * <p>A non-negative integer value that specifies the precedence of this group relative to
2489
+ * the other groups that a user can belong to in the user pool. Zero is the highest
2490
+ * precedence value. Groups with lower <code>Precedence</code> values take precedence over
2491
+ * groups with higher or null <code>Precedence</code> values. If a user belongs to two or
2492
+ * more groups, it is the group with the lowest precedence value whose role ARN is given in
2493
+ * the user's tokens for the <code>cognito:roles</code> and
2494
+ * <code>cognito:preferred_role</code> claims.</p>
2495
+ * <p>Two groups can have the same <code>Precedence</code> value. If this happens, neither
2496
+ * group takes precedence over the other. If two groups with the same
2497
+ * <code>Precedence</code> have the same role ARN, that role is used in the
2498
+ * <code>cognito:preferred_role</code> claim in tokens for users in each group. If the
2499
+ * two groups have different role ARNs, the <code>cognito:preferred_role</code> claim isn't
2500
+ * set in users' tokens.</p>
2501
+ * <p>The default <code>Precedence</code> value is null. The maximum <code>Precedence</code>
2502
+ * value is <code>2^31-1</code>.</p>
2240
2503
  * @public
2241
2504
  */
2242
2505
  Precedence?: number | undefined;
@@ -2246,7 +2509,8 @@ export interface UpdateGroupRequest {
2246
2509
  */
2247
2510
  export interface UpdateGroupResponse {
2248
2511
  /**
2249
- * <p>The group object for the group.</p>
2512
+ * <p>Contains the updated details of the group, including precedence, IAM role, and
2513
+ * description.</p>
2250
2514
  * @public
2251
2515
  */
2252
2516
  Group?: GroupType | undefined;
@@ -2256,12 +2520,14 @@ export interface UpdateGroupResponse {
2256
2520
  */
2257
2521
  export interface UpdateIdentityProviderRequest {
2258
2522
  /**
2259
- * <p>The user pool ID.</p>
2523
+ * <p>The Id of the user pool where you want to update your IdP.</p>
2260
2524
  * @public
2261
2525
  */
2262
2526
  UserPoolId: string | undefined;
2263
2527
  /**
2264
- * <p>The IdP name.</p>
2528
+ * <p>The name of the IdP that you want to update. You can pass the identity provider name
2529
+ * in the <code>identity_provider</code> query parameter of requests to the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html">Authorize endpoint</a> to silently redirect to sign-in with the associated
2530
+ * IdP.</p>
2265
2531
  * @public
2266
2532
  */
2267
2533
  ProviderName: string | undefined;
@@ -2389,12 +2655,17 @@ export interface UpdateIdentityProviderRequest {
2389
2655
  */
2390
2656
  ProviderDetails?: Record<string, string> | undefined;
2391
2657
  /**
2392
- * <p>The IdP attribute mapping to be changed.</p>
2658
+ * <p>A mapping of IdP attributes to standard and custom user pool attributes. Specify a
2659
+ * user pool attribute as the key of the key-value pair, and the IdP attribute claim name
2660
+ * as the value.</p>
2393
2661
  * @public
2394
2662
  */
2395
2663
  AttributeMapping?: Record<string, string> | undefined;
2396
2664
  /**
2397
- * <p>A list of IdP identifiers.</p>
2665
+ * <p>An array of IdP identifiers, for example <code>"IdPIdentifiers": [ "MyIdP", "MyIdP2"
2666
+ * ]</code>. Identifiers are friendly names that you can pass in the
2667
+ * <code>idp_identifier</code> query parameter of requests to the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html">Authorize endpoint</a> to silently redirect to sign-in with the associated IdP.
2668
+ * Identifiers in a domain format also enable the use of <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html">email-address matching with SAML providers</a>. </p>
2398
2669
  * @public
2399
2670
  */
2400
2671
  IdpIdentifiers?: string[] | undefined;
@@ -2425,9 +2696,9 @@ export interface UpdateManagedLoginBrandingRequest {
2425
2696
  */
2426
2697
  ManagedLoginBrandingId?: string | undefined;
2427
2698
  /**
2428
- * <p>When true, applies the default branding style options. This option reverts to default
2429
- * style options that are managed by Amazon Cognito. You can modify them later in the branding
2430
- * designer.</p>
2699
+ * <p>When <code>true</code>, applies the default branding style options. This option
2700
+ * reverts to default style options that are managed by Amazon Cognito. You can modify them later in
2701
+ * the branding designer.</p>
2431
2702
  * <p>When you specify <code>true</code> for this option, you must also omit values for
2432
2703
  * <code>Settings</code> and <code>Assets</code> in the request.</p>
2433
2704
  * @public
@@ -2462,7 +2733,8 @@ export interface UpdateManagedLoginBrandingResponse {
2462
2733
  */
2463
2734
  export interface UpdateResourceServerRequest {
2464
2735
  /**
2465
- * <p>The ID of the user pool.</p>
2736
+ * <p>The ID of the user pool that contains the resource server that you want to
2737
+ * update.</p>
2466
2738
  * @public
2467
2739
  */
2468
2740
  UserPoolId: string | undefined;
@@ -2477,12 +2749,13 @@ export interface UpdateResourceServerRequest {
2477
2749
  */
2478
2750
  Identifier: string | undefined;
2479
2751
  /**
2480
- * <p>The name of the resource server.</p>
2752
+ * <p>The updated name of the resource server.</p>
2481
2753
  * @public
2482
2754
  */
2483
2755
  Name: string | undefined;
2484
2756
  /**
2485
- * <p>The scope values to be set for the resource server.</p>
2757
+ * <p>An array of updated custom scope names and descriptions that you want to associate
2758
+ * with your resource server.</p>
2486
2759
  * @public
2487
2760
  */
2488
2761
  Scopes?: ResourceServerScopeType[] | undefined;
@@ -2492,7 +2765,7 @@ export interface UpdateResourceServerRequest {
2492
2765
  */
2493
2766
  export interface UpdateResourceServerResponse {
2494
2767
  /**
2495
- * <p>The resource server.</p>
2768
+ * <p>The updated details of the requested resource server.</p>
2496
2769
  * @public
2497
2770
  */
2498
2771
  ResourceServer: ResourceServerType | undefined;
@@ -2504,8 +2777,8 @@ export interface UpdateResourceServerResponse {
2504
2777
  export interface UpdateUserAttributesRequest {
2505
2778
  /**
2506
2779
  * <p>An array of name-value pairs representing user attributes.</p>
2507
- * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
2508
- * attribute name.</p>
2780
+ * <p>For custom attributes, you must add a <code>custom:</code> prefix to the attribute
2781
+ * name.</p>
2509
2782
  * <p>If you have set an attribute to require verification before Amazon Cognito updates its value,
2510
2783
  * this request doesn’t immediately update the value of that attribute. After your user
2511
2784
  * receives and responds to a verification message to verify the new value, Amazon Cognito updates
@@ -2515,8 +2788,8 @@ export interface UpdateUserAttributesRequest {
2515
2788
  */
2516
2789
  UserAttributes: AttributeType[] | undefined;
2517
2790
  /**
2518
- * <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to
2519
- * update.</p>
2791
+ * <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
2792
+ * <code>aws.cognito.signin.user.admin</code>.</p>
2520
2793
  * @public
2521
2794
  */
2522
2795
  AccessToken: string | undefined;
@@ -2532,7 +2805,7 @@ export interface UpdateUserAttributesRequest {
2532
2805
  * in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow
2533
2806
  * for your specific needs.</p>
2534
2807
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
2535
- * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2808
+ * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2536
2809
  * <note>
2537
2810
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
2538
2811
  * following:</p>
@@ -2563,8 +2836,13 @@ export interface UpdateUserAttributesRequest {
2563
2836
  */
2564
2837
  export interface UpdateUserAttributesResponse {
2565
2838
  /**
2566
- * <p>The code delivery details list from the server for the request to update user
2567
- * attributes.</p>
2839
+ * <p>When the attribute-update request includes an email address or phone number attribute,
2840
+ * Amazon Cognito sends a message to users with a code that confirms ownership of the new value that
2841
+ * they entered. The <code>CodeDeliveryDetails</code> object is information about the
2842
+ * delivery destination for that link or code. This behavior happens in user pools
2843
+ * configured to automatically verify changes to those attributes. For more information,
2844
+ * see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#verifying-when-users-change-their-email-or-phone-number">Verifying when users change their email or phone
2845
+ * number</a>.</p>
2568
2846
  * @public
2569
2847
  */
2570
2848
  CodeDeliveryDetailsList?: CodeDeliveryDetailsType[] | undefined;
@@ -2580,7 +2858,9 @@ export interface UpdateUserPoolRequest {
2580
2858
  */
2581
2859
  UserPoolId: string | undefined;
2582
2860
  /**
2583
- * <p>A container with the policies you want to update in a user pool.</p>
2861
+ * <p>The password policy and sign-in policy in the user pool. The password policy sets
2862
+ * options like password complexity requirements and password history. The sign-in policy
2863
+ * sets the options available to applications in <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a>.</p>
2584
2864
  * @public
2585
2865
  */
2586
2866
  Policies?: UserPoolPolicyType | undefined;
@@ -2596,38 +2876,48 @@ export interface UpdateUserPoolRequest {
2596
2876
  */
2597
2877
  DeletionProtection?: DeletionProtectionType | undefined;
2598
2878
  /**
2599
- * <p>The Lambda configuration information from the request to update the user pool.</p>
2879
+ * <p>A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible
2880
+ * stages of authentication operations. Triggers can modify the outcome of the operations
2881
+ * that invoked them.</p>
2600
2882
  * @public
2601
2883
  */
2602
2884
  LambdaConfig?: LambdaConfigType | undefined;
2603
2885
  /**
2604
- * <p>The attributes that are automatically verified when Amazon Cognito requests to update user
2605
- * pools.</p>
2886
+ * <p>The attributes that you want your user pool to automatically verify. Possible values:
2887
+ * <b>email</b>, <b>phone_number</b>. For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves">Verifying contact information at sign-up</a>.</p>
2606
2888
  * @public
2607
2889
  */
2608
2890
  AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined;
2609
2891
  /**
2610
- * <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
2892
+ * <p>This parameter is no longer used.</p>
2611
2893
  * @public
2612
2894
  */
2613
2895
  SmsVerificationMessage?: string | undefined;
2614
2896
  /**
2615
- * <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
2897
+ * <p>This parameter is no longer used.</p>
2616
2898
  * @public
2617
2899
  */
2618
2900
  EmailVerificationMessage?: string | undefined;
2619
2901
  /**
2620
- * <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
2902
+ * <p>This parameter is no longer used.</p>
2621
2903
  * @public
2622
2904
  */
2623
2905
  EmailVerificationSubject?: string | undefined;
2624
2906
  /**
2625
- * <p>The template for verification messages.</p>
2907
+ * <p>The template for the verification message that your user pool delivers to users who
2908
+ * set an email address or phone number attribute.</p>
2909
+ * <p>Set the email message type that corresponds to your <code>DefaultEmailOption</code>
2910
+ * selection. For <code>CONFIRM_WITH_LINK</code>, specify an
2911
+ * <code>EmailMessageByLink</code> and leave <code>EmailMessage</code> blank. For
2912
+ * <code>CONFIRM_WITH_CODE</code>, specify an <code>EmailMessage</code> and leave
2913
+ * <code>EmailMessageByLink</code> blank. When you supply both parameters with either
2914
+ * choice, Amazon Cognito returns an error.</p>
2626
2915
  * @public
2627
2916
  */
2628
2917
  VerificationMessageTemplate?: VerificationMessageTemplateType | undefined;
2629
2918
  /**
2630
- * <p>The contents of the SMS authentication message.</p>
2919
+ * <p>The contents of the SMS message that your user pool sends to users in SMS
2920
+ * authentication.</p>
2631
2921
  * @public
2632
2922
  */
2633
2923
  SmsAuthenticationMessage?: string | undefined;
@@ -2640,35 +2930,27 @@ export interface UpdateUserPoolRequest {
2640
2930
  */
2641
2931
  UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType | undefined;
2642
2932
  /**
2643
- * <p>Possible values include:</p>
2644
- * <ul>
2645
- * <li>
2646
- * <p>
2647
- * <code>OFF</code> - MFA tokens aren't required and can't be specified during user
2648
- * registration.</p>
2649
- * </li>
2650
- * <li>
2651
- * <p>
2652
- * <code>ON</code> - MFA tokens are required for all user registrations. You can
2653
- * only specify ON when you're initially creating a user pool. You can use the
2654
- * <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> API operation to turn MFA "ON" for existing
2655
- * user pools. </p>
2656
- * </li>
2657
- * <li>
2658
- * <p>
2659
- * <code>OPTIONAL</code> - Users have the option when registering to create an MFA
2660
- * token.</p>
2661
- * </li>
2662
- * </ul>
2933
+ * <p>Sets multi-factor authentication (MFA) to be on, off, or optional. When
2934
+ * <code>ON</code>, all users must set up MFA before they can sign in. When
2935
+ * <code>OPTIONAL</code>, your application must make a client-side determination of
2936
+ * whether a user wants to register an MFA device. For user pools with adaptive
2937
+ * authentication with threat protection, choose <code>OPTIONAL</code>.</p>
2938
+ * <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
2939
+ * doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
2940
+ * API responses and in managed login for users who have chosen and configured a preferred
2941
+ * MFA factor.</p>
2663
2942
  * @public
2664
2943
  */
2665
2944
  MfaConfiguration?: UserPoolMfaType | undefined;
2666
2945
  /**
2667
- * <p>The device-remembering configuration for a user pool. A null value indicates that you
2668
- * have deactivated device remembering in your user pool.</p>
2946
+ * <p>The device-remembering configuration for a user pool. Device remembering or device
2947
+ * tracking is a "Remember me on this device" option for user pools that perform
2948
+ * authentication with the device key of a trusted device in the back end, instead of a
2949
+ * user-provided MFA code. 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>. A null value indicates that
2950
+ * you have deactivated device remembering in your user pool.</p>
2669
2951
  * <note>
2670
2952
  * <p>When you provide a value for any <code>DeviceConfiguration</code> field, you
2671
- * activate the Amazon Cognito device-remembering feature.</p>
2953
+ * activate the Amazon Cognito device-remembering feature. For more infor</p>
2672
2954
  * </note>
2673
2955
  * @public
2674
2956
  */
@@ -2681,10 +2963,10 @@ export interface UpdateUserPoolRequest {
2681
2963
  */
2682
2964
  EmailConfiguration?: EmailConfigurationType | undefined;
2683
2965
  /**
2684
- * <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
2685
- * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
2686
- * with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management
2687
- * (IAM) role in your Amazon Web Services account.</p>
2966
+ * <p>The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message
2967
+ * with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the
2968
+ * Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account. For
2969
+ * more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html">SMS message settings</a>.</p>
2688
2970
  * @public
2689
2971
  */
2690
2972
  SmsConfiguration?: SmsConfigurationType | undefined;
@@ -2696,16 +2978,19 @@ export interface UpdateUserPoolRequest {
2696
2978
  */
2697
2979
  UserPoolTags?: Record<string, string> | undefined;
2698
2980
  /**
2699
- * <p>The configuration for <code>AdminCreateUser</code> requests.</p>
2981
+ * <p>The configuration for administrative creation of users. Includes the template for the
2982
+ * invitation message for new users, the duration of temporary passwords, and permitting
2983
+ * self-service sign-up.</p>
2700
2984
  * @public
2701
2985
  */
2702
2986
  AdminCreateUserConfig?: AdminCreateUserConfigType | undefined;
2703
2987
  /**
2704
- * <p>User pool add-ons. Contains settings for activation of advanced security features. To
2705
- * log user security information but take no action, set to <code>AUDIT</code>. To
2706
- * configure automatic security responses to risky traffic to your user pool, set to
2707
- * <code>ENFORCED</code>.</p>
2708
- * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">Adding advanced security to a user pool</a>.</p>
2988
+ * <p>Contains settings for activation of threat protection, including the operating
2989
+ * mode and additional authentication types. To log user security information but take
2990
+ * no action, set to <code>AUDIT</code>. To configure automatic security responses to
2991
+ * potentially unwanted traffic to your user pool, set to <code>ENFORCED</code>.</p>
2992
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">Adding advanced security to a user pool</a>. To activate this setting, your user pool must be on the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html">
2993
+ * Plus tier</a>.</p>
2709
2994
  * @public
2710
2995
  */
2711
2996
  UserPoolAddOns?: UserPoolAddOnsType | undefined;
@@ -2745,17 +3030,17 @@ export interface UpdateUserPoolResponse {
2745
3030
  */
2746
3031
  export interface UpdateUserPoolClientRequest {
2747
3032
  /**
2748
- * <p>The ID of the user pool where you want to update the user pool client.</p>
3033
+ * <p>The ID of the user pool where you want to update the app client.</p>
2749
3034
  * @public
2750
3035
  */
2751
3036
  UserPoolId: string | undefined;
2752
3037
  /**
2753
- * <p>The ID of the client associated with the user pool.</p>
3038
+ * <p>The ID of the app client that you want to update.</p>
2754
3039
  * @public
2755
3040
  */
2756
3041
  ClientId: string | undefined;
2757
3042
  /**
2758
- * <p>The client name from the update user pool client request.</p>
3043
+ * <p>A friendly name for the app client.</p>
2759
3044
  * @public
2760
3045
  */
2761
3046
  ClientName?: string | undefined;
@@ -2807,24 +3092,20 @@ export interface UpdateUserPoolClientRequest {
2807
3092
  */
2808
3093
  IdTokenValidity?: number | undefined;
2809
3094
  /**
2810
- * <p>The time units you use when you set the duration of ID, access, and refresh tokens.
2811
- * The default unit for RefreshToken is days, and the default for ID and access tokens is
2812
- * hours.</p>
3095
+ * <p>The units that validity times are represented in. The default unit for refresh tokens
3096
+ * is days, and the default for ID and access tokens are hours.</p>
2813
3097
  * @public
2814
3098
  */
2815
3099
  TokenValidityUnits?: TokenValidityUnitsType | undefined;
2816
3100
  /**
2817
3101
  * <p>The list of user attributes that you want your app client to have read access to.
2818
3102
  * After your user authenticates in your app, their access token authorizes them to read
2819
- * their own attribute value for any attribute in this list. An example of this kind of
2820
- * activity is when your user selects a link to view their profile information. Your app
2821
- * makes a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html">GetUser</a> API request to retrieve and display your user's profile
2822
- * data.</p>
3103
+ * their own attribute value for any attribute in this list.</p>
2823
3104
  * <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
2824
3105
  * app can read the values of <code>email_verified</code>,
2825
- * <code>phone_number_verified</code>, and the Standard attributes of your user pool.
3106
+ * <code>phone_number_verified</code>, and the standard attributes of your user pool.
2826
3107
  * When your user pool app client has read access to these default attributes,
2827
- * <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
3108
+ * <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
2828
3109
  * populates <code>ReadAttributes</code> in the API response if you have specified your own
2829
3110
  * custom set of read attributes.</p>
2830
3111
  * @public
@@ -2833,10 +3114,7 @@ export interface UpdateUserPoolClientRequest {
2833
3114
  /**
2834
3115
  * <p>The list of user attributes that you want your app client to have write access to.
2835
3116
  * After your user authenticates in your app, their access token authorizes them to set or
2836
- * modify their own attribute value for any attribute in this list. An example of this kind
2837
- * of activity is when you present your user with a form to update their profile
2838
- * information and they change their last name. Your app then makes an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html">UpdateUserAttributes</a> API request and sets <code>family_name</code> to the
2839
- * new value. </p>
3117
+ * modify their own attribute value for any attribute in this list.</p>
2840
3118
  * <p>When you don't specify the <code>WriteAttributes</code> for your app client, your
2841
3119
  * app can write the values of the Standard attributes of your user pool. When your user
2842
3120
  * pool has write access to these default attributes, <code>WriteAttributes</code>
@@ -2853,13 +3131,16 @@ export interface UpdateUserPoolClientRequest {
2853
3131
  */
2854
3132
  WriteAttributes?: string[] | undefined;
2855
3133
  /**
2856
- * <p>The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in
2857
- * your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and
2858
- * password, or a custom authentication process that you define with Lambda functions.</p>
3134
+ * <p>The <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html">authentication flows</a> that you want your user pool client to support. For each app
3135
+ * client in your user pool, you can sign in your users with any combination of one or more flows, including with
3136
+ * a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that
3137
+ * you define with Lambda functions.</p>
2859
3138
  * <note>
2860
- * <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your user client supports <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.</p>
3139
+ * <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your app client supports
3140
+ * <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.
3141
+ * </p>
2861
3142
  * </note>
2862
- * <p>Valid values include:</p>
3143
+ * <p>The values for authentication flow options include the following.</p>
2863
3144
  * <ul>
2864
3145
  * <li>
2865
3146
  * <p>
@@ -2872,6 +3153,8 @@ export interface UpdateUserPoolClientRequest {
2872
3153
  * without the flow <code>USER_SRP_AUTH</code> being active for the app
2873
3154
  * client. This flow doesn't include <code>CUSTOM_AUTH</code>.
2874
3155
  * </p>
3156
+ * <p>To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
3157
+ * Essentials tier</a> or higher.</p>
2875
3158
  * </li>
2876
3159
  * <li>
2877
3160
  * <p>
@@ -2911,26 +3194,33 @@ export interface UpdateUserPoolClientRequest {
2911
3194
  /**
2912
3195
  * <p>A list of provider names for the identity providers (IdPs) that are supported on this
2913
3196
  * client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>,
2914
- * <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>.
3197
+ * <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>.
2915
3198
  * You can also specify the names that you configured for the SAML and OIDC IdPs in your
2916
3199
  * user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
2917
- * <p>This setting applies to providers that you can access with <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">managed
2918
- * login</a>. The removal of <code>COGNITO</code>
2919
- * from this list doesn't prevent authentication operations for local users with the
2920
- * user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to
2921
- * block access with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html">WAF rule</a>.</p>
3200
+ * <p>This parameter sets the IdPs that <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">managed
3201
+ * login</a> will display on the login page for your app client. The removal of
3202
+ * <code>COGNITO</code> from this list doesn't prevent authentication operations
3203
+ * for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent
3204
+ * SDK-based authentication is to block access with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html">WAF rule</a>.
3205
+ * </p>
2922
3206
  * @public
2923
3207
  */
2924
3208
  SupportedIdentityProviders?: string[] | undefined;
2925
3209
  /**
2926
- * <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
2927
- * <p>A redirect URI must:</p>
3210
+ * <p>A list of allowed redirect, or callback, URLs for managed login authentication. These
3211
+ * URLs are the paths where you want to send your users' browsers after they complete
3212
+ * authentication with managed login or a third-party IdP. Typically, callback URLs are the
3213
+ * home of an application that uses OAuth or OIDC libraries to process authentication
3214
+ * outcomes.</p>
3215
+ * <p>A redirect URI must meet the following requirements:</p>
2928
3216
  * <ul>
2929
3217
  * <li>
2930
3218
  * <p>Be an absolute URI.</p>
2931
3219
  * </li>
2932
3220
  * <li>
2933
- * <p>Be registered with the authorization server.</p>
3221
+ * <p>Be registered with the authorization server. Amazon Cognito doesn't accept
3222
+ * authorization requests with <code>redirect_uri</code> values that aren't in
3223
+ * the list of <code>CallbackURLs</code> that you provide in this parameter.</p>
2934
3224
  * </li>
2935
3225
  * <li>
2936
3226
  * <p>Not include a fragment component.</p>
@@ -2945,34 +3235,27 @@ export interface UpdateUserPoolClientRequest {
2945
3235
  */
2946
3236
  CallbackURLs?: string[] | undefined;
2947
3237
  /**
2948
- * <p>A list of allowed logout URLs for the IdPs.</p>
3238
+ * <p>A list of allowed logout URLs for managed login authentication. When you pass
3239
+ * <code>logout_uri</code> and <code>client_id</code> parameters to
3240
+ * <code>/logout</code>, Amazon Cognito signs out your user and redirects them to the logout
3241
+ * URL. This parameter describes the URLs that you want to be the permitted targets of
3242
+ * <code>logout_uri</code>. A typical use of these URLs is when a user selects "Sign
3243
+ * out" and you redirect them to your public homepage. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html">Logout
3244
+ * endpoint</a>.</p>
2949
3245
  * @public
2950
3246
  */
2951
3247
  LogoutURLs?: string[] | undefined;
2952
3248
  /**
2953
- * <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>
2954
- * <p>A redirect URI must:</p>
2955
- * <ul>
2956
- * <li>
2957
- * <p>Be an absolute URI.</p>
2958
- * </li>
2959
- * <li>
2960
- * <p>Be registered with the authorization server.</p>
2961
- * </li>
2962
- * <li>
2963
- * <p>Not include a fragment component.</p>
2964
- * </li>
2965
- * </ul>
2966
- * <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 -
2967
- * Redirection Endpoint</a>.</p>
2968
- * <p>Amazon Cognito requires HTTPS over HTTP except for <code>http://localhost</code> for testing
2969
- * purposes only.</p>
2970
- * <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
3249
+ * <p>The default redirect URI. In app clients with one assigned IdP, replaces
3250
+ * <code>redirect_uri</code> in authentication requests. Must be in the
3251
+ * <code>CallbackURLs</code> list.</p>
2971
3252
  * @public
2972
3253
  */
2973
3254
  DefaultRedirectURI?: string | undefined;
2974
3255
  /**
2975
- * <p>The allowed OAuth flows.</p>
3256
+ * <p>The OAuth grant types that you want your app client to generate. To create an app
3257
+ * client that generates client credentials grants, you must add
3258
+ * <code>client_credentials</code> as the only allowed OAuth flow.</p>
2976
3259
  * <dl>
2977
3260
  * <dt>code</dt>
2978
3261
  * <dd>
@@ -2996,17 +3279,19 @@ export interface UpdateUserPoolClientRequest {
2996
3279
  */
2997
3280
  AllowedOAuthFlows?: OAuthFlowType[] | undefined;
2998
3281
  /**
2999
- * <p>The allowed OAuth scopes. Possible values provided by OAuth are <code>phone</code>,
3000
- * <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values
3001
- * provided by Amazon Web Services are <code>aws.cognito.signin.user.admin</code>. Custom scopes created
3002
- * in Resource Servers are also supported.</p>
3282
+ * <p>The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app
3283
+ * client to authorize access with. Scopes govern access control to user pool self-service
3284
+ * API operations, user data from the <code>userInfo</code> endpoint, and third-party APIs.
3285
+ * Scope values include <code>phone</code>, <code>email</code>, <code>openid</code>, and
3286
+ * <code>profile</code>. The <code>aws.cognito.signin.user.admin</code> scope
3287
+ * authorizes user self-service operations. Custom scopes with resource servers authorize
3288
+ * access to external APIs.</p>
3003
3289
  * @public
3004
3290
  */
3005
3291
  AllowedOAuthScopes?: string[] | undefined;
3006
3292
  /**
3007
- * <p>Set to <code>true</code> to use OAuth 2.0 features in your user pool app client.</p>
3008
- * <p>
3009
- * <code>AllowedOAuthFlowsUserPoolClient</code> must be <code>true</code> before you can configure
3293
+ * <p>Set to <code>true</code> to use OAuth 2.0 authorization server features in your app client.</p>
3294
+ * <p>This parameter must have a value of <code>true</code> before you can configure
3010
3295
  * the following features in your app client.</p>
3011
3296
  * <ul>
3012
3297
  * <li>
@@ -3026,63 +3311,52 @@ export interface UpdateUserPoolClientRequest {
3026
3311
  * <code>AllowedOAuthFlows</code>: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.</p>
3027
3312
  * </li>
3028
3313
  * </ul>
3029
- * <p>To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set
3314
+ * <p>To use authorization server features, configure one of these features in the Amazon Cognito console or set
3030
3315
  * <code>AllowedOAuthFlowsUserPoolClient</code> to <code>true</code> in a <code>CreateUserPoolClient</code> or
3031
3316
  * <code>UpdateUserPoolClient</code> API request. If you don't set a value for
3032
3317
  * <code>AllowedOAuthFlowsUserPoolClient</code> in a request with the CLI or SDKs, it defaults
3033
- * to <code>false</code>.</p>
3318
+ * to <code>false</code>. When <code>false</code>, only SDK-based API sign-in is permitted.</p>
3034
3319
  * @public
3035
3320
  */
3036
3321
  AllowedOAuthFlowsUserPoolClient?: boolean | undefined;
3037
3322
  /**
3038
- * <p>The Amazon Pinpoint analytics configuration necessary to collect metrics for this user
3039
- * pool.</p>
3040
- * <note>
3041
- * <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending
3042
- * events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user
3043
- * pools support sending events to Amazon Pinpoint projects within that same Region.</p>
3044
- * </note>
3323
+ * <p>The user pool analytics configuration for collecting metrics and sending them to your
3324
+ * Amazon Pinpoint campaign.</p>
3325
+ * <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools might not have access to
3326
+ * analytics or might be configurable with campaigns in the US East (N. Virginia) Region.
3327
+ * For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html">Using Amazon Pinpoint analytics</a>.</p>
3045
3328
  * @public
3046
3329
  */
3047
3330
  AnalyticsConfiguration?: AnalyticsConfigurationType | undefined;
3048
3331
  /**
3049
- * <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account
3332
+ * <p>When <code>ENABLED</code>, suppresses messages that might indicate a valid user exists
3333
+ * when someone attempts sign-in. This parameters sets your preference for the errors and
3334
+ * responses that you want Amazon Cognito APIs to return during authentication, account
3050
3335
  * confirmation, and password recovery when the user doesn't exist in the user pool. When
3051
3336
  * set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error
3052
3337
  * indicating either the username or password was incorrect. Account confirmation and
3053
3338
  * password recovery return a response indicating a code was sent to a simulated
3054
3339
  * destination. When set to <code>LEGACY</code>, those APIs return a
3055
- * <code>UserNotFoundException</code> exception if the user doesn't exist in the user
3340
+ * <code>UserNotFoundException</code> exception if the user doesn't exist in the user
3056
3341
  * pool.</p>
3057
- * <p>Valid values include:</p>
3058
- * <ul>
3059
- * <li>
3060
- * <p>
3061
- * <code>ENABLED</code> - This prevents user existence-related errors.</p>
3062
- * </li>
3063
- * <li>
3064
- * <p>
3065
- * <code>LEGACY</code> - This represents the early behavior of Amazon Cognito where user
3066
- * existence related errors aren't prevented.</p>
3067
- * </li>
3068
- * </ul>
3069
- * <p>Defaults to <code>LEGACY</code> when you don't provide a value.</p>
3342
+ * <p>Defaults to <code>LEGACY</code>.</p>
3070
3343
  * @public
3071
3344
  */
3072
3345
  PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | undefined;
3073
3346
  /**
3074
- * <p>Activates or deactivates token revocation. For more information about revoking tokens,
3075
- * see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
3347
+ * <p>Activates or deactivates <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/token-revocation.html">token
3348
+ * revocation</a> in the target app client.</p>
3076
3349
  * @public
3077
3350
  */
3078
3351
  EnableTokenRevocation?: boolean | undefined;
3079
3352
  /**
3080
- * <p>Activates the propagation of additional user context data. For more information about
3081
- * propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html"> Adding advanced security to a user pool</a>. If you don’t include this
3082
- * parameter, you can't send device fingerprint information, including source IP address,
3083
- * to Amazon Cognito advanced security. You can only activate
3084
- * <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a
3085
- * client secret.</p>
3353
+ * <p>When <code>true</code>, your application can include additional
3354
+ * <code>UserContextData</code> in authentication requests. This data includes the IP
3355
+ * address, and contributes to analysis by threat protection features. For more information
3356
+ * about propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint">Adding session data to API requests</a>. If you don’t include this parameter,
3357
+ * you can't send the source IP address to Amazon Cognito threat protection features. You can only
3358
+ * activate <code>EnablePropagateAdditionalUserContextData</code> in an app client that has
3359
+ * a client secret.</p>
3086
3360
  * @public
3087
3361
  */
3088
3362
  EnablePropagateAdditionalUserContextData?: boolean | undefined;
@@ -3100,8 +3374,7 @@ export interface UpdateUserPoolClientRequest {
3100
3374
  */
3101
3375
  export interface UpdateUserPoolClientResponse {
3102
3376
  /**
3103
- * <p>The user pool client value from the response from the server when you request to
3104
- * update the user pool client.</p>
3377
+ * <p>The updated details of your app client.</p>
3105
3378
  * @public
3106
3379
  */
3107
3380
  UserPoolClient?: UserPoolClientType | undefined;
@@ -3112,35 +3385,33 @@ export interface UpdateUserPoolClientResponse {
3112
3385
  */
3113
3386
  export interface UpdateUserPoolDomainRequest {
3114
3387
  /**
3115
- * <p>The domain name for the custom domain that hosts the sign-up and sign-in pages for
3116
- * your application. One example might be <code>auth.example.com</code>. </p>
3117
- * <p>This string can include only lowercase letters, numbers, and hyphens. Don't use a
3118
- * hyphen for the first or last character. Use periods to separate subdomain names.</p>
3388
+ * <p>The name of the domain that you want to update. For custom domains, this is the
3389
+ * fully-qualified domain name, for example <code>auth.example.com</code>. For prefix
3390
+ * domains, this is the prefix alone, such as <code>myprefix</code>.</p>
3119
3391
  * @public
3120
3392
  */
3121
3393
  Domain: string | undefined;
3122
3394
  /**
3123
- * <p>The ID of the user pool that is associated with the custom domain whose certificate
3124
- * you're updating.</p>
3395
+ * <p>The ID of the user pool that is associated with the domain you're updating.</p>
3125
3396
  * @public
3126
3397
  */
3127
3398
  UserPoolId: string | undefined;
3128
3399
  /**
3129
3400
  * <p>A version number that indicates the state of managed login for your domain. Version
3130
- * <code>1</code> is hosted UI (classic). Version <code>2</code> is the newer managed
3401
+ * <code>1</code> is hosted UI (classic). Version <code>2</code> is the newer managed
3131
3402
  * login with the branding designer. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">Managed login</a>.</p>
3132
3403
  * @public
3133
3404
  */
3134
3405
  ManagedLoginVersion?: number | undefined;
3135
3406
  /**
3136
- * <p>The configuration for a custom domain that hosts the sign-up and sign-in pages for
3137
- * your application. Use this object to specify an SSL certificate that is managed by
3138
- * ACM.</p>
3407
+ * <p>The configuration for a custom domain that hosts managed login for your application.
3408
+ * In an <code>UpdateUserPoolDomain</code> request, this parameter specifies an SSL
3409
+ * certificate for the managed login hosted webserver. The certificate must be an ACM ARN
3410
+ * in <code>us-east-1</code>.</p>
3139
3411
  * <p>When you create a custom domain, the passkey RP ID defaults to the custom domain. If
3140
3412
  * you had a prefix domain active, this will cause passkey integration for your prefix
3141
3413
  * domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey
3142
- * integration working, you can explicitly set RP ID to the prefix domain. Update the RP ID
3143
- * in a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> request.</p>
3414
+ * integration working, you can explicitly set RP ID to the prefix domain.</p>
3144
3415
  * @public
3145
3416
  */
3146
3417
  CustomDomainConfig?: CustomDomainConfigType | undefined;
@@ -3152,14 +3423,17 @@ export interface UpdateUserPoolDomainRequest {
3152
3423
  export interface UpdateUserPoolDomainResponse {
3153
3424
  /**
3154
3425
  * <p>A version number that indicates the state of managed login for your domain. Version
3155
- * <code>1</code> is hosted UI (classic). Version <code>2</code> is the newer managed
3426
+ * <code>1</code> is hosted UI (classic). Version <code>2</code> is the newer managed
3156
3427
  * login with the branding designer. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">Managed login</a>.</p>
3157
3428
  * @public
3158
3429
  */
3159
3430
  ManagedLoginVersion?: number | undefined;
3160
3431
  /**
3161
- * <p>The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user
3162
- * pool.</p>
3432
+ * <p>The fully-qualified domain name (FQDN) of the Amazon CloudFront distribution that hosts your
3433
+ * managed login or classic hosted UI pages. You domain-name authority must have an alias
3434
+ * record that points requests for your custom domain to this FQDN. Amazon Cognito returns this
3435
+ * value if you set a custom domain with <code>CustomDomainConfig</code>. If you set an
3436
+ * Amazon Cognito prefix domain, this operation returns a blank response.</p>
3163
3437
  * @public
3164
3438
  */
3165
3439
  CloudFrontDomain?: string | undefined;
@@ -3182,24 +3456,23 @@ export declare class EnableSoftwareTokenMFAException extends __BaseException {
3182
3456
  */
3183
3457
  export interface VerifySoftwareTokenRequest {
3184
3458
  /**
3185
- * <p>A valid access token that Amazon Cognito issued to the user whose software token you want to
3186
- * verify.</p>
3459
+ * <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
3460
+ * <code>aws.cognito.signin.user.admin</code>.</p>
3187
3461
  * @public
3188
3462
  */
3189
3463
  AccessToken?: string | undefined;
3190
3464
  /**
3191
- * <p>The session that should be passed both ways in challenge-response calls to the
3192
- * service.</p>
3465
+ * <p>The session ID from an <code>AssociateSoftwareToken</code> request.</p>
3193
3466
  * @public
3194
3467
  */
3195
3468
  Session?: string | undefined;
3196
3469
  /**
3197
- * <p>The one- time password computed using the secret code returned by <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html">AssociateSoftwareToken</a>.</p>
3470
+ * <p>A TOTP that the user generated in their configured authenticator app.</p>
3198
3471
  * @public
3199
3472
  */
3200
3473
  UserCode: string | undefined;
3201
3474
  /**
3202
- * <p>The friendly device name.</p>
3475
+ * <p>A friendly name for the device that's running the TOTP authenticator.</p>
3203
3476
  * @public
3204
3477
  */
3205
3478
  FriendlyDeviceName?: string | undefined;
@@ -3221,13 +3494,15 @@ export type VerifySoftwareTokenResponseType = (typeof VerifySoftwareTokenRespons
3221
3494
  */
3222
3495
  export interface VerifySoftwareTokenResponse {
3223
3496
  /**
3224
- * <p>The status of the verify software token.</p>
3497
+ * <p>Amazon Cognito can accept or reject the code that you provide. This response parameter
3498
+ * indicates the success of TOTP verification. Some reasons that this operation might
3499
+ * return an error are clock skew on the user's device and excessive retries.</p>
3225
3500
  * @public
3226
3501
  */
3227
3502
  Status?: VerifySoftwareTokenResponseType | undefined;
3228
3503
  /**
3229
- * <p>The session that should be passed both ways in challenge-response calls to the
3230
- * service.</p>
3504
+ * <p>This session ID satisfies an <code>MFA_SETUP</code> challenge. Supply the session ID
3505
+ * in your challenge response.</p>
3231
3506
  * @public
3232
3507
  */
3233
3508
  Session?: string | undefined;
@@ -3238,18 +3513,19 @@ export interface VerifySoftwareTokenResponse {
3238
3513
  */
3239
3514
  export interface VerifyUserAttributeRequest {
3240
3515
  /**
3241
- * <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to
3242
- * verify.</p>
3516
+ * <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
3517
+ * <code>aws.cognito.signin.user.admin</code>.</p>
3243
3518
  * @public
3244
3519
  */
3245
3520
  AccessToken: string | undefined;
3246
3521
  /**
3247
- * <p>The attribute name in the request to verify user attributes.</p>
3522
+ * <p>The name of the attribute that you want to verify.</p>
3248
3523
  * @public
3249
3524
  */
3250
3525
  AttributeName: string | undefined;
3251
3526
  /**
3252
- * <p>The verification code in the request to verify user attributes.</p>
3527
+ * <p>The verification code that your user pool sent to the added or changed attribute, for
3528
+ * example the user's email address.</p>
3253
3529
  * @public
3254
3530
  */
3255
3531
  Code: string | undefined;