@aws-sdk/client-cognito-identity-provider 3.530.0 → 3.535.0

package/dist-types/models/models_1.d.ts

@@ -6,9 +6,9 @@ import { AccountRecoverySettingType, AccountTakeoverRiskConfigurationType, Admin
  */
 export interface SetLogDeliveryConfigurationResponse {
     /**
-     * @public
      * <p>The detailed activity logging configuration that you applied to the requested user
      *             pool.</p>
+     * @public
      */
     LogDeliveryConfiguration?: LogDeliveryConfigurationType;
 }
@@ -17,33 +17,33 @@ export interface SetLogDeliveryConfigurationResponse {
  */
 export interface SetRiskConfigurationRequest {
     /**
-     * @public
      * <p>The user pool ID. </p>
+     * @public
      */
     UserPoolId: string | undefined;
     /**
-     * @public
      * <p>The app client ID. If <code>ClientId</code> is null, then the risk configuration is
      *             mapped to <code>userPoolId</code>. When the client ID is null, the same risk
      *             configuration is applied to all the clients in the userPool.</p>
      *          <p>Otherwise, <code>ClientId</code> is mapped to the client. When the client ID isn't
      *             null, the user pool configuration is overridden and the risk configuration for the
      *             client is used instead.</p>
+     * @public
      */
     ClientId?: string;
     /**
-     * @public
      * <p>The compromised credentials risk configuration.</p>
+     * @public
      */
     CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType;
     /**
-     * @public
      * <p>The account takeover risk configuration.</p>
+     * @public
      */
     AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType;
     /**
-     * @public
      * <p>The configuration to override the risk decision.</p>
+     * @public
      */
     RiskExceptionConfiguration?: RiskExceptionConfigurationType;
 }
@@ -52,8 +52,8 @@ export interface SetRiskConfigurationRequest {
  */
 export interface SetRiskConfigurationResponse {
     /**
-     * @public
      * <p>The risk configuration.</p>
+     * @public
      */
     RiskConfiguration: RiskConfigurationType | undefined;
 }
@@ -62,23 +62,23 @@ export interface SetRiskConfigurationResponse {
  */
 export interface SetUICustomizationRequest {
     /**
-     * @public
      * <p>The user pool ID for the user pool.</p>
+     * @public
      */
     UserPoolId: string | undefined;
     /**
-     * @public
      * <p>The client ID for the client app.</p>
+     * @public
      */
     ClientId?: string;
     /**
-     * @public
      * <p>The CSS values in the UI customization.</p>
+     * @public
      */
     CSS?: string;
     /**
-     * @public
      * <p>The uploaded logo image for the UI customization.</p>
+     * @public
      */
     ImageFile?: Uint8Array;
 }
@@ -87,8 +87,8 @@ export interface SetUICustomizationRequest {
  */
 export interface SetUICustomizationResponse {
     /**
-     * @public
      * <p>The UI customization information.</p>
+     * @public
      */
     UICustomization: UICustomizationType | undefined;
 }
@@ -97,19 +97,19 @@ export interface SetUICustomizationResponse {
  */
 export interface SetUserMFAPreferenceRequest {
     /**
-     * @public
      * <p>The SMS text message multi-factor authentication (MFA) settings.</p>
+     * @public
      */
     SMSMfaSettings?: SMSMfaSettingsType;
     /**
-     * @public
      * <p>The time-based one-time password (TOTP) software token MFA settings.</p>
+     * @public
      */
     SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType;
     /**
-     * @public
      * <p>A valid access token that Amazon Cognito issued to the user whose MFA preference you want to
      *             set.</p>
+     * @public
      */
     AccessToken: string | undefined;
 }
@@ -123,22 +123,21 @@ export interface SetUserMFAPreferenceResponse {
  */
 export interface SetUserPoolMfaConfigRequest {
     /**
-     * @public
      * <p>The user pool ID.</p>
+     * @public
      */
     UserPoolId: string | undefined;
     /**
-     * @public
      * <p>The SMS text message MFA configuration.</p>
+     * @public
      */
     SmsMfaConfiguration?: SmsMfaConfigType;
     /**
-     * @public
      * <p>The software token MFA configuration.</p>
+     * @public
      */
     SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
     /**
-     * @public
      * <p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who
      *             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
      *                 Authentication (MFA) to a user pool</a>. Valid values include:</p>
@@ -157,6 +156,7 @@ export interface SetUserPoolMfaConfigRequest {
      *                     an MFA factor activated.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     MfaConfiguration?: UserPoolMfaType;
 }
@@ -165,17 +165,16 @@ export interface SetUserPoolMfaConfigRequest {
  */
 export interface SetUserPoolMfaConfigResponse {
     /**
-     * @public
      * <p>The SMS text message MFA configuration.</p>
+     * @public
      */
     SmsMfaConfiguration?: SmsMfaConfigType;
     /**
-     * @public
      * <p>The software token MFA configuration.</p>
+     * @public
      */
     SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
     /**
-     * @public
      * <p>The MFA configuration. Valid values include:</p>
      *          <ul>
      *             <li>
@@ -192,69 +191,69 @@ export interface SetUserPoolMfaConfigResponse {
      *                     an MFA factor enabled.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     MfaConfiguration?: UserPoolMfaType;
 }
 /**
- * @public
  * <p>Represents the request to set user settings.</p>
+ * @public
  */
 export interface SetUserSettingsRequest {
     /**
-     * @public
      * <p>A valid access token that Amazon Cognito issued to the user whose user settings you want to
      *             configure.</p>
+     * @public
      */
     AccessToken: string | undefined;
     /**
-     * @public
      * <p>You can use this parameter only to set an SMS configuration that uses SMS for
      *             delivery.</p>
+     * @public
      */
     MFAOptions: MFAOptionType[] | undefined;
 }
 /**
- * @public
  * <p>The response from the server for a set user settings request.</p>
+ * @public
  */
 export interface SetUserSettingsResponse {
 }
 /**
- * @public
  * <p>Represents the request to register a user.</p>
+ * @public
  */
 export interface SignUpRequest {
     /**
-     * @public
      * <p>The ID of the client associated with the user pool.</p>
+     * @public
      */
     ClientId: string | undefined;
     /**
-     * @public
      * <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a
      *             user pool client and username plus the client ID in the message.</p>
+     * @public
      */
     SecretHash?: string;
     /**
-     * @public
      * <p>The username of the user that you want to sign up. The value of this parameter is
      *             typically a username, but can be any alias attribute in your user pool.</p>
+     * @public
      */
     Username: string | undefined;
     /**
-     * @public
      * <p>The password of the user you want to register.</p>
+     * @public
      */
     Password: string | undefined;
     /**
-     * @public
      * <p>An array of name-value pairs representing user attributes.</p>
      *          <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
      *             attribute name.</p>
+     * @public
      */
     UserAttributes?: AttributeType[];
     /**
-     * @public
      * <p>Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda
      *     trigger. This set of key-value pairs are for custom validation of information that you
      *     collect from your users but don't need to retain.</p>
@@ -264,23 +263,23 @@ export interface SignUpRequest {
      *     to Amazon Cognito, like automatically confirming the user if they sign up from within your
      *     network.</p>
      *          <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>
+     * @public
      */
     ValidationData?: AttributeType[];
     /**
-     * @public
      * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
      *                 <code>SignUp</code> calls.</p>
+     * @public
      */
     AnalyticsMetadata?: AnalyticsMetadataType;
     /**
-     * @public
      * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
      * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
      * when it makes API requests.</p>
+     * @public
      */
     UserContextData?: UserContextDataType;
     /**
-     * @public
      * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
      *             that this action triggers.</p>
      *          <p>You create custom workflows by assigning Lambda functions to user pool triggers.
@@ -313,86 +312,87 @@ export interface SignUpRequest {
      *                </li>
      *             </ul>
      *          </note>
+     * @public
      */
     ClientMetadata?: Record<string, string>;
 }
 /**
- * @public
  * <p>The response from the server for a registration request.</p>
+ * @public
  */
 export interface SignUpResponse {
     /**
-     * @public
      * <p>A response from the server indicating that a user registration has been
      *             confirmed.</p>
+     * @public
      */
     UserConfirmed: boolean | undefined;
     /**
-     * @public
      * <p>The code delivery details returned by the server response to the user registration
      *             request.</p>
+     * @public
      */
     CodeDeliveryDetails?: CodeDeliveryDetailsType;
     /**
-     * @public
      * <p>The UUID of the authenticated user. This isn't the same as
      *             <code>username</code>.</p>
+     * @public
      */
     UserSub: string | undefined;
 }
 /**
- * @public
  * <p>Represents the request to start the user import job.</p>
+ * @public
  */
 export interface StartUserImportJobRequest {
     /**
-     * @public
      * <p>The user pool ID for the user pool that the users are being imported into.</p>
+     * @public
      */
     UserPoolId: string | undefined;
     /**
-     * @public
      * <p>The job ID for the user import job.</p>
+     * @public
      */
     JobId: string | undefined;
 }
 /**
- * @public
  * <p>Represents the response from the server to the request to start the user import
  *             job.</p>
+ * @public
  */
 export interface StartUserImportJobResponse {
     /**
-     * @public
      * <p>The job object that represents the user import job.</p>
+     * @public
      */
     UserImportJob?: UserImportJobType;
 }
 /**
- * @public
  * <p>Represents the request to stop the user import job.</p>
+ * @public
  */
 export interface StopUserImportJobRequest {
     /**
-     * @public
      * <p>The user pool ID for the user pool that the users are being imported into.</p>
+     * @public
      */
     UserPoolId: string | undefined;
     /**
-     * @public
      * <p>The job ID for the user import job.</p>
+     * @public
      */
     JobId: string | undefined;
 }
 /**
- * @public
  * <p>Represents the response from the server to the request to stop the user import
  *             job.</p>
+ * @public
  */
 export interface StopUserImportJobResponse {
     /**
-     * @public
      * <p>The job object that represents the user import job.</p>
+     * @public
      */
     UserImportJob?: UserImportJobType;
 }
@@ -401,13 +401,13 @@ export interface StopUserImportJobResponse {
  */
 export interface TagResourceRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the user pool to assign the tags to.</p>
+     * @public
      */
     ResourceArn: string | undefined;
     /**
-     * @public
      * <p>The tags to assign to the user pool.</p>
+     * @public
      */
     Tags: Record<string, string> | undefined;
 }
@@ -421,13 +421,13 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
+     * @public
      */
     ResourceArn: string | undefined;
     /**
-     * @public
      * <p>The keys of the tags to remove from the user pool.</p>
+     * @public
      */
     TagKeys: string[] | undefined;
 }
@@ -441,36 +441,36 @@ export interface UntagResourceResponse {
  */
 export interface UpdateAuthEventFeedbackRequest {
     /**
-     * @public
      * <p>The user pool ID.</p>
+     * @public
      */
     UserPoolId: string | undefined;
     /**
-     * @public
      * <p>The username of the user that you want to query or modify. The value of this parameter
      *             is typically your user's username, but it can be any of their alias attributes. If
      *                 <code>username</code> isn't an alias attribute in your user pool, this value
      *             must be the <code>sub</code> of a local user or the username of a user from a
      *             third-party IdP.</p>
+     * @public
      */
     Username: string | undefined;
     /**
-     * @public
      * <p>The event ID.</p>
+     * @public
      */
     EventId: string | undefined;
     /**
-     * @public
      * <p>The feedback token.</p>
+     * @public
      */
     FeedbackToken: string | undefined;
     /**
-     * @public
      * <p>The authentication event feedback value. When you provide a <code>FeedbackValue</code>
      * value of <code>valid</code>, you tell Amazon Cognito that you trust a user session where Amazon Cognito
      * has evaluated some level of risk. When you provide a <code>FeedbackValue</code> value of
      * <code>invalid</code>, you tell Amazon Cognito that you don't trust a user session, or you
      * don't believe that Amazon Cognito evaluated a high-enough risk level.</p>
+     * @public
      */
     FeedbackValue: FeedbackValueType | undefined;
 }
@@ -480,30 +480,30 @@ export interface UpdateAuthEventFeedbackRequest {
 export interface UpdateAuthEventFeedbackResponse {
 }
 /**
- * @public
  * <p>Represents the request to update the device status.</p>
+ * @public
  */
 export interface UpdateDeviceStatusRequest {
     /**
-     * @public
      * <p>A valid access token that Amazon Cognito issued to the user whose device status you want to
      *             update.</p>
+     * @public
      */
     AccessToken: string | undefined;
     /**
-     * @public
      * <p>The device key.</p>
+     * @public
      */
     DeviceKey: string | undefined;
     /**
-     * @public
      * <p>The status of whether a device is remembered.</p>
+     * @public
      */
     DeviceRememberedStatus?: DeviceRememberedStatusType;
 }
 /**
- * @public
  * <p>The response to the request to update the device status.</p>
+ * @public
  */
 export interface UpdateDeviceStatusResponse {
 }
@@ -512,31 +512,31 @@ export interface UpdateDeviceStatusResponse {
  */
 export interface UpdateGroupRequest {
     /**
-     * @public
      * <p>The name of the group.</p>
+     * @public
      */
     GroupName: string | undefined;
     /**
-     * @public
      * <p>The user pool ID for the user pool.</p>
+     * @public
      */
     UserPoolId: string | undefined;
     /**
-     * @public
      * <p>A string containing the new description of the group.</p>
+     * @public
      */
     Description?: string;
     /**
-     * @public
      * <p>The new role Amazon Resource Name (ARN) for the group. This is used for setting the
      *                 <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims in the
      *             token.</p>
+     * @public
      */
     RoleArn?: string;
     /**
-     * @public
      * <p>The new precedence value for the group. For more information about this parameter, see
      *                 <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html">CreateGroup</a>.</p>
+     * @public
      */
     Precedence?: number;
 }
@@ -545,8 +545,8 @@ export interface UpdateGroupRequest {
  */
 export interface UpdateGroupResponse {
     /**
-     * @public
      * <p>The group object for the group.</p>
+     * @public
      */
     Group?: GroupType;
 }
@@ -555,17 +555,16 @@ export interface UpdateGroupResponse {
  */
 export interface UpdateIdentityProviderRequest {
     /**
-     * @public
      * <p>The user pool ID.</p>
+     * @public
      */
     UserPoolId: string | undefined;
     /**
-     * @public
      * <p>The IdP name.</p>
+     * @public
      */
     ProviderName: string | undefined;
     /**
-     * @public
      * <p>The scopes, URLs, and identifiers for your external identity provider. The following
      * examples describe the provider detail keys for each IdP type. These values and their
      * schema are subject to change. Social IdP <code>authorize_scopes</code> values must match
@@ -685,16 +684,17 @@ export interface UpdateIdentityProviderRequest {
      *                </p>
      *             </dd>
      *          </dl>
+     * @public
      */
     ProviderDetails?: Record<string, string>;
     /**
-     * @public
      * <p>The IdP attribute mapping to be changed.</p>
+     * @public
      */
     AttributeMapping?: Record<string, string>;
     /**
-     * @public
      * <p>A list of IdP identifiers.</p>
+     * @public
      */
     IdpIdentifiers?: string[];
 }
@@ -703,8 +703,8 @@ export interface UpdateIdentityProviderRequest {
  */
 export interface UpdateIdentityProviderResponse {
     /**
-     * @public
      * <p>The identity provider details.</p>
+     * @public
      */
     IdentityProvider: IdentityProviderType | undefined;
 }
@@ -713,23 +713,23 @@ export interface UpdateIdentityProviderResponse {
  */
 export interface UpdateResourceServerRequest {
     /**
-     * @public
      * <p>The user pool ID for the user pool.</p>
+     * @public
      */
     UserPoolId: string | undefined;
     /**
-     * @public
      * <p>The identifier for the resource server.</p>
+     * @public
      */
     Identifier: string | undefined;
     /**
-     * @public
      * <p>The name of the resource server.</p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>The scope values to be set for the resource server.</p>
+     * @public
      */
     Scopes?: ResourceServerScopeType[];
 }
@@ -738,18 +738,17 @@ export interface UpdateResourceServerRequest {
  */
 export interface UpdateResourceServerResponse {
     /**
-     * @public
      * <p>The resource server.</p>
+     * @public
      */
     ResourceServer: ResourceServerType | undefined;
 }
 /**
- * @public
  * <p>Represents the request to update user attributes.</p>
+ * @public
  */
 export interface UpdateUserAttributesRequest {
     /**
-     * @public
      * <p>An array of name-value pairs representing user attributes.</p>
      *          <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
      *             attribute name.</p>
@@ -758,16 +757,16 @@ export interface UpdateUserAttributesRequest {
      *             receives and responds to a verification message to verify the new value, Amazon Cognito updates
      *             the attribute value. Your user can sign in and receive messages with the original
      *             attribute value until they verify the new value.</p>
+     * @public
      */
     UserAttributes: AttributeType[] | undefined;
     /**
-     * @public
      * <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to
      *             update.</p>
+     * @public
      */
     AccessToken: string | undefined;
     /**
-     * @public
      * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
      *             that this action initiates. </p>
      *          <p>You create custom workflows by assigning Lambda functions to user pool triggers. When
@@ -799,39 +798,39 @@ export interface UpdateUserAttributesRequest {
      *                </li>
      *             </ul>
      *          </note>
+     * @public
      */
     ClientMetadata?: Record<string, string>;
 }
 /**
- * @public
  * <p>Represents the response from the server for the request to update user
  *             attributes.</p>
+ * @public
  */
 export interface UpdateUserAttributesResponse {
     /**
-     * @public
      * <p>The code delivery details list from the server for the request to update user
      *             attributes.</p>
+     * @public
      */
     CodeDeliveryDetailsList?: CodeDeliveryDetailsType[];
 }
 /**
- * @public
  * <p>Represents the request to update the user pool.</p>
+ * @public
  */
 export interface UpdateUserPoolRequest {
     /**
-     * @public
      * <p>The user pool ID for the user pool you want to update.</p>
+     * @public
      */
     UserPoolId: string | undefined;
     /**
-     * @public
      * <p>A container with the policies you want to update in a user pool.</p>
+     * @public
      */
     Policies?: UserPoolPolicyType;
     /**
-     * @public
      * <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user
      * pool. Before you can delete a user pool that you have protected against deletion, you
      * must deactivate this feature.</p>
@@ -839,54 +838,54 @@ export interface UpdateUserPoolRequest {
      * Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool,
      * send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an
      * <code>UpdateUserPool</code> API request.</p>
+     * @public
      */
     DeletionProtection?: DeletionProtectionType;
     /**
-     * @public
      * <p>The Lambda configuration information from the request to update the user pool.</p>
+     * @public
      */
     LambdaConfig?: LambdaConfigType;
     /**
-     * @public
      * <p>The attributes that are automatically verified when Amazon Cognito requests to update user
      *             pools.</p>
+     * @public
      */
     AutoVerifiedAttributes?: VerifiedAttributeType[];
     /**
-     * @public
      * <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>
+     * @public
      */
     SmsVerificationMessage?: string;
     /**
-     * @public
      * <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>
+     * @public
      */
     EmailVerificationMessage?: string;
     /**
-     * @public
      * <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>
+     * @public
      */
     EmailVerificationSubject?: string;
     /**
-     * @public
      * <p>The template for verification messages.</p>
+     * @public
      */
     VerificationMessageTemplate?: VerificationMessageTemplateType;
     /**
-     * @public
      * <p>The contents of the SMS authentication message.</p>
+     * @public
      */
     SmsAuthenticationMessage?: string;
     /**
-     * @public
      * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
      * a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For
      * more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates">
      * Verifying updates to email addresses and phone numbers</a>.</p>
+     * @public
      */
     UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
     /**
-     * @public
      * <p>Possible values include:</p>
      *          <ul>
      *             <li>
@@ -907,95 +906,95 @@ export interface UpdateUserPoolRequest {
      *                     token.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     MfaConfiguration?: UserPoolMfaType;
     /**
-     * @public
      * <p>The device-remembering configuration for a user pool. A null value indicates that you
      *             have deactivated device remembering in your user pool.</p>
      *          <note>
      *             <p>When you provide a value for any <code>DeviceConfiguration</code> field, you
      *                 activate the Amazon Cognito device-remembering feature.</p>
      *          </note>
+     * @public
      */
     DeviceConfiguration?: DeviceConfigurationType;
     /**
-     * @public
      * <p>The email configuration of your user pool. The email configuration type sets your
      *             preferred sending method, Amazon Web Services Region, and sender for email invitation and verification
      *             messages from your user pool.</p>
+     * @public
      */
     EmailConfiguration?: EmailConfigurationType;
     /**
-     * @public
      * <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
      *             SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
      *             with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management
      *             (IAM) role in your Amazon Web Services account.</p>
+     * @public
      */
     SmsConfiguration?: SmsConfigurationType;
     /**
-     * @public
      * <p>The tag keys and values to assign to the user pool. A tag is a label that you can use
      *             to categorize and manage user pools in different ways, such as by purpose, owner,
      *             environment, or other criteria.</p>
+     * @public
      */
     UserPoolTags?: Record<string, string>;
     /**
-     * @public
      * <p>The configuration for <code>AdminCreateUser</code> requests.</p>
+     * @public
      */
     AdminCreateUserConfig?: AdminCreateUserConfigType;
     /**
-     * @public
      * <p>User pool add-ons. Contains settings for activation of advanced security features. To
      *     log user security information but take no action, set to <code>AUDIT</code>. To
      *     configure automatic security responses to risky traffic to your user pool, set to
      *         <code>ENFORCED</code>.</p>
      *          <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>
+     * @public
      */
     UserPoolAddOns?: UserPoolAddOnsType;
     /**
-     * @public
      * <p>The available verified method a user can use to recover their password when they call
      *                 <code>ForgotPassword</code>. You can use this setting to define a preferred method
      *             when a user has more than one method available. With this setting, SMS doesn't qualify
      *             for a valid password recovery mechanism if the user also has SMS multi-factor
      *             authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy
      *             behavior to determine the recovery method where SMS is preferred through email.</p>
+     * @public
      */
     AccountRecoverySetting?: AccountRecoverySettingType;
 }
 /**
- * @public
  * <p>Represents the response from the server when you make a request to update the user
  *             pool.</p>
+ * @public
  */
 export interface UpdateUserPoolResponse {
 }
 /**
- * @public
  * <p>Represents the request to update the user pool client.</p>
+ * @public
  */
 export interface UpdateUserPoolClientRequest {
     /**
-     * @public
      * <p>The user pool ID for the user pool where you want to update the user pool
      *             client.</p>
+     * @public
      */
     UserPoolId: string | undefined;
     /**
-     * @public
      * <p>The ID of the client associated with the user pool.</p>
+     * @public
      */
     ClientId: string | undefined;
     /**
-     * @public
      * <p>The client name from the update user pool client request.</p>
+     * @public
      */
     ClientName?: string;
     /**
-     * @public
      * <p>The refresh token time limit. After this limit expires, your user can't use
      * their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as
      * <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
@@ -1009,10 +1008,10 @@ export interface UpdateUserPoolClientRequest {
      * in seconds.</p>
      *          <p>If you don't specify otherwise in the configuration of your app client, your refresh
      * tokens are valid for 30 days.</p>
+     * @public
      */
     RefreshTokenValidity?: number;
     /**
-     * @public
      * <p>The access token time limit. After this limit expires, your user can't use
      * their access token. To specify the time unit for <code>AccessTokenValidity</code> as
      * <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
@@ -1024,10 +1023,10 @@ export interface UpdateUserPoolClientRequest {
      * <i>Valid range</i> is displayed below in seconds.</p>
      *          <p>If you don't specify otherwise in the configuration of your app client, your access
      * tokens are valid for one hour.</p>
+     * @public
      */
     AccessTokenValidity?: number;
     /**
-     * @public
      * <p>The ID token time limit. After this limit expires, your user can't use
      * their ID token. To specify the time unit for <code>IdTokenValidity</code> as
      * <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
@@ -1039,17 +1038,17 @@ export interface UpdateUserPoolClientRequest {
      * <i>Valid range</i> is displayed below in seconds.</p>
      *          <p>If you don't specify otherwise in the configuration of your app client, your ID
      * tokens are valid for one hour.</p>
+     * @public
      */
     IdTokenValidity?: number;
     /**
-     * @public
      * <p>The time units you use when you set the duration of ID, access, and refresh tokens.
      *             The default unit for RefreshToken is days, and the default for ID and access tokens is
      *             hours.</p>
+     * @public
      */
     TokenValidityUnits?: TokenValidityUnitsType;
     /**
-     * @public
      * <p>The list of user attributes that you want your app client to have read-only access to.
      *     After your user authenticates in your app, their access token authorizes them to read
      *     their own attribute value for any attribute in this list. An example of this kind of
@@ -1063,10 +1062,10 @@ export interface UpdateUserPoolClientRequest {
      *         <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
      *     populates <code>ReadAttributes</code> in the API response if you have specified your own
      *     custom set of read attributes.</p>
+     * @public
      */
     ReadAttributes?: string[];
     /**
-     * @public
      * <p>The list of user attributes that you want your app client to have write access to.
      *     After your user authenticates in your app, their access token authorizes them to set or
      *     modify their own attribute value for any attribute in this list. An example of this kind
@@ -1085,10 +1084,10 @@ export interface UpdateUserPoolClientRequest {
      *     access to a mapped attribute, Amazon Cognito throws an error when it tries to update the
      *     attribute. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying IdP Attribute Mappings for Your user
      *     pool</a>.</p>
+     * @public
      */
     WriteAttributes?: string[];
     /**
-     * @public
      * <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
      * your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and
      * password, or a custom authentication process that you define with Lambda functions.</p>
@@ -1129,18 +1128,18 @@ export interface UpdateUserPoolClientRequest {
      *          <p>In some environments, you will see the values <code>ADMIN_NO_SRP_AUTH</code>, <code>CUSTOM_AUTH_FLOW_ONLY</code>, or <code>USER_PASSWORD_AUTH</code>.
      * You can't assign these legacy <code>ExplicitAuthFlows</code> values to user pool clients at the same time as values that begin with <code>ALLOW_</code>,
      * like <code>ALLOW_USER_SRP_AUTH</code>.</p>
+     * @public
      */
     ExplicitAuthFlows?: ExplicitAuthFlowsType[];
     /**
-     * @public
      * <p>A list of provider names for the IdPs that this client supports. The following are
      *             supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>,
      *                 <code>SignInWithApple</code>, <code>LoginWithAmazon</code>, and the names of your
      *             own SAML and OIDC providers.</p>
+     * @public
      */
     SupportedIdentityProviders?: string[];
     /**
-     * @public
      * <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
      *          <p>A redirect URI must:</p>
      *          <ul>
@@ -1159,15 +1158,15 @@ export interface UpdateUserPoolClientRequest {
      *          <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes
      *             only.</p>
      *          <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
+     * @public
      */
     CallbackURLs?: string[];
     /**
-     * @public
      * <p>A list of allowed logout URLs for the IdPs.</p>
+     * @public
      */
     LogoutURLs?: string[];
     /**
-     * @public
      * <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>
      *          <p>A redirect URI must:</p>
      *          <ul>
@@ -1186,10 +1185,10 @@ export interface UpdateUserPoolClientRequest {
      *          <p>Amazon Cognito requires HTTPS over HTTP except for <code>http://localhost</code> for testing
      *             purposes only.</p>
      *          <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
+     * @public
      */
     DefaultRedirectURI?: string;
     /**
-     * @public
      * <p>The allowed OAuth flows.</p>
      *          <dl>
      *             <dt>code</dt>
@@ -1210,18 +1209,18 @@ export interface UpdateUserPoolClientRequest {
      *                         client secret.</p>
      *             </dd>
      *          </dl>
+     * @public
      */
     AllowedOAuthFlows?: OAuthFlowType[];
     /**
-     * @public
      * <p>The allowed OAuth scopes. Possible values provided by OAuth are <code>phone</code>,
      *                 <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values
      *             provided by Amazon Web Services are <code>aws.cognito.signin.user.admin</code>. Custom scopes created
      *             in Resource Servers are also supported.</p>
+     * @public
      */
     AllowedOAuthScopes?: string[];
     /**
-     * @public
      * <p>Set to <code>true</code> to use OAuth 2.0 features in your user pool app client.</p>
      *          <p>
      *             <code>AllowedOAuthFlowsUserPoolClient</code> must be <code>true</code> before you can configure
@@ -1249,10 +1248,10 @@ export interface UpdateUserPoolClientRequest {
      * <code>UpdateUserPoolClient</code> API request. If you don't set a value for
      * <code>AllowedOAuthFlowsUserPoolClient</code> in a request with the CLI or SDKs, it defaults
      * to <code>false</code>.</p>
+     * @public
      */
     AllowedOAuthFlowsUserPoolClient?: boolean;
     /**
-     * @public
      * <p>The Amazon Pinpoint analytics configuration necessary to collect metrics for this user
      *             pool.</p>
      *          <note>
@@ -1260,10 +1259,10 @@ export interface UpdateUserPoolClientRequest {
      *                 events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user
      *                 pools support sending events to Amazon Pinpoint projects within that same Region.</p>
      *          </note>
+     * @public
      */
     AnalyticsConfiguration?: AnalyticsConfigurationType;
     /**
-     * @public
      * <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account
      *             confirmation, and password recovery when the user doesn't exist in the user pool. When
      *             set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error
@@ -1284,87 +1283,88 @@ export interface UpdateUserPoolClientRequest {
      *                     existence related errors aren't prevented.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     PreventUserExistenceErrors?: PreventUserExistenceErrorTypes;
     /**
-     * @public
      * <p>Activates or deactivates token revocation. For more information about revoking tokens,
      *             see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
+     * @public
      */
     EnableTokenRevocation?: boolean;
     /**
-     * @public
      * <p>Activates the propagation of additional user context data. For more information about
      *             propagation of user context data, 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>. If you don’t include this
      *             parameter, you can't send device fingerprint information, including source IP address,
      *             to Amazon Cognito advanced security. You can only activate
      *                 <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a
      *             client secret.</p>
+     * @public
      */
     EnablePropagateAdditionalUserContextData?: boolean;
     /**
-     * @public
      * <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration,
      * in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
+     * @public
      */
     AuthSessionValidity?: number;
 }
 /**
- * @public
  * <p>Represents the response from the server to the request to update the user pool
  *             client.</p>
+ * @public
  */
 export interface UpdateUserPoolClientResponse {
     /**
-     * @public
      * <p>The user pool client value from the response from the server when you request to
      *             update the user pool client.</p>
+     * @public
      */
     UserPoolClient?: UserPoolClientType;
 }
 /**
- * @public
  * <p>The UpdateUserPoolDomain request input.</p>
+ * @public
  */
 export interface UpdateUserPoolDomainRequest {
     /**
-     * @public
      * <p>The domain name for the custom domain that hosts the sign-up and sign-in pages for
      *             your application. One example might be <code>auth.example.com</code>. </p>
      *          <p>This string can include only lowercase letters, numbers, and hyphens. Don't use a
      *             hyphen for the first or last character. Use periods to separate subdomain names.</p>
+     * @public
      */
     Domain: string | undefined;
     /**
-     * @public
      * <p>The ID of the user pool that is associated with the custom domain whose certificate
      *             you're updating.</p>
+     * @public
      */
     UserPoolId: string | undefined;
     /**
-     * @public
      * <p>The configuration for a custom domain that hosts the sign-up and sign-in pages for
      *             your application. Use this object to specify an SSL certificate that is managed by
      *             ACM.</p>
+     * @public
      */
     CustomDomainConfig: CustomDomainConfigType | undefined;
 }
 /**
- * @public
  * <p>The UpdateUserPoolDomain response output.</p>
+ * @public
  */
 export interface UpdateUserPoolDomainResponse {
     /**
-     * @public
      * <p>The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user
      *             pool.</p>
+     * @public
      */
     CloudFrontDomain?: string;
 }
 /**
- * @public
  * <p>This exception is thrown when there is a code mismatch and the service fails to
  *             configure the software token TOTP multi-factor authentication (MFA).</p>
+ * @public
  */
 export declare class EnableSoftwareTokenMFAException extends __BaseException {
     readonly name: "EnableSoftwareTokenMFAException";
@@ -1379,25 +1379,25 @@ export declare class EnableSoftwareTokenMFAException extends __BaseException {
  */
 export interface VerifySoftwareTokenRequest {
     /**
-     * @public
      * <p>A valid access token that Amazon Cognito issued to the user whose software token you want to
      *             verify.</p>
+     * @public
      */
     AccessToken?: string;
     /**
-     * @public
      * <p>The session that should be passed both ways in challenge-response calls to the
      *             service.</p>
+     * @public
      */
     Session?: string;
     /**
-     * @public
      * <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>
+     * @public
      */
     UserCode: string | undefined;
     /**
-     * @public
      * <p>The friendly device name.</p>
+     * @public
      */
     FriendlyDeviceName?: string;
 }
@@ -1418,43 +1418,43 @@ export type VerifySoftwareTokenResponseType = (typeof VerifySoftwareTokenRespons
  */
 export interface VerifySoftwareTokenResponse {
     /**
-     * @public
      * <p>The status of the verify software token.</p>
+     * @public
      */
     Status?: VerifySoftwareTokenResponseType;
     /**
-     * @public
      * <p>The session that should be passed both ways in challenge-response calls to the
      *             service.</p>
+     * @public
      */
     Session?: string;
 }
 /**
- * @public
  * <p>Represents the request to verify user attributes.</p>
+ * @public
  */
 export interface VerifyUserAttributeRequest {
     /**
-     * @public
      * <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to
      *             verify.</p>
+     * @public
      */
     AccessToken: string | undefined;
     /**
-     * @public
      * <p>The attribute name in the request to verify user attributes.</p>
+     * @public
      */
     AttributeName: string | undefined;
     /**
-     * @public
      * <p>The verification code in the request to verify user attributes.</p>
+     * @public
      */
     Code: string | undefined;
 }
 /**
- * @public
  * <p>A container representing the response from the server from the request to verify user
  *             attributes.</p>
+ * @public
  */
 export interface VerifyUserAttributeResponse {
 }