@aws-sdk/client-cognito-identity-provider 3.92.0 → 3.98.0

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

@@ -1,8 +1,28 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { CognitoIdentityProviderServiceException as __BaseException } from "./CognitoIdentityProviderServiceException";
-import { AccountRecoverySettingType, AdminCreateUserConfigType, AnalyticsConfigurationType, AttributeType, CodeDeliveryDetailsType, CustomDomainConfigType, DeviceConfigurationType, DeviceRememberedStatusType, EmailConfigurationType, ExplicitAuthFlowsType, FeedbackValueType, GroupType, IdentityProviderType, LambdaConfigType, OAuthFlowType, PreventUserExistenceErrorTypes, ResourceServerScopeType, ResourceServerType, SmsConfigurationType, TokenValidityUnitsType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolMfaType, UserPoolPolicyType, VerificationMessageTemplateType, VerifiedAttributeType } from "./models_0";
+import { AccountRecoverySettingType, AdminCreateUserConfigType, AnalyticsConfigurationType, AttributeType, CodeDeliveryDetailsType, CustomDomainConfigType, DeviceConfigurationType, DeviceRememberedStatusType, EmailConfigurationType, ExplicitAuthFlowsType, FeedbackValueType, GroupType, IdentityProviderType, LambdaConfigType, OAuthFlowType, PreventUserExistenceErrorTypes, ResourceServerScopeType, ResourceServerType, SmsConfigurationType, TokenValidityUnitsType, UserAttributeUpdateSettingsType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolMfaType, UserPoolPolicyType, VerificationMessageTemplateType, VerifiedAttributeType } from "./models_0";
 /**
- * <p>Represents the response from the server to the request to start the user import job.</p>
+ * <p>Represents the request to start the user import job.</p>
+ */
+export interface StartUserImportJobRequest {
+    /**
+     * <p>The user pool ID for the user pool that the users are being imported into.</p>
+     */
+    UserPoolId: string | undefined;
+    /**
+     * <p>The job ID for the user import job.</p>
+     */
+    JobId: string | undefined;
+}
+export declare namespace StartUserImportJobRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: StartUserImportJobRequest) => any;
+}
+/**
+ * <p>Represents the response from the server to the request to start the user import
+ *             job.</p>
  */
 export interface StartUserImportJobResponse {
     /**
@@ -21,8 +41,7 @@ export declare namespace StartUserImportJobResponse {
  */
 export interface StopUserImportJobRequest {
     /**
-     * <p>The user pool ID for the user pool that the users are being imported
-     *     into.</p>
+     * <p>The user pool ID for the user pool that the users are being imported into.</p>
      */
     UserPoolId: string | undefined;
     /**
@@ -37,7 +56,8 @@ export declare namespace StopUserImportJobRequest {
     const filterSensitiveLog: (obj: StopUserImportJobRequest) => any;
 }
 /**
- * <p>Represents the response from the server to the request to stop the user import job.</p>
+ * <p>Represents the response from the server to the request to stop the user import
+ *             job.</p>
  */
 export interface StopUserImportJobResponse {
     /**
@@ -142,7 +162,8 @@ export declare namespace UpdateAuthEventFeedbackResponse {
  */
 export interface UpdateDeviceStatusRequest {
     /**
-     * <p>The access token.</p>
+     * <p>A valid access token that Amazon Cognito issued to the user whose device status you want to
+     *             update.</p>
      */
     AccessToken: string | undefined;
     /**
@@ -185,12 +206,14 @@ export interface UpdateGroupRequest {
      */
     Description?: string;
     /**
-     * <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>
+     * <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>
      */
     RoleArn?: string;
     /**
-     * <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>
+     * <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>
      */
     Precedence?: number;
 }
@@ -218,23 +241,24 @@ export interface UpdateIdentityProviderRequest {
      */
     UserPoolId: string | undefined;
     /**
-     * <p>The identity provider name.</p>
+     * <p>The IdP name.</p>
      */
     ProviderName: string | undefined;
     /**
-     * <p>The identity provider details to be updated, such as <code>MetadataURL</code> and <code>MetadataFile</code>.</p>
+     * <p>The IdP details to be updated, such as <code>MetadataURL</code> and
+     *                 <code>MetadataFile</code>.</p>
      */
     ProviderDetails?: {
         [key: string]: string;
     };
     /**
-     * <p>The identity provider attribute mapping to be changed.</p>
+     * <p>The IdP attribute mapping to be changed.</p>
      */
     AttributeMapping?: {
         [key: string]: string;
     };
     /**
-     * <p>A list of identity provider identifiers.</p>
+     * <p>A list of IdP identifiers.</p>
      */
     IdpIdentifiers?: string[];
 }
@@ -246,7 +270,7 @@ export declare namespace UpdateIdentityProviderRequest {
 }
 export interface UpdateIdentityProviderResponse {
     /**
-     * <p>The identity provider object.</p>
+     * <p>The IdP object.</p>
      */
     IdentityProvider: IdentityProviderType | undefined;
 }
@@ -298,15 +322,23 @@ export declare namespace UpdateResourceServerResponse {
 export interface UpdateUserAttributesRequest {
     /**
      * <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>
+     *         <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
+     *             attribute name.</p>
+     *         <p>If you have set an attribute to require verification before Amazon Cognito updates its value,
+     *             this request doesn’t immediately update the value of that attribute. After your user
+     *             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>
      */
     UserAttributes: AttributeType[] | undefined;
     /**
-     * <p>The access token for the request to update user attributes.</p>
+     * <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to
+     *             update.</p>
      */
     AccessToken: string | undefined;
     /**
-     * <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates. </p>
+     * <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
      *             you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned
      *             to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it
@@ -319,21 +351,25 @@ export interface UpdateUserAttributesRequest {
      *          <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">
      * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
      *
-     *          <note>
-     *             <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
+     *         <note>
+     *             <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the
+     *                 following:</p>
      *             <ul>
      *                <li>
-     *                   <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool
-     *                 configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p>
-     *                </li>
+     *                     <p>Store the ClientMetadata value. This data is available only to Lambda
+     *                         triggers that are assigned to a user pool to support custom workflows. If
+     *                         your user pool configuration doesn't include triggers, the ClientMetadata
+     *                         parameter serves no purpose.</p>
+     *                 </li>
      *                <li>
-     *                   <p>Validate the ClientMetadata value.</p>
-     *                </li>
+     *                     <p>Validate the ClientMetadata value.</p>
+     *                 </li>
      *                <li>
-     *                   <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p>
-     *                </li>
+     *                     <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive
+     *                         information.</p>
+     *                 </li>
      *             </ul>
-     *          </note>
+     *         </note>
      */
     ClientMetadata?: {
         [key: string]: string;
@@ -346,11 +382,13 @@ export declare namespace UpdateUserAttributesRequest {
     const filterSensitiveLog: (obj: UpdateUserAttributesRequest) => any;
 }
 /**
- * <p>Represents the response from the server for the request to update user attributes.</p>
+ * <p>Represents the response from the server for the request to update user
+ *             attributes.</p>
  */
 export interface UpdateUserAttributesResponse {
     /**
-     * <p>The code delivery details list from the server for the request to update user attributes.</p>
+     * <p>The code delivery details list from the server for the request to update user
+     *             attributes.</p>
      */
     CodeDeliveryDetailsList?: CodeDeliveryDetailsType[];
 }
@@ -377,7 +415,8 @@ export interface UpdateUserPoolRequest {
      */
     LambdaConfig?: LambdaConfigType;
     /**
-     * <p>The attributes that are automatically verified when Amazon Cognito requests to update user pools.</p>
+     * <p>The attributes that are automatically verified when Amazon Cognito requests to update user
+     *             pools.</p>
      */
     AutoVerifiedAttributes?: (VerifiedAttributeType | string)[];
     /**
@@ -401,22 +440,28 @@ export interface UpdateUserPoolRequest {
      */
     SmsAuthenticationMessage?: string;
     /**
-     * <p>Can be one of the following values:</p>
-     *
-     *          <ul>
+     * <p></p>
+     */
+    UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
+    /**
+     * <p>Possible values include:</p>
+     *         <ul>
      *             <li>
-     *                <p>
-     *                   <code>OFF</code> - MFA tokens aren't required and can't be specified during user registration.</p>
+     *                 <p>
+     *                     <code>OFF</code> - MFA tokens aren't required and can't be specified during user
+     *                     registration.</p>
      *             </li>
      *             <li>
-     *                <p>
-     *                   <code>ON</code> - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can
-     *             use the <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 user pools. </p>
+     *                 <p>
+     *                     <code>ON</code> - MFA tokens are required for all user registrations. You can
+     *                     only specify ON when you're initially creating a user pool. You can use the
+     *                         <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
+     *                     user pools. </p>
      *             </li>
      *             <li>
-     *                <p>
-     *                   <code>OPTIONAL</code> - Users have the option when registering to create an MFA token.</p>
+     *                 <p>
+     *                     <code>OPTIONAL</code> - Users have the option when registering to create an MFA
+     *                     token.</p>
      *             </li>
      *          </ul>
      */
@@ -439,8 +484,9 @@ export interface UpdateUserPoolRequest {
      */
     SmsConfiguration?: SmsConfigurationType;
     /**
-     * <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>
+     * <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>
      */
     UserPoolTags?: {
         [key: string]: string;
@@ -450,14 +496,17 @@ export interface UpdateUserPoolRequest {
      */
     AdminCreateUserConfig?: AdminCreateUserConfigType;
     /**
-     * <p>Enables advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
+     * <p>Enables advanced security risk detection. Set the key
+     *                 <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
      */
     UserPoolAddOns?: UserPoolAddOnsType;
     /**
-     * <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>
+     * <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>
      */
     AccountRecoverySetting?: AccountRecoverySettingType;
 }
@@ -468,7 +517,8 @@ export declare namespace UpdateUserPoolRequest {
     const filterSensitiveLog: (obj: UpdateUserPoolRequest) => any;
 }
 /**
- * <p>Represents the response from the server when you make a request to update the user pool.</p>
+ * <p>Represents the response from the server when you make a request to update the user
+ *             pool.</p>
  */
 export interface UpdateUserPoolResponse {
 }
@@ -483,7 +533,8 @@ export declare namespace UpdateUserPoolResponse {
  */
 export interface UpdateUserPoolClientRequest {
     /**
-     * <p>The user pool ID for the user pool where you want to update the user pool client.</p>
+     * <p>The user pool ID for the user pool where you want to update the user pool
+     *             client.</p>
      */
     UserPoolId: string | undefined;
     /**
@@ -495,19 +546,46 @@ export interface UpdateUserPoolClientRequest {
      */
     ClientName?: string;
     /**
-     * <p>The time limit, in days, after which the refresh token is no longer valid and can't be used.</p>
+     * <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>,
+     *         set a <code>TokenValidityUnits</code> value in your API request.</p>
+     *         <p>For example, when you set <code>RefreshTokenValidity</code> as <code>10</code> and
+     *         <code>TokenValidityUnits</code> as <code>days</code>, your user can refresh their session
+     *         and retrieve new access and ID tokens for 10 days.</p>
+     *         <p>The default time unit for <code>RefreshTokenValidity</code> in an API request is days.
+     *         You can't set <code>RefreshTokenValidity</code> to 0. If you do, Amazon Cognito overrides the
+     *         value with the default value of 30 days. <i>Valid range</i> is displayed below
+     *         in seconds.</p>
      */
     RefreshTokenValidity?: number;
     /**
-     * <p>The time limit after which the access token is no longer valid and can't be used.</p>
+     * <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>,
+     *         set a <code>TokenValidityUnits</code> value in your API request.</p>
+     *         <p>For example, when you set <code>AccessTokenValidity</code> to <code>10</code> and
+     *         <code>TokenValidityUnits</code> to <code>hours</code>, your user can authorize access with
+     *         their access token for 10 hours.</p>
+     *         <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours.
+     *         <i>Valid range</i> is displayed below in seconds.</p>
      */
     AccessTokenValidity?: number;
     /**
-     * <p>The time limit after which the ID token is no longer valid and can't be used.</p>
+     * <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>,
+     *         set a <code>TokenValidityUnits</code> value in your API request.</p>
+     *         <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and
+     *         <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their
+     *         session with their ID token for 10 hours.</p>
+     *         <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours.
+     *         <i>Valid range</i> is displayed below in seconds.</p>
      */
     IdTokenValidity?: number;
     /**
-     * <p>The units in which the validity times are represented. Default for RefreshToken is days, and default for ID and access tokens is hours.</p>
+     * <p>The units in which the validity times are represented. The default unit for
+     *             RefreshToken is days, and the default for ID and access tokens is hours.</p>
      */
     TokenValidityUnits?: TokenValidityUnitsType;
     /**
@@ -519,126 +597,159 @@ export interface UpdateUserPoolClientRequest {
      */
     WriteAttributes?: string[];
     /**
-     * <p>The authentication flows that are supported by the user pool clients. Flow names without the <code>ALLOW_</code> prefix are no longer supported in favor of new names with the
-     *             <code>ALLOW_</code> prefix. Note that values with <code>ALLOW_</code> prefix must be used only along with values with the <code>ALLOW_</code> prefix.</p>
+     * <p>The authentication flows that are supported by the user pool clients. Flow names
+     *             without the <code>ALLOW_</code> prefix are no longer supported in favor of new names
+     *             with the <code>ALLOW_</code> prefix. Note that values with <code>ALLOW_</code> prefix
+     *             must be used only along with values with the <code>ALLOW_</code> prefix.</p>
      *         <p>Valid values include:</p>
-     *          <ul>
+     *         <ul>
      *             <li>
-     *                <p>
-     *                   <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces the
-     *             <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to
-     *             verify passwords.</p>
+     *                 <p>
+     *                   <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password
+     *                     authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces
+     *                     the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, Amazon Cognito
+     *                     receives the password in the request instead of using the Secure Remote Password
+     *                     (SRP) protocol to verify passwords.</p>
      *             </li>
      *             <li>
-     *                <p>
-     *                   <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based authentication.</p>
+     *                 <p>
+     *                   <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based
+     *                     authentication.</p>
      *             </li>
      *             <li>
-     *                <p>
-     *                   <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP
-     *             protocol to verify passwords.</p>
+     *                 <p>
+     *                   <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based
+     *                     authentication. In this flow, Amazon Cognito receives the password in the request instead
+     *                     of using the SRP protocol to verify passwords.</p>
      *             </li>
      *             <li>
-     *                <p>
+     *                 <p>
      *                   <code>ALLOW_USER_SRP_AUTH</code>: Enable SRP-based authentication.</p>
      *             </li>
      *             <li>
-     *                <p>
-     *                   <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh tokens.</p>
+     *                 <p>
+     *                   <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh
+     *                     tokens.</p>
      *             </li>
      *          </ul>
      */
     ExplicitAuthFlows?: (ExplicitAuthFlowsType | string)[];
     /**
-     * <p>A list of provider names for the identity providers that are supported on this client.</p>
+     * <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>LoginWithAmazon</code>, and the names of your own SAML and OIDC providers.</p>
      */
     SupportedIdentityProviders?: string[];
     /**
-     * <p>A list of allowed redirect (callback) URLs for the identity providers.</p>
+     * <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
      *         <p>A redirect URI must:</p>
-     *          <ul>
+     *         <ul>
      *             <li>
-     *                <p>Be an absolute URI.</p>
+     *                 <p>Be an absolute URI.</p>
      *             </li>
      *             <li>
-     *                <p>Be registered with the authorization server.</p>
+     *                 <p>Be registered with the authorization server.</p>
      *             </li>
      *             <li>
-     *                <p>Not include a
-     *         fragment component.</p>
+     *                 <p>Not include a fragment component.</p>
      *             </li>
      *          </ul>
-     *         <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p>
-     *         <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p>
+     *         <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 -
+     *                 Redirection Endpoint</a>.</p>
+     *         <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>
      */
     CallbackURLs?: string[];
     /**
-     * <p>A list of allowed logout URLs for the identity providers.</p>
+     * <p>A list of allowed logout URLs for the IdPs.</p>
      */
     LogoutURLs?: string[];
     /**
      * <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>
      *         <p>A redirect URI must:</p>
-     *          <ul>
+     *         <ul>
      *             <li>
-     *                <p>Be an absolute URI.</p>
+     *                 <p>Be an absolute URI.</p>
      *             </li>
      *             <li>
-     *                <p>Be registered with the authorization server.</p>
+     *                 <p>Be registered with the authorization server.</p>
      *             </li>
      *             <li>
-     *                <p>Not include a
-     *         fragment component.</p>
+     *                 <p>Not include a fragment component.</p>
      *             </li>
      *          </ul>
-     *         <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p>
-     *         <p>Amazon Cognito requires HTTPS over HTTP except for <code>http://localhost</code> for testing purposes only.</p>
+     *         <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 -
+     *                 Redirection Endpoint</a>.</p>
+     *         <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>
      */
     DefaultRedirectURI?: string;
     /**
      * <p>The allowed OAuth flows.</p>
-     *         <p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p>
-     *         <p>Set to <code>implicit</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.</p>
-     *         <p>Set to <code>client_credentials</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination
-     *             of client and client_secret.</p>
+     *         <dl>
+     *             <dt>code</dt>
+     *             <dd>
+     *                     <p>Use a code grant flow, which provides an authorization code as the
+     *                         response. This code can be exchanged for access tokens with the
+     *                             <code>/oauth2/token</code> endpoint.</p>
+     *                 </dd>
+     *             <dt>implicit</dt>
+     *             <dd>
+     *                     <p>Issue the access token (and, optionally, ID token, based on scopes)
+     *                         directly to your user.</p>
+     *                 </dd>
+     *             <dt>client_credentials</dt>
+     *             <dd>
+     *                     <p>Issue the access token from the <code>/oauth2/token</code> endpoint
+     *                         directly to a non-person user using a combination of the client ID and
+     *                         client secret.</p>
+     *                 </dd>
+     *          </dl>
      */
     AllowedOAuthFlows?: (OAuthFlowType | string)[];
     /**
-     * <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
+     * <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>
      */
     AllowedOAuthScopes?: string[];
     /**
-     * <p>Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.</p>
+     * <p>Set to true if the client is allowed to follow the OAuth protocol when interacting
+     *             with Amazon Cognito user pools.</p>
      */
     AllowedOAuthFlowsUserPoolClient?: boolean;
     /**
-     * <p>The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.</p>
-     *          <note>
-     *             <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending 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>
+     * <p>The Amazon Pinpoint analytics configuration necessary to collect metrics for this user
+     *             pool.</p>
+     *         <note>
+     *             <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending
+     *                 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>
      */
     AnalyticsConfiguration?: AnalyticsConfigurationType;
     /**
-     * <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 indicating either the username or password was incorrect.
-     *             Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs
-     *             return a <code>UserNotFoundException</code> exception if the user doesn't exist in the user pool.</p>
+     * <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
+     *             indicating either the username or password was incorrect. Account confirmation and
+     *             password recovery return a response indicating a code was sent to a simulated
+     *             destination. When set to <code>LEGACY</code>, those APIs return a
+     *                 <code>UserNotFoundException</code> exception if the user doesn't exist in the user
+     *             pool.</p>
      *         <p>Valid values include:</p>
-     *          <ul>
+     *         <ul>
      *             <li>
-     *                <p>
+     *                 <p>
      *                   <code>ENABLED</code> - This prevents user existence-related errors.</p>
      *             </li>
      *             <li>
-     *                <p>
-     *                   <code>LEGACY</code> - This represents the early
-     *         behavior of Amazon Cognito where user existence related errors aren't prevented.</p>
+     *                 <p>
+     *                   <code>LEGACY</code> - This represents the early behavior of Amazon Cognito where user
+     *                     existence related errors aren't prevented.</p>
      *             </li>
      *          </ul>
      */
@@ -656,11 +767,13 @@ export declare namespace UpdateUserPoolClientRequest {
     const filterSensitiveLog: (obj: UpdateUserPoolClientRequest) => any;
 }
 /**
- * <p>Represents the response from the server to the request to update the user pool client.</p>
+ * <p>Represents the response from the server to the request to update the user pool
+ *             client.</p>
  */
 export interface UpdateUserPoolClientResponse {
     /**
-     * <p>The user pool client value from the response from the server when you request to update the user pool client.</p>
+     * <p>The user pool client value from the response from the server when you request to
+     *             update the user pool client.</p>
      */
     UserPoolClient?: UserPoolClientType;
 }
@@ -675,16 +788,21 @@ export declare namespace UpdateUserPoolClientResponse {
  */
 export interface UpdateUserPoolDomainRequest {
     /**
-     * <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>
+     * <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>
      */
     Domain: string | undefined;
     /**
-     * <p>The ID of the user pool that is associated with the custom domain whose certificate you're updating.</p>
+     * <p>The ID of the user pool that is associated with the custom domain whose certificate
+     *             you're updating.</p>
      */
     UserPoolId: string | undefined;
     /**
-     * <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>
+     * <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>
      */
     CustomDomainConfig: CustomDomainConfigType | undefined;
 }
@@ -699,7 +817,8 @@ export declare namespace UpdateUserPoolDomainRequest {
  */
 export interface UpdateUserPoolDomainResponse {
     /**
-     * <p>The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.</p>
+     * <p>The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user
+     *             pool.</p>
      */
     CloudFrontDomain?: string;
 }
@@ -710,7 +829,8 @@ export declare namespace UpdateUserPoolDomainResponse {
     const filterSensitiveLog: (obj: UpdateUserPoolDomainResponse) => any;
 }
 /**
- * <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>
+ * <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>
  */
 export declare class EnableSoftwareTokenMFAException extends __BaseException {
     readonly name: "EnableSoftwareTokenMFAException";
@@ -722,16 +842,17 @@ export declare class EnableSoftwareTokenMFAException extends __BaseException {
 }
 export interface VerifySoftwareTokenRequest {
     /**
-     * <p>The access token.</p>
+     * <p>A valid access token that Amazon Cognito issued to the user whose software token you want to
+     *             verify.</p>
      */
     AccessToken?: string;
     /**
-     * <p>The session that should be passed both ways in challenge-response calls to the service.</p>
+     * <p>The session that should be passed both ways in challenge-response calls to the
+     *             service.</p>
      */
     Session?: string;
     /**
-     * <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>
+     * <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>
      */
     UserCode: string | undefined;
     /**
@@ -755,7 +876,8 @@ export interface VerifySoftwareTokenResponse {
      */
     Status?: VerifySoftwareTokenResponseType | string;
     /**
-     * <p>The session that should be passed both ways in challenge-response calls to the service.</p>
+     * <p>The session that should be passed both ways in challenge-response calls to the
+     *             service.</p>
      */
     Session?: string;
 }
@@ -770,7 +892,8 @@ export declare namespace VerifySoftwareTokenResponse {
  */
 export interface VerifyUserAttributeRequest {
     /**
-     * <p>The access token of the request to verify user attributes.</p>
+     * <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to
+     *             verify.</p>
      */
     AccessToken: string | undefined;
     /**
@@ -789,7 +912,8 @@ export declare namespace VerifyUserAttributeRequest {
     const filterSensitiveLog: (obj: VerifyUserAttributeRequest) => any;
 }
 /**
- * <p>A container representing the response from the server from the request to verify user attributes.</p>
+ * <p>A container representing the response from the server from the request to verify user
+ *             attributes.</p>
  */
 export interface VerifyUserAttributeResponse {
 }