@aws-sdk/client-cognito-identity-provider 3.48.0 → 3.52.0

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

@@ -7,9 +7,8 @@ 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/UpdateResourceServerCommand.d.ts

@@ -8,10 +8,9 @@ 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 will be 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/UpdateUserAttributesCommand.d.ts

@@ -9,21 +9,22 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
 /**
  * <p>Allows a user to update a specific attribute (one at a time).</p>
  *
+ *
  *         <note>
- *             <p>This action might generate an SMS text message. Starting June 1, 2021, U.S.
- *                 telecom carriers require that you register an origination phone number before you can
- *                 send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito,
- *                 you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
- *                 Cognito  will use the the registered number automatically. Otherwise, Cognito users that must
- *                 receive SMS messages might be unable to sign up, activate their accounts, or sign
- *                 in.</p>
- *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In <i>
- *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
- *                     mode</a>
- *                </i>, you’ll have limitations, such as sending messages
- *                 to only verified phone numbers. After testing in the sandbox environment, you can
- *                 move out of the SMS sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Cognito User Pools</a> in the <i>Amazon
- *                         Cognito Developer Guide</i>. </p>
+ *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
+ *             origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
+ *             register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
+ *             automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
+ *             or sign in.</p>
+ *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
+ *                 might place your account in SMS sandbox. In
+ *                 <i>
+ *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
+ *                </i>, you will have
+ *                 limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
+ *                 out of the SMS sandbox and into production. For more information, see
+ *                 <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
+ *                     message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
  *         </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -7,14 +7,13 @@ 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,25 +7,26 @@ 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, U.S.
- *                 telecom carriers require that you register an origination phone number before you can
- *                 send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito,
- *                 you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
- *                 Cognito  will use the the registered number automatically. Otherwise, Cognito users that must
- *                 receive SMS messages might be unable to sign up, activate their accounts, or sign
- *                 in.</p>
- *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In <i>
- *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
- *                     mode</a>
- *                </i>, you’ll have limitations, such as sending messages
- *                 to only verified phone numbers. After testing in the sandbox environment, you can
- *                 move out of the SMS sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Cognito User Pools</a> in the <i>Amazon
- *                         Cognito Developer Guide</i>. </p>
+ *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
+ *             origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
+ *             register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
+ *             automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
+ *             or sign in.</p>
+ *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
+ *                 might place your account in SMS sandbox. In
+ *                 <i>
+ *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
+ *                </i>, you will have
+ *                 limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
+ *                 out of the SMS sandbox and into production. For more information, see
+ *                 <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
+ *                     message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
  *         </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -7,27 +7,18 @@ 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 cannot 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,
+ * <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
- *             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>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,9 +7,8 @@ export interface VerifySoftwareTokenCommandInput extends VerifySoftwareTokenRequ
 export interface VerifySoftwareTokenCommandOutput extends VerifySoftwareTokenResponse, __MetadataBearer {
 }
 /**
- * <p>Use this API to register a user's entered 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