Skip to content

Commit e4fee3f

Browse files
author
awstools
committed
feat(client-cognito-identity-provider): New feature that logs Cognito user pool error messages to CloudWatch logs.
1 parent 44dde88 commit e4fee3f

File tree

91 files changed

+3331
-767
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+3331
-767
lines changed

‎clients/client-cognito-identity-provider/README.md

Lines changed: 83 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,73 @@
66

77
AWS SDK for JavaScript CognitoIdentityProvider Client for Node.js, Browser and React Native.
88

9-
<p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and
10-
users. You can authenticate a user to obtain tokens related to user identity and access
11-
policies.</p>
12-
<p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
13-
<p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
14-
Documentation</a>.</p>
9+
<p>With the Amazon Cognito user pools API, you can set up user pools and app clients, and
10+
authenticate users. To authenticate users from third-party identity providers (IdPs) in
11+
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
12+
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>
13+
<p>This API reference provides detailed information about API operations and object types
14+
in Amazon Cognito. At the bottom of the page for each API operation and object, under
15+
<i>See Also</i>, you can learn how to use it in an Amazon Web Services SDK in the
16+
language of your choice.</p>
17+
<p>Along with resource management operations, the Amazon Cognito user pools API includes classes
18+
of operations and authorization models for client-side and server-side user operations.
19+
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
20+
<i>Amazon Cognito Developer Guide</i>.</p>
21+
<p>You can also start reading about the <code>CognitoIdentityProvider</code> client in
22+
the following SDK guides.</p>
23+
<ul>
24+
<li>
25+
<p>
26+
<a href="https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/index.html#cli-aws-cognito-idp">Amazon Web Services
27+
Command Line Interface</a>
28+
</p>
29+
</li>
30+
<li>
31+
<p>
32+
<a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CognitoIdentityProvider/TCognitoIdentityProviderClient.html">Amazon Web Services SDK for .NET</a>
33+
</p>
34+
</li>
35+
<li>
36+
<p>
37+
<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>
38+
</p>
39+
</li>
40+
<li>
41+
<p>
42+
<a href="https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/#CognitoIdentityProvider">Amazon Web Services SDK for Go</a>
43+
</p>
44+
</li>
45+
<li>
46+
<p>
47+
<a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentityprovider/CognitoIdentityProviderClient.html">Amazon Web Services SDK for Java V2</a>
48+
</p>
49+
</li>
50+
<li>
51+
<p>
52+
<a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CognitoIdentityServiceProvider.html">Amazon Web Services
53+
SDK for JavaScript</a>
54+
</p>
55+
</li>
56+
<li>
57+
<p>
58+
<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
59+
V3</a>
60+
</p>
61+
</li>
62+
<li>
63+
<p>
64+
<a href="https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html">Amazon Web Services SDK for Python</a>
65+
</p>
66+
</li>
67+
<li>
68+
<p>
69+
<a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html">Amazon Web Services SDK
70+
for Ruby V3</a>
71+
</p>
72+
</li>
73+
</ul>
74+
<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
75+
SDKs</a>.</p>
1576

1677
## Installing
1778

@@ -690,6 +751,14 @@ GetIdentityProviderByIdentifier
690751

691752
[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)
692753

754+
</details>
755+
<details>
756+
<summary>
757+
GetLogDeliveryConfiguration
758+
</summary>
759+
760+
[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)
761+
693762
</details>
694763
<details>
695764
<summary>
@@ -850,6 +919,14 @@ RevokeToken
850919

851920
[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)
852921

922+
</details>
923+
<details>
924+
<summary>
925+
SetLogDeliveryConfiguration
926+
</summary>
927+
928+
[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)
929+
853930
</details>
854931
<details>
855932
<summary>

‎clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts

Lines changed: 113 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,11 @@ import {
283283
GetIdentityProviderByIdentifierCommandInput,
284284
GetIdentityProviderByIdentifierCommandOutput,
285285
} from "./commands/GetIdentityProviderByIdentifierCommand";
286+
import {
287+
GetLogDeliveryConfigurationCommand,
288+
GetLogDeliveryConfigurationCommandInput,
289+
GetLogDeliveryConfigurationCommandOutput,
290+
} from "./commands/GetLogDeliveryConfigurationCommand";
286291
import {
287292
GetSigningCertificateCommand,
288293
GetSigningCertificateCommandInput,
@@ -363,6 +368,11 @@ import {
363368
RespondToAuthChallengeCommandOutput,
364369
} from "./commands/RespondToAuthChallengeCommand";
365370
import { RevokeTokenCommand, RevokeTokenCommandInput, RevokeTokenCommandOutput } from "./commands/RevokeTokenCommand";
371+
import {
372+
SetLogDeliveryConfigurationCommand,
373+
SetLogDeliveryConfigurationCommandInput,
374+
SetLogDeliveryConfigurationCommandOutput,
375+
} from "./commands/SetLogDeliveryConfigurationCommand";
366376
import {
367377
SetRiskConfigurationCommand,
368378
SetRiskConfigurationCommandInput,
@@ -518,6 +528,7 @@ const commands = {
518528
GetDeviceCommand,
519529
GetGroupCommand,
520530
GetIdentityProviderByIdentifierCommand,
531+
GetLogDeliveryConfigurationCommand,
521532
GetSigningCertificateCommand,
522533
GetUICustomizationCommand,
523534
GetUserCommand,
@@ -538,6 +549,7 @@ const commands = {
538549
ResendConfirmationCodeCommand,
539550
RespondToAuthChallengeCommand,
540551
RevokeTokenCommand,
552+
SetLogDeliveryConfigurationCommand,
541553
SetRiskConfigurationCommand,
542554
SetUICustomizationCommand,
543555
SetUserMFAPreferenceCommand,
@@ -1498,6 +1510,23 @@ export interface CognitoIdentityProvider {
14981510
cb: (err: any, data?: GetIdentityProviderByIdentifierCommandOutput) => void
14991511
): void;
15001512

1513+
/**
1514+
* @see {@link GetLogDeliveryConfigurationCommand}
1515+
*/
1516+
getLogDeliveryConfiguration(
1517+
args: GetLogDeliveryConfigurationCommandInput,
1518+
options?: __HttpHandlerOptions
1519+
): Promise<GetLogDeliveryConfigurationCommandOutput>;
1520+
getLogDeliveryConfiguration(
1521+
args: GetLogDeliveryConfigurationCommandInput,
1522+
cb: (err: any, data?: GetLogDeliveryConfigurationCommandOutput) => void
1523+
): void;
1524+
getLogDeliveryConfiguration(
1525+
args: GetLogDeliveryConfigurationCommandInput,
1526+
options: __HttpHandlerOptions,
1527+
cb: (err: any, data?: GetLogDeliveryConfigurationCommandOutput) => void
1528+
): void;
1529+
15011530
/**
15021531
* @see {@link GetSigningCertificateCommand}
15031532
*/
@@ -1790,6 +1819,23 @@ export interface CognitoIdentityProvider {
17901819
cb: (err: any, data?: RevokeTokenCommandOutput) => void
17911820
): void;
17921821

1822+
/**
1823+
* @see {@link SetLogDeliveryConfigurationCommand}
1824+
*/
1825+
setLogDeliveryConfiguration(
1826+
args: SetLogDeliveryConfigurationCommandInput,
1827+
options?: __HttpHandlerOptions
1828+
): Promise<SetLogDeliveryConfigurationCommandOutput>;
1829+
setLogDeliveryConfiguration(
1830+
args: SetLogDeliveryConfigurationCommandInput,
1831+
cb: (err: any, data?: SetLogDeliveryConfigurationCommandOutput) => void
1832+
): void;
1833+
setLogDeliveryConfiguration(
1834+
args: SetLogDeliveryConfigurationCommandInput,
1835+
options: __HttpHandlerOptions,
1836+
cb: (err: any, data?: SetLogDeliveryConfigurationCommandOutput) => void
1837+
): void;
1838+
17931839
/**
17941840
* @see {@link SetRiskConfigurationCommand}
17951841
*/
@@ -2120,12 +2166,73 @@ export interface CognitoIdentityProvider {
21202166

21212167
/**
21222168
* @public
2123-
* <p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and
2124-
* users. You can authenticate a user to obtain tokens related to user identity and access
2125-
* policies.</p>
2126-
* <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
2127-
* <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
2128-
* Documentation</a>.</p>
2169+
* <p>With the Amazon Cognito user pools API, you can set up user pools and app clients, and
2170+
* authenticate users. To authenticate users from third-party identity providers (IdPs) in
2171+
* 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
2172+
* 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>
2173+
* <p>This API reference provides detailed information about API operations and object types
2174+
* in Amazon Cognito. At the bottom of the page for each API operation and object, under
2175+
* <i>See Also</i>, you can learn how to use it in an Amazon Web Services SDK in the
2176+
* language of your choice.</p>
2177+
* <p>Along with resource management operations, the Amazon Cognito user pools API includes classes
2178+
* of operations and authorization models for client-side and server-side user operations.
2179+
* 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
2180+
* <i>Amazon Cognito Developer Guide</i>.</p>
2181+
* <p>You can also start reading about the <code>CognitoIdentityProvider</code> client in
2182+
* the following SDK guides.</p>
2183+
* <ul>
2184+
* <li>
2185+
* <p>
2186+
* <a href="https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/index.html#cli-aws-cognito-idp">Amazon Web Services
2187+
* Command Line Interface</a>
2188+
* </p>
2189+
* </li>
2190+
* <li>
2191+
* <p>
2192+
* <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CognitoIdentityProvider/TCognitoIdentityProviderClient.html">Amazon Web Services SDK for .NET</a>
2193+
* </p>
2194+
* </li>
2195+
* <li>
2196+
* <p>
2197+
* <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>
2198+
* </p>
2199+
* </li>
2200+
* <li>
2201+
* <p>
2202+
* <a href="https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/#CognitoIdentityProvider">Amazon Web Services SDK for Go</a>
2203+
* </p>
2204+
* </li>
2205+
* <li>
2206+
* <p>
2207+
* <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentityprovider/CognitoIdentityProviderClient.html">Amazon Web Services SDK for Java V2</a>
2208+
* </p>
2209+
* </li>
2210+
* <li>
2211+
* <p>
2212+
* <a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CognitoIdentityServiceProvider.html">Amazon Web Services
2213+
* SDK for JavaScript</a>
2214+
* </p>
2215+
* </li>
2216+
* <li>
2217+
* <p>
2218+
* <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
2219+
* V3</a>
2220+
* </p>
2221+
* </li>
2222+
* <li>
2223+
* <p>
2224+
* <a href="https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html">Amazon Web Services SDK for Python</a>
2225+
* </p>
2226+
* </li>
2227+
* <li>
2228+
* <p>
2229+
* <a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html">Amazon Web Services SDK
2230+
* for Ruby V3</a>
2231+
* </p>
2232+
* </li>
2233+
* </ul>
2234+
* <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
2235+
* SDKs</a>.</p>
21292236
*/
21302237
export class CognitoIdentityProvider extends CognitoIdentityProviderClient implements CognitoIdentityProvider {}
21312238
createAggregatedClient(commands, CognitoIdentityProvider);

0 commit comments

Comments
 (0)