feat(client-cognito-identity-provider): New feature that logs Cognito…

… user pool error messages to CloudWatch logs.
aws · Aug 2, 2023 · e4fee3f · e4fee3f
1 parent 44dde88
commit e4fee3f
Show file tree

Hide file tree

Showing 91 changed files with 3,331 additions and 767 deletions.
diff --git a/clients/client-cognito-identity-provider/README.md b/clients/client-cognito-identity-provider/README.md
@@ -6,12 +6,73 @@
 
 AWS SDK for JavaScript CognitoIdentityProvider Client for Node.js, Browser and React Native.
 
-<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>
 
 ## Installing
 
@@ -690,6 +751,14 @@ GetIdentityProviderByIdentifier
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cognito-identity-provider/classes/getidentityproviderbyidentifiercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cognito-identity-provider/interfaces/getidentityproviderbyidentifiercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cognito-identity-provider/interfaces/getidentityproviderbyidentifiercommandoutput.html)
 
+</details>
+<details>
+<summary>
+GetLogDeliveryConfiguration
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cognito-identity-provider/classes/getlogdeliveryconfigurationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cognito-identity-provider/interfaces/getlogdeliveryconfigurationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cognito-identity-provider/interfaces/getlogdeliveryconfigurationcommandoutput.html)
+
 </details>
 <details>
 <summary>
@@ -850,6 +919,14 @@ RevokeToken
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cognito-identity-provider/classes/revoketokencommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cognito-identity-provider/interfaces/revoketokencommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cognito-identity-provider/interfaces/revoketokencommandoutput.html)
 
+</details>
+<details>
+<summary>
+SetLogDeliveryConfiguration
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cognito-identity-provider/classes/setlogdeliveryconfigurationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cognito-identity-provider/interfaces/setlogdeliveryconfigurationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cognito-identity-provider/interfaces/setlogdeliveryconfigurationcommandoutput.html)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts b/clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts
@@ -283,6 +283,11 @@ import {
   GetIdentityProviderByIdentifierCommandInput,
   GetIdentityProviderByIdentifierCommandOutput,
 } from "./commands/GetIdentityProviderByIdentifierCommand";
+import {
+  GetLogDeliveryConfigurationCommand,
+  GetLogDeliveryConfigurationCommandInput,
+  GetLogDeliveryConfigurationCommandOutput,
+} from "./commands/GetLogDeliveryConfigurationCommand";
 import {
   GetSigningCertificateCommand,
   GetSigningCertificateCommandInput,
@@ -363,6 +368,11 @@ import {
   RespondToAuthChallengeCommandOutput,
 } from "./commands/RespondToAuthChallengeCommand";
 import { RevokeTokenCommand, RevokeTokenCommandInput, RevokeTokenCommandOutput } from "./commands/RevokeTokenCommand";
+import {
+  SetLogDeliveryConfigurationCommand,
+  SetLogDeliveryConfigurationCommandInput,
+  SetLogDeliveryConfigurationCommandOutput,
+} from "./commands/SetLogDeliveryConfigurationCommand";
 import {
   SetRiskConfigurationCommand,
   SetRiskConfigurationCommandInput,
@@ -518,6 +528,7 @@ const commands = {
   GetDeviceCommand,
   GetGroupCommand,
   GetIdentityProviderByIdentifierCommand,
+  GetLogDeliveryConfigurationCommand,
   GetSigningCertificateCommand,
   GetUICustomizationCommand,
   GetUserCommand,
@@ -538,6 +549,7 @@ const commands = {
   ResendConfirmationCodeCommand,
   RespondToAuthChallengeCommand,
   RevokeTokenCommand,
+  SetLogDeliveryConfigurationCommand,
   SetRiskConfigurationCommand,
   SetUICustomizationCommand,
   SetUserMFAPreferenceCommand,
@@ -1498,6 +1510,23 @@ export interface CognitoIdentityProvider {
     cb: (err: any, data?: GetIdentityProviderByIdentifierCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link GetLogDeliveryConfigurationCommand}
+   */
+  getLogDeliveryConfiguration(
+    args: GetLogDeliveryConfigurationCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<GetLogDeliveryConfigurationCommandOutput>;
+  getLogDeliveryConfiguration(
+    args: GetLogDeliveryConfigurationCommandInput,
+    cb: (err: any, data?: GetLogDeliveryConfigurationCommandOutput) => void
+  ): void;
+  getLogDeliveryConfiguration(
+    args: GetLogDeliveryConfigurationCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetLogDeliveryConfigurationCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link GetSigningCertificateCommand}
    */
@@ -1790,6 +1819,23 @@ export interface CognitoIdentityProvider {
     cb: (err: any, data?: RevokeTokenCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link SetLogDeliveryConfigurationCommand}
+   */
+  setLogDeliveryConfiguration(
+    args: SetLogDeliveryConfigurationCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<SetLogDeliveryConfigurationCommandOutput>;
+  setLogDeliveryConfiguration(
+    args: SetLogDeliveryConfigurationCommandInput,
+    cb: (err: any, data?: SetLogDeliveryConfigurationCommandOutput) => void
+  ): void;
+  setLogDeliveryConfiguration(
+    args: SetLogDeliveryConfigurationCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: SetLogDeliveryConfigurationCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link SetRiskConfigurationCommand}
    */
@@ -2120,12 +2166,73 @@ export interface CognitoIdentityProvider {
 
 /**
  * @public
- * <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>
  */
 export class CognitoIdentityProvider extends CognitoIdentityProviderClient implements CognitoIdentityProvider {}
 createAggregatedClient(commands, CognitoIdentityProvider);