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

package/dist-types/commands/RevokeTokenCommand.d.ts

@@ -7,7 +7,9 @@ export interface RevokeTokenCommandInput extends RevokeTokenRequest {
 export interface RevokeTokenCommandOutput extends RevokeTokenResponse, __MetadataBearer {
 }
 /**
- * <p>Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can't use the revoked token to access Amazon Cognito authenticated APIs.</p>
+ * <p>Revokes all of the access tokens generated by the specified refresh token. After the
+ *             token is revoked, you can't use the revoked token to access Amazon Cognito authenticated
+ *             APIs.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/SetRiskConfigurationCommand.d.ts

@@ -7,8 +7,11 @@ export interface SetRiskConfigurationCommandInput extends SetRiskConfigurationRe
 export interface SetRiskConfigurationCommandOutput extends SetRiskConfigurationResponse, __MetadataBearer {
 }
 /**
- * <p>Configures actions on detected risks. To delete the risk configuration for <code>UserPoolId</code> or <code>ClientId</code>, pass null values for all four configuration types.</p>
- *         <p>To activate Amazon Cognito advanced security features, update the user pool to include the <code>UserPoolAddOns</code> key<code>AdvancedSecurityMode</code>.</p>
+ * <p>Configures actions on detected risks. To delete the risk configuration for
+ *                 <code>UserPoolId</code> or <code>ClientId</code>, pass null values for all four
+ *             configuration types.</p>
+ *         <p>To activate Amazon Cognito advanced security features, update the user pool to include the
+ *                 <code>UserPoolAddOns</code> key<code>AdvancedSecurityMode</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/SetUICustomizationCommand.d.ts

@@ -7,13 +7,19 @@ export interface SetUICustomizationCommandInput extends SetUICustomizationReques
 export interface SetUICustomizationCommandOutput extends SetUICustomizationResponse, __MetadataBearer {
 }
 /**
- * <p>Sets the user interface (UI) customization information for a user pool's built-in app UI.</p>
- *         <p>You can specify app UI customization settings for a single client (with a specific <code>clientId</code>) or for all clients (by setting the <code>clientId</code>
- *             to <code>ALL</code>). If you specify <code>ALL</code>, the default configuration is used for every client that has no previously set UI customization. If you specify UI
- *             customization settings for a particular client, it will no longer return to the <code>ALL</code> configuration.</p>
- *          <note>
- *             <p>To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.</p>
- *          </note>
+ * <p>Sets the user interface (UI) customization information for a user pool's built-in app
+ *             UI.</p>
+ *         <p>You can specify app UI customization settings for a single client (with a specific
+ *                 <code>clientId</code>) or for all clients (by setting the <code>clientId</code> to
+ *                 <code>ALL</code>). If you specify <code>ALL</code>, the default configuration is
+ *             used for every client that has no previously set UI customization. If you specify UI
+ *             customization settings for a particular client, it will no longer return to the
+ *                 <code>ALL</code> configuration.</p>
+ *         <note>
+ *             <p>To use this API, your user pool must have a domain associated with it. Otherwise,
+ *                 there is no place to host the app's pages, and the service will throw an
+ *                 error.</p>
+ *         </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts

@@ -7,11 +7,14 @@ export interface SetUserMFAPreferenceCommandInput extends SetUserMFAPreferenceRe
 export interface SetUserMFAPreferenceCommandOutput extends SetUserMFAPreferenceResponse, __MetadataBearer {
 }
 /**
- * <p>Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred.
- *             Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated.
- *             If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an
- *             MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and
- *             the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate
+ * <p>Set the user's multi-factor authentication (MFA) method preference, including which
+ *             MFA factors are activated and if any are preferred. Only one factor can be set as
+ *             preferred. The preferred MFA factor will be used to authenticate a user if multiple
+ *             factors are activated. If multiple options are activated and no preference is set, a
+ *             challenge to choose an MFA option will be returned during sign-in. If an MFA type is
+ *             activated for a user, the user will be prompted for MFA during all sign-in attempts
+ *             unless device tracking is turned on and the device has been trusted. If you want MFA to
+ *             be applied selectively based on the assessed risk level of sign-in attempts, deactivate
  *             MFA for users and turn on Adaptive Authentication for the user pool.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/SetUserSettingsCommand.d.ts

@@ -8,8 +8,9 @@ export interface SetUserSettingsCommandOutput extends SetUserSettingsResponse, _
 }
 /**
  * <p>
- *             <i>This action is no longer supported.</i> You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA.
- *             To configure either type of MFA, use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html">SetUserMFAPreference</a> instead.</p>
+ *             <i>This action is no longer supported.</i> You can use it to configure
+ *             only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software
+ *             token MFA. To configure either type of MFA, use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html">SetUserMFAPreference</a> instead.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/SignUpCommand.d.ts

@@ -7,7 +7,8 @@ export interface SignUpCommandInput extends SignUpRequest {
 export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
 }
 /**
- * <p>Registers the user in the specified user pool and creates a user name, password, and user attributes.</p>
+ * <p>Registers the user in the specified user pool and creates a user name, password, and
+ *             user attributes.</p>
  *
  *          <note>
  *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers

package/dist-types/commands/StartUserImportJobCommand.d.ts

@@ -1,8 +1,7 @@
 import { Command as $Command } from "@aws-sdk/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
 import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
-import { StartUserImportJobRequest } from "../models/models_0";
-import { StartUserImportJobResponse } from "../models/models_1";
+import { StartUserImportJobRequest, StartUserImportJobResponse } from "../models/models_1";
 export interface StartUserImportJobCommandInput extends StartUserImportJobRequest {
 }
 export interface StartUserImportJobCommandOutput extends StartUserImportJobResponse, __MetadataBearer {

package/dist-types/commands/TagResourceCommand.d.ts

@@ -7,13 +7,20 @@ export interface TagResourceCommandInput extends TagResourceRequest {
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
- * <p>Assigns a set of tags to an Amazon Cognito 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>Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool,
- *             one for testing and another for production, you might assign an <code>Environment</code> tag key to both user pools. The value of this key might be <code>Test</code> for
- *             one user pool, and <code>Production</code> for the other.</p>
- *         <p>Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with
- *             your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.</p>
- *         <p>You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.</p>
+ * <p>Assigns a set of tags to an Amazon Cognito 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>Each tag consists of a key and value, both of which you define. A key is a general
+ *             category for more specific values. For example, if you have two versions of a user pool,
+ *             one for testing and another for production, you might assign an <code>Environment</code>
+ *             tag key to both user pools. The value of this key might be <code>Test</code> for one
+ *             user pool, and <code>Production</code> for the other.</p>
+ *         <p>Tags are useful for cost tracking and access control. You can activate your tags so
+ *             that they appear on the Billing and Cost Management console, where you can track the
+ *             costs associated with your user pools. In an Identity and Access Management policy, you can constrain
+ *             permissions for user pools based on specific tags or tag values.</p>
+ *         <p>You can use this action up to 5 times per second, per account. A user pool can have as
+ *             many as 50 tags.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -7,7 +7,8 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
- * <p>Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.</p>
+ * <p>Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5
+ *             times per second, per account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts

@@ -7,8 +7,9 @@ export interface UpdateAuthEventFeedbackCommandInput extends UpdateAuthEventFeed
 export interface UpdateAuthEventFeedbackCommandOutput extends UpdateAuthEventFeedbackResponse, __MetadataBearer {
 }
 /**
- * <p>Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part
- *             of Amazon Cognito advanced security.</p>
+ * <p>Provides the feedback for an authentication event, whether it was from a valid user or
+ *             not. This feedback is used for improving the risk evaluation decision for the user pool
+ *             as part of Amazon Cognito advanced security.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateIdentityProviderCommand.d.ts

@@ -7,7 +7,7 @@ export interface UpdateIdentityProviderCommandInput extends UpdateIdentityProvid
 export interface UpdateIdentityProviderCommandOutput extends UpdateIdentityProviderResponse, __MetadataBearer {
 }
 /**
- * <p>Updates identity provider information for a user pool.</p>
+ * <p>Updates IdP information for a user pool.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateResourceServerCommand.d.ts

@@ -8,9 +8,10 @@ export interface UpdateResourceServerCommandOutput extends UpdateResourceServerR
 }
 /**
  * <p>Updates the name and scopes of resource server. All other fields are read-only.</p>
- *          <important>
- *             <p>If you don't provide a value for an attribute, it is set to the default value.</p>
- *          </important>
+ *         <important>
+ *             <p>If you don't provide a value for an attribute, it is set to the default
+ *                 value.</p>
+ *         </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateUserPoolClientCommand.d.ts

@@ -7,13 +7,14 @@ export interface UpdateUserPoolClientCommandInput extends UpdateUserPoolClientRe
 export interface UpdateUserPoolClientCommandOutput extends UpdateUserPoolClientResponse, __MetadataBearer {
 }
 /**
- * <p>Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using
- *             <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a>.</p>
- *          <important>
- *             <p>If you don't provide a value for an attribute, it will be set to the default value.</p>
- *          </important>
- *         <p>You can also use this operation to enable token revocation for user pool clients. 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>
+ * <p>Updates the specified user pool app client with the specified attributes. You can get
+ *             a list of the current user pool app client settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a>.</p>
+ *         <important>
+ *             <p>If you don't provide a value for an attribute, it will be set to the default
+ *                 value.</p>
+ *         </important>
+ *         <p>You can also use this operation to enable token revocation for user pool clients. 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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateUserPoolCommand.d.ts

@@ -7,9 +7,10 @@ export interface UpdateUserPoolCommandInput extends UpdateUserPoolRequest {
 export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __MetadataBearer {
 }
 /**
- * <p>Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using
- *             <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.
- *             If you don't provide a value for an attribute, it will be set to the default value.</p>
+ * <p>Updates the specified user pool with the specified attributes. You can get a list of
+ *             the current user pool settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>. If you don't provide a value for an attribute, it will be
+ *             set to the default value.
+ *         </p>
  *
  *          <note>
  *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers

package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts

@@ -7,18 +7,25 @@ export interface UpdateUserPoolDomainCommandInput extends UpdateUserPoolDomainRe
 export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainResponse, __MetadataBearer {
 }
 /**
- * <p>Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.</p>
- *         <p>You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool.</p>
- *         <p>A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you
- *             manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.</p>
- *         <p>Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same,
- *             and your custom domain uses the new certificate automatically.</p>
- *         <p>However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide
- *             this ARN to Amazon Cognito.</p>
- *         <p>When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.</p>
- *         <p>After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.</p>
- *         <p>For more information about adding a custom domain to your user pool,
- *             see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html">Using Your Own Domain for the Hosted UI</a>.</p>
+ * <p>Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user
+ *             pool.</p>
+ *         <p>You can use this operation to provide the Amazon Resource Name (ARN) of a new
+ *             certificate to Amazon Cognito. You can't use it to change the domain for a user pool.</p>
+ *         <p>A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and
+ *             sign-in pages for your application. When you set up a custom domain, you provide a
+ *             certificate that you manage with Certificate Manager (ACM). When necessary, you can use this
+ *             operation to change the certificate that you applied to your custom domain.</p>
+ *         <p>Usually, this is unnecessary following routine certificate renewal with ACM. When
+ *             you renew your existing certificate in ACM, the ARN for your certificate remains the
+ *             same, and your custom domain uses the new certificate automatically.</p>
+ *         <p>However, if you replace your existing certificate with a new one, ACM gives the new
+ *             certificate a new ARN. To apply the new certificate to your custom domain, you must
+ *             provide this ARN to Amazon Cognito.</p>
+ *         <p>When you add your new certificate in ACM, you must choose US East (N. Virginia) as
+ *             the Amazon Web Services Region.</p>
+ *         <p>After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new
+ *             certificate to your custom domain.</p>
+ *         <p>For more information about adding a custom domain to your user pool, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html">Using Your Own Domain for the Hosted UI</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/VerifySoftwareTokenCommand.d.ts

@@ -7,8 +7,9 @@ export interface VerifySoftwareTokenCommandInput extends VerifySoftwareTokenRequ
 export interface VerifySoftwareTokenCommandOutput extends VerifySoftwareTokenResponse, __MetadataBearer {
 }
 /**
- * <p>Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access
- *             token or a session string, but not both.</p>
+ * <p>Use this API to register a user's entered time-based one-time password (TOTP) code and
+ *             mark the user's software token MFA status as "verified" if successful. The request takes
+ *             an access token or a session string, but not both.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/VerifyUserAttributeCommand.d.ts

@@ -8,6 +8,12 @@ export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeRes
 }
 /**
  * <p>Verifies the specified user attributes in the user pool.</p>
+ *         <p>
+ *             If your user pool requires verification before Amazon Cognito updates the attribute value,
+ *             VerifyUserAttribute updates the affected attribute to its pending value. For more information,
+ *             see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserAttributeUpdateSettingsType.html">
+ *             UserAttributeUpdateSettingsType</a>.
+ *         </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript