@aws-sdk/client-cognito-identity-provider 3.363.0 → 3.369.0

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

@@ -24,7 +24,7 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
 /**
  * @public
  * <p>Creates a new group in the specified user pool.</p>
- *         <p>Calling this action requires developer credentials.</p>
+ *          <p>Calling this action requires developer credentials.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -24,7 +24,7 @@ export interface CreateUserPoolClientCommandOutput extends CreateUserPoolClientR
 /**
  * @public
  * <p>Creates the user pool client.</p>
- *         <p>When you create a new user pool client, token revocation is automatically activated.
+ *          <p>When you create a new user pool client, token revocation is automatically activated.
  *             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.

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

@@ -25,7 +25,6 @@ export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __M
  * @public
  * <p>Creates a new Amazon Cognito user pool and sets the password policy for the
  *             pool.</p>
- *
  *          <note>
  *             <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

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

@@ -24,7 +24,7 @@ export interface DeleteGroupCommandOutput extends __MetadataBearer {
 /**
  * @public
  * <p>Deletes a group.</p>
- *         <p>Calling this action requires developer credentials.</p>
+ *          <p>Calling this action requires developer credentials.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -31,7 +31,6 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M
  *             neither a verified phone number nor a verified email exists, an
  *                 <code>InvalidParameterException</code> is thrown. To use the confirmation code for
  *             resetting the password, call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>. </p>
- *
  *          <note>
  *             <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

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

@@ -24,7 +24,7 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare
 /**
  * @public
  * <p>Gets a group.</p>
- *         <p>Calling this action requires developer credentials.</p>
+ *          <p>Calling this action requires developer credentials.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -24,7 +24,7 @@ export interface GetSigningCertificateCommandOutput extends GetSigningCertificat
 /**
  * @public
  * <p>This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.</p>
- *         <p>Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to <code>GetSigningCertificate</code>,
+ *          <p>Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to <code>GetSigningCertificate</code>,
  *             but doesn't invalidate the original certificate.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -26,7 +26,6 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
  * <p>Generates a user attribute verification code for the specified attribute name. Sends a
  *             message to a user with a code that they must return in a VerifyUserAttribute
  *             request.</p>
- *
  *          <note>
  *             <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

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

@@ -25,7 +25,6 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
  * @public
  * <p>Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user
  *             with a federated IdP with <code>InitiateAuth</code>. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html"> Adding user pool sign-in through a third party</a>.</p>
- *
  *          <note>
  *             <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

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

@@ -24,7 +24,7 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
 /**
  * @public
  * <p>Lists the groups associated with a user pool.</p>
- *         <p>Calling this action requires developer credentials.</p>
+ *          <p>Calling this action requires developer credentials.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -24,9 +24,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 /**
  * @public
  * <p>Lists the tags that are assigned to an Amazon Cognito user pool.</p>
- *         <p>A tag is a label that you can apply to user pools to categorize and manage them in
+ *          <p>A tag is a label that you can apply to user pools to categorize and manage them in
  *             different ways, such as by purpose, owner, environment, or other criteria.</p>
- *         <p>You can use this action up to 10 times per second, per account.</p>
+ *          <p>You can use this action up to 10 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/ListUsersInGroupCommand.d.ts

@@ -24,7 +24,7 @@ export interface ListUsersInGroupCommandOutput extends ListUsersInGroupResponse,
 /**
  * @public
  * <p>Lists the users in the specified group.</p>
- *         <p>Calling this action requires developer credentials.</p>
+ *          <p>Calling this action requires developer credentials.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -25,7 +25,6 @@ export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationC
  * @public
  * <p>Resends the confirmation (for confirmation of registration) to a specific user in the
  *             user pool.</p>
- *
  *          <note>
  *             <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

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

@@ -24,7 +24,6 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle
 /**
  * @public
  * <p>Responds to the authentication challenge.</p>
- *
  *          <note>
  *             <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

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

@@ -26,7 +26,7 @@ export interface SetRiskConfigurationCommandOutput extends SetRiskConfigurationR
  * <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
+ *          <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.

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

@@ -25,17 +25,17 @@ export interface SetUICustomizationCommandOutput extends SetUICustomizationRespo
  * @public
  * <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
+ *          <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>
+ *          <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>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -24,7 +24,6 @@ export interface SetUserPoolMfaConfigCommandOutput extends SetUserPoolMfaConfigR
 /**
  * @public
  * <p>Sets the user pool multi-factor authentication (MFA) configuration.</p>
- *
  *          <note>
  *             <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

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

@@ -25,7 +25,6 @@ export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
  * @public
  * <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
  *                 require you to register an origination phone number before you can send SMS messages

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

@@ -26,16 +26,16 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * <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
+ *          <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
+ *          <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
+ *          <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.

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

@@ -24,7 +24,7 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __Metadat
 /**
  * @public
  * <p>Updates the specified group with the specified attributes.</p>
- *         <p>Calling this action requires developer credentials.</p>
+ *          <p>Calling this action requires developer credentials.</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

@@ -24,10 +24,10 @@ export interface UpdateResourceServerCommandOutput extends UpdateResourceServerR
 /**
  * @public
  * <p>Updates the name and scopes of resource server. All other fields are read-only.</p>
- *         <important>
+ *          <important>
  *             <p>If you don't provide a value for an attribute, it is set to the default
  *                 value.</p>
- *         </important>
+ *          </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

@@ -24,7 +24,6 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
 /**
  * @public
  * <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, US telecom carriers
  *                 require you to register an origination phone number before you can send SMS messages

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

@@ -25,11 +25,11 @@ export interface UpdateUserPoolClientCommandOutput extends UpdateUserPoolClientR
  * @public
  * <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>
+ *          <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
+ *          </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.

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

@@ -27,7 +27,6 @@ export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __M
  *             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
  *                 require you to register an origination phone number before you can send SMS messages

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

@@ -25,23 +25,23 @@ export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainR
  * @public
  * <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
+ *          <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
+ *          <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
+ *          <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
+ *          <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
+ *          <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
+ *          <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>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/VerifyUserAttributeCommand.d.ts

@@ -24,7 +24,7 @@ export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeRes
 /**
  * @public
  * <p>Verifies the specified user attributes in the user pool.</p>
- *         <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">

package/dist-types/index.d.ts

@@ -2,8 +2,8 @@
  * <p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and
  *             users. You can authenticate a user to obtain tokens related to user identity and access
  *             policies.</p>
- *         <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
- *         <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
+ *          <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
+ *          <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
  *                 Documentation</a>.</p>
  *
  * @packageDocumentation