@aws-sdk/client-cognito-identity-provider 3.473.0 → 3.476.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/README.md +28 -12
  2. package/dist-cjs/commands/SetRiskConfigurationCommand.js +1 -2
  3. package/dist-cjs/models/models_0.js +7 -8
  4. package/dist-cjs/models/models_1.js +6 -1
  5. package/dist-es/commands/SetRiskConfigurationCommand.js +1 -2
  6. package/dist-es/models/models_0.js +4 -4
  7. package/dist-es/models/models_1.js +4 -0
  8. package/dist-types/CognitoIdentityProvider.d.ts +28 -12
  9. package/dist-types/CognitoIdentityProviderClient.d.ts +28 -12
  10. package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +3 -1
  11. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +9 -2
  12. package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +1 -1
  13. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +7 -1
  14. package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +24 -8
  15. package/dist-types/commands/ConfirmSignUpCommand.d.ts +12 -1
  16. package/dist-types/commands/CreateUserPoolCommand.d.ts +8 -0
  17. package/dist-types/commands/DescribeUserPoolCommand.d.ts +4 -0
  18. package/dist-types/commands/GlobalSignOutCommand.d.ts +24 -8
  19. package/dist-types/commands/ListUserPoolsCommand.d.ts +4 -0
  20. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +7 -1
  21. package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +2 -1
  22. package/dist-types/commands/SetRiskConfigurationCommand.d.ts +1 -2
  23. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +5 -1
  24. package/dist-types/commands/UpdateUserPoolCommand.d.ts +4 -0
  25. package/dist-types/index.d.ts +28 -12
  26. package/dist-types/models/models_0.d.ts +421 -230
  27. package/dist-types/models/models_1.d.ts +96 -6
  28. package/dist-types/ts3.4/commands/SetLogDeliveryConfigurationCommand.d.ts +2 -4
  29. package/dist-types/ts3.4/commands/SetRiskConfigurationCommand.d.ts +4 -2
  30. package/dist-types/ts3.4/models/models_0.d.ts +11 -13
  31. package/dist-types/ts3.4/models/models_1.d.ts +17 -0
  32. package/package.json +4 -4
@@ -1,18 +1,34 @@
1
1
  /**
2
- * <p>With the Amazon Cognito user pools API, you can set up user pools and app clients, and
3
- * authenticate users. To authenticate users from third-party identity providers (IdPs) in
4
- * 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
5
- * 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>
2
+ * <p>With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To
3
+ * authenticate users from third-party identity providers (IdPs) in this API, you can
4
+ * <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
5
+ * about the authentication and authorization of federated users at <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> and in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html">User pool federation endpoints and hosted UI reference</a>.</p>
6
6
  * <p>This API reference provides detailed information about API operations and object types
7
- * in Amazon Cognito. At the bottom of the page for each API operation and object, under
8
- * <i>See Also</i>, you can learn how to use it in an Amazon Web Services SDK in the
9
- * language of your choice.</p>
7
+ * in Amazon Cognito.</p>
10
8
  * <p>Along with resource management operations, the Amazon Cognito user pools API includes classes
11
- * of operations and authorization models for client-side and server-side user operations.
12
- * 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
13
- * <i>Amazon Cognito Developer Guide</i>.</p>
14
- * <p>You can also start reading about the <code>CognitoIdentityProvider</code> client in
15
- * the following SDK guides.</p>
9
+ * of operations and authorization models for client-side and server-side authentication of
10
+ * users. You can interact with operations in the Amazon Cognito user pools API as any of the
11
+ * following subjects.</p>
12
+ * <ol>
13
+ * <li>
14
+ * <p>An administrator who wants to configure user pools, app clients, users,
15
+ * groups, or other user pool functions.</p>
16
+ * </li>
17
+ * <li>
18
+ * <p>A server-side app, like a web application, that wants to use its Amazon Web Services
19
+ * privileges to manage, authenticate, or authorize a user.</p>
20
+ * </li>
21
+ * <li>
22
+ * <p>A client-side app, like a mobile app, that wants to make unauthenticated
23
+ * requests to manage, authenticate, or authorize a user.</p>
24
+ * </li>
25
+ * </ol>
26
+ * <p>For more information, see <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>
27
+ * in the <i>Amazon Cognito Developer Guide</i>.</p>
28
+ * <p>With your Amazon Web Services SDK, you can build the logic to support operational flows in every use
29
+ * case for this API. You can also make direct REST API requests to <a href="https://docs.aws.amazon.com/general/latest/gr/cognito_identity.html#cognito_identity_your_user_pools_region">Amazon Cognito user pools service endpoints</a>. The following links can get you started
30
+ * with the <code>CognitoIdentityProvider</code> client in other supported Amazon Web Services
31
+ * SDKs.</p>
16
32
  * <ul>
17
33
  * <li>
18
34
  * <p>