@aws-sdk/client-cognito-identity-provider 3.382.0 → 3.383.0

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

@@ -23,11 +23,7 @@ export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __M
 }
 /**
  * @public
- * <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>
+ * <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
  *                 to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
@@ -41,9 +37,34 @@ export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __M
  *                         mode</a>
  *                </i>, you can send messages only to verified phone
  *                 numbers. After you test your app while in the sandbox environment, you can move out
- *                 of the 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
+ *                 of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
  *                     Developer Guide</i>.</p>
  *          </note>
+ *          <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>.</p>
+ *          <important>
+ *             <p>If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.</p>
+ *          </important>
+ *          <note>
+ *             <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
+ *             this operation, you must use IAM credentials to authorize requests, and you must
+ *             grant yourself the corresponding IAM permission in a policy.</p>
+ *             <p class="title">
+ *                <b>Learn more</b>
+ *             </p>
+ *             <ul>
+ *                <li>
+ *                   <p>
+ *                      <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
+ *                   </p>
+ *                </li>
+ *                <li>
+ *                   <p>
+ *                      <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
+ *                   </p>
+ *                </li>
+ *             </ul>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -179,7 +200,7 @@ export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __M
  * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
  *  <p>This exception is thrown when the trust relationship is not valid for the role
  *             provided for SMS configuration. This can happen if you don't trust
- *             <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
+ *                 <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
  *             not match what is provided in the SMS configuration for the user pool.</p>
  *
  * @throws {@link NotAuthorizedException} (client fault)

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

@@ -42,6 +42,26 @@ export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainR
  *          <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>
+ *          <note>
+ *             <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
+ *             this operation, you must use IAM credentials to authorize requests, and you must
+ *             grant yourself the corresponding IAM permission in a policy.</p>
+ *             <p class="title">
+ *                <b>Learn more</b>
+ *             </p>
+ *             <ul>
+ *                <li>
+ *                   <p>
+ *                      <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
+ *                   </p>
+ *                </li>
+ *                <li>
+ *                   <p>
+ *                      <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
+ *                   </p>
+ *                </li>
+ *             </ul>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,6 +26,12 @@ export interface VerifySoftwareTokenCommandOutput extends VerifySoftwareTokenRes
  * <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>
+ *          <note>
+ *             <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
+ *             this operation, you can't use IAM credentials to authorize requests, and you can't
+ *             grant IAM permissions in policies. For more information about authorization models in
+ *             Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -62,7 +68,8 @@ export interface VerifySoftwareTokenCommandOutput extends VerifySoftwareTokenRes
  *             configure the software token TOTP multi-factor authentication (MFA).</p>
  *
  * @throws {@link ForbiddenException} (client fault)
- *  <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
+ *  <p>This exception is thrown when WAF doesn't allow your request based on a web
+ *             ACL that's associated with your user pool.</p>
  *
  * @throws {@link InternalErrorException} (server fault)
  *  <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>

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

@@ -24,12 +24,15 @@ export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeRes
 /**
  * @public
  * <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>
+ *          <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>
+ *          <note>
+ *             <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
+ *             this operation, you can't use IAM credentials to authorize requests, and you can't
+ *             grant IAM permissions in policies. For more information about authorization models in
+ *             Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -55,8 +58,8 @@ export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeRes
  *
  * @throws {@link AliasExistsException} (client fault)
  *  <p>This exception is thrown when a user tries to confirm the account with an email
- *             address or phone number that has already been supplied as an alias for a different
- *             user profile. This exception indicates that an account with this email address or phone
+ *             address or phone number that has already been supplied as an alias for a different user
+ *             profile. This exception indicates that an account with this email address or phone
  *             already exists in a user pool that you've configured to use email address or phone
  *             number as a sign-in alias.</p>
  *
@@ -68,7 +71,8 @@ export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeRes
  *  <p>This exception is thrown if a code has expired.</p>
  *
  * @throws {@link ForbiddenException} (client fault)
- *  <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
+ *  <p>This exception is thrown when WAF doesn't allow your request based on a web
+ *             ACL that's associated with your user pool.</p>
  *
  * @throws {@link InternalErrorException} (server fault)
  *  <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>

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

@@ -58,6 +58,7 @@ export * from "./GetCSVHeaderCommand";
 export * from "./GetDeviceCommand";
 export * from "./GetGroupCommand";
 export * from "./GetIdentityProviderByIdentifierCommand";
+export * from "./GetLogDeliveryConfigurationCommand";
 export * from "./GetSigningCertificateCommand";
 export * from "./GetUICustomizationCommand";
 export * from "./GetUserAttributeVerificationCodeCommand";
@@ -78,6 +79,7 @@ export * from "./ListUsersInGroupCommand";
 export * from "./ResendConfirmationCodeCommand";
 export * from "./RespondToAuthChallengeCommand";
 export * from "./RevokeTokenCommand";
+export * from "./SetLogDeliveryConfigurationCommand";
 export * from "./SetRiskConfigurationCommand";
 export * from "./SetUICustomizationCommand";
 export * from "./SetUserMFAPreferenceCommand";

package/dist-types/index.d.ts

@@ -1,10 +1,71 @@
 /**
- * <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
- *                 Documentation</a>.</p>
+ * <p>With the Amazon Cognito user pools API, you can set up user pools and app clients, and
+ *             authenticate users. To authenticate users from third-party identity providers (IdPs) in
+ *             this API, you can <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html">link IdP users to native user profiles</a>. Learn more
+ *             about the authentication and authorization of federated users in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
+ *          <p>This API reference provides detailed information about API operations and object types
+ *             in Amazon Cognito. At the bottom of the page for each API operation and object, under
+ *                 <i>See Also</i>, you can learn how to use it in an Amazon Web Services SDK in the
+ *             language of your choice.</p>
+ *          <p>Along with resource management operations, the Amazon Cognito user pools API includes classes
+ *             of operations and authorization models for client-side and server-side user operations.
+ *             For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a> in the
+ *                 <i>Amazon Cognito Developer Guide</i>.</p>
+ *          <p>You can also start reading about the <code>CognitoIdentityProvider</code> client in
+ *             the following SDK guides.</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/index.html#cli-aws-cognito-idp">Amazon Web Services
+ *                         Command Line Interface</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CognitoIdentityProvider/TCognitoIdentityProviderClient.html">Amazon Web Services SDK for .NET</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-cognito-idp/html/class_aws_1_1_cognito_identity_provider_1_1_cognito_identity_provider_client.html">Amazon Web Services SDK for C++</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/#CognitoIdentityProvider">Amazon Web Services SDK for Go</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentityprovider/CognitoIdentityProviderClient.html">Amazon Web Services SDK for Java V2</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CognitoIdentityServiceProvider.html">Amazon Web Services
+ *                         SDK for JavaScript</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html">Amazon Web Services SDK for PHP
+ *                         V3</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html">Amazon Web Services SDK for Python</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html">Amazon Web Services SDK
+ *                         for Ruby V3</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>To get started with an Amazon Web Services SDK, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>. For example actions and scenarios, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/service_code_examples_cognito-identity-provider.html">Code examples for Amazon Cognito Identity Provider using Amazon Web Services
+ *                 SDKs</a>.</p>
  *
  * @packageDocumentation
  */