With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To\nauthenticate users from third-party identity providers (IdPs) in this API, you can\nlink IdP users to native user profiles. Learn more\nabout the authentication and authorization of federated users at Adding user pool sign-in through a third party and in the User pool federation endpoints and managed login reference.
\nThis API reference provides detailed information about API operations and object types\nin Amazon Cognito.
\nAlong with resource management operations, the Amazon Cognito user pools API includes classes\nof operations and authorization models for client-side and server-side authentication of\nusers. You can interact with operations in the Amazon Cognito user pools API as any of the\nfollowing subjects.
\nAn administrator who wants to configure user pools, app clients, users,\ngroups, or other user pool functions.
\nA server-side app, like a web application, that wants to use its Amazon Web Services\nprivileges to manage, authenticate, or authorize a user.
\nA client-side app, like a mobile app, that wants to make unauthenticated\nrequests to manage, authenticate, or authorize a user.
\nFor more information, see Understanding API, OIDC, and managed login pages\nauthentication in the Amazon Cognito Developer Guide.
\nWith your Amazon Web Services SDK, you can build the logic to support operational flows in every use\ncase for this API. You can also make direct REST API requests to Amazon Cognito user pools service endpoints. The following links can get you started\nwith the CognitoIdentityProvider client in supported Amazon Web Services SDKs.
To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services\nSDKs.
\n\n## Installing\n\nTo install this package, use the CLI of your favorite package manager:\n\n- `npm install @aws-sdk/client-cognito-identity-provider`\n- `yarn add @aws-sdk/client-cognito-identity-provider`\n- `pnpm add @aws-sdk/client-cognito-identity-provider`\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands.\nTo send a request, you only need to import the `CognitoIdentityProviderClient` and\nthe commands you need, for example `ListDevicesCommand`:\n\n```js\n// ES5 example\nconst { CognitoIdentityProviderClient, ListDevicesCommand } = require(\"@aws-sdk/client-cognito-identity-provider\");\n```\n\n```ts\n// ES6+ example\nimport { CognitoIdentityProviderClient, ListDevicesCommand } from \"@aws-sdk/client-cognito-identity-provider\";\n```\n\n### Usage\n\nTo send a request:\n\n- Instantiate a client with configuration (e.g. credentials, region).\n - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.\n - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.\n- Instantiate a command with input parameters.\n- Call the `send` operation on the client, providing the command object as input.\n\n```js\nconst client = new CognitoIdentityProviderClient({ region: \"REGION\" });\n\nconst params = { /** input parameters */ };\nconst command = new ListDevicesCommand(params);\n```\n\n#### Async/await\n\nWe recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\noperator to wait for the promise returned by send operation as follows:\n\n```js\n// async/await.\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n // error handling.\n} finally {\n // finally.\n}\n```\n\n#### Promises\n\nYou can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).\n\n```js\nclient\n .send(command)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n })\n .finally(() => {\n // finally.\n });\n```\n\n#### Aggregated client\n\nThe aggregated client class is exported from the same package, but without the \"Client\" suffix.\n\n`CognitoIdentityProvider` extends `CognitoIdentityProviderClient` and additionally supports all operations, waiters, and paginators as methods.\nThis style may be familiar to you from the AWS SDK for JavaScript v2.\n\nIf you are bundling the AWS SDK, we recommend using only the bare-bones client (`CognitoIdentityProviderClient`).\nMore details are in the blog post on\n[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).\n\n```ts\nimport { CognitoIdentityProvider } from \"@aws-sdk/client-cognito-identity-provider\";\n\nconst client = new CognitoIdentityProvider({ region: \"REGION\" });\n\n// async/await.\ntry {\n const data = await client.listDevices(params);\n // process data.\n} catch (error) {\n // error handling.\n}\n\n// Promises.\nclient\n .listDevices(params)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n });\n\n// callbacks (not recommended).\nclient.listDevices(params, (err, data) => {\n // process err and data.\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information,\nas well as response metadata (e.g. request id).\n\n```js\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n const { requestId, cfId, extendedRequestId } = error.$metadata;\n console.log({ requestId, cfId, extendedRequestId });\n /**\n * The keys within exceptions are also parsed.\n * You can access them by specifying exception names:\n * if (error.name === 'SomeServiceException') {\n * const value = error.specialKeyInException;\n * }\n */\n}\n```\n\nSee also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).\n\n## Getting Help\n\nPlease use these community resources for getting help.\nWe use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.\n\n- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)\n or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)\n on AWS Developer Blog.\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.\n- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).\n\nTo test your universal JavaScript code in Node.js, browser and react-native environments,\nvisit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-cognito-identity-provider` package is updated.\nTo contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n## Client Commands (Operations List)\n\n