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.
This API reference provides information about user pools in Amazon Cognito User Pools.
For more information, see the Amazon Cognito Documentation.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-cognito-identity-provider-node\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`CognitoIdentityProviderClient`) and the commands you need, for example `AddCustomAttributesCommand`:\n\n```javascript\n//JavaScript\nconst {\n CognitoIdentityProviderClient\n} = require(\"@aws-sdk/client-cognito-identity-provider-node/CognitoIdentityProviderClient\");\nconst {\n AddCustomAttributesCommand\n} = require(\"@aws-sdk/client-cognito-identity-provider-node/commands/AddCustomAttributesCommand\");\n```\n\n```javascript\n//TypeScript\nimport { CognitoIdentityProviderClient } from \"@aws-sdk/client-cognito-identity-provider-node/CognitoIdentityProviderClient\";\nimport { AddCustomAttributesCommand } from \"@aws-sdk/client-cognito-identity-provider-node/commands/AddCustomAttributesCommand\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst cognitoIdentityProvider = new CognitoIdentityProviderClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n UserPoolId: /**a string value*/,\n CustomAttributes: [ /**a list of structure*/ ],\n};\nconst addCustomAttributesCommand = new AddCustomAttributesCommand(params);\ncognitoIdentityProvider.send(addCustomAttributesCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await cognitoIdentityProvider.send(addCustomAttributesCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncognitoIdentityProvider.send(addCustomAttributesCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/@aws-sdk/client-cognito-identity-provider-node/CognitoIdentityProvider\";\nconst cognitoIdentityProvider = new AWS.CognitoIdentityProvider({\n region: \"region\"\n});\ncognitoIdentityProvider.addCustomAttributes(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await cognitoIdentityProvider.send(addCustomAttributesCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come 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)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cognito-identity-provider-node' package is updated. To contribute to SDK you can checkout our [code generator package][].\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[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"npm run pretest && node ./test/smoke/index.spec.js","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-cognito-identity-provider-node has been renamed to @aws-sdk/client-cognito-identity-provider. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node SDK for Amazon Cognito Identity Provider","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.5","@aws-sdk/hash-node":"^0.1.0-preview.6","@aws-sdk/json-parser":"^0.1.0-preview.5","@aws-sdk/core-handler":"^0.1.0-preview.5","@aws-sdk/json-builder":"^0.1.0-preview.5","@aws-sdk/signature-v4":"^0.1.0-preview.7","@aws-sdk/util-utf8-node":"^0.1.0-preview.4","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/region-provider":"^0.1.0-preview.5","@aws-sdk/url-parser-node":"^0.1.0-preview.6","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-sdk/util-base64-node":"^0.1.0-preview.4","@aws-sdk/node-http-handler":"^0.1.0-preview.6","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.6","@aws-sdk/signing-middleware":"^0.1.0-preview.7","@aws-sdk/util-user-agent-node":"^0.1.0-preview.7","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/stream-collector-node":"^0.1.0-preview.6","@aws-sdk/util-body-length-node":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/credential-provider-node":"^0.1.0-preview.7","@aws-sdk/middleware-content-length":"^0.1.0-preview.5","@aws-sdk/middleware-header-default":"^0.1.0-preview.5"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^24.7.1","rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@types/jest":"^24.0.12","@types/node":"^10.0.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-cognito-identity-provider-node_0.1.0-preview.3_1568908958171_0.9542251180335459","host":"s3://npm-registry-packages"}},"0.1.0-preview.4":{"name":"@aws-sdk/client-cognito-identity-provider-node","version":"0.1.0-preview.4","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-cognito-identity-provider-node@0.1.0-preview.4","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"c0b7d28033516e595915168810b1fada3389c8e4","tarball":"https://registry.npmjs.org/@aws-sdk/client-cognito-identity-provider-node/-/client-cognito-identity-provider-node-0.1.0-preview.4.tgz","fileCount":2831,"integrity":"sha512-DTvSHR7tvSNgCjnVrTt5iQ59FXneJekf8TpigmSj7tSWjJmYN9nJtrkSdzCFOs3NLxkmcn4QWC1lWnRMJrPcKQ==","signatures":[{"sig":"MEUCID2h5moiCCuhv+vVp6+GcqysvWDv9ZqXn4BJ5Y1tbvLNAiEAl1Lbd8y6bvwNIWUO40VoREOrb7GQoVtpejFZ81j0Ljw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1865977,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduNBUCRA9TVsSAnZWagAAL5gP/3H8z5ZSS4RkpNOnnPHl\nsxU6pxZpJ1s6y8Dm+UFcph+3GULVVAhAJP3vrBUXT/CJ0vig0YDVqKotKZhX\n8lHmCKd5sqMExHgbpOQyDCq3xnHzUQyY13ScXfcpiXEEQmOiQkFjR1ixEb3A\n8gD7wcryetB+ZQhClf3VJzc6uJYF4OhuwGKJgHsTzaWDtmGWQRT3Sy1Fss9Z\nBJ6XxVjh9qQVcMRiITOQOc3lqPOMi6Itlzhd12oCuMsL9gbz9A5V/ed1dRrv\n9iL3Cg35lQo6JCI1Zlx57GbcQJmMWQhG6deEiJB8o5uvv/sXDjmEY3KrvvWP\nP6NqF3+XPl0cm4n1/S9wyB/ujJEF8GHWcOAAGbd/hubRLLyMp1NMWV23L8ij\nmB4MPS91LPYJ7M+sGc+rGnkss0DU6aqbRL60KWYFX1vjsmGCqkSaDZRxPAiP\nrcjq+7n/KvAFZW0Sm+WQSFUHclrpXSH7k6Ft/OihSkrBWrRRipAk1nhGTx56\n398I2Pu/D+7S1kTLBNcz1fJhDuflpmZiaCiE/GKmXsjRbZG0Qjq5sjJn5Ono\nPRXAAG95Oz/YftRtSG65k1+0EYurLAZoBts03L/zTeSY15E4ECSATL3ds6kt\nuFSFjcEF69bhlEX+h/xOdyWN0rO91jeYChhyW1gwWyoTvCVqqy9OTilUuJ1u\nhUah\r\n=/Cp8\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-cognito-identity-provider-node\n\n[](https://www.npmjs.com/package/@aws-sdk/client-cognito-identity-provider-node)\n[](https://www.npmjs.com/package/@aws-sdk/client-cognito-identity-provider-node)\n\n## Description\n\nUsing 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.
This API reference provides information about user pools in Amazon Cognito User Pools.
For more information, see the Amazon Cognito Documentation.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-cognito-identity-provider-node\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`CognitoIdentityProviderClient`) and the commands you need, for example `AddCustomAttributesCommand`:\n\n```javascript\n//JavaScript\nconst {\n CognitoIdentityProviderClient,\n AddCustomAttributesCommand\n} = require(\"@aws-sdk/client-cognito-identity-provider-node\");\n```\n\n```javascript\n//TypeScript\nimport {\n CognitoIdentityProviderClient,\n AddCustomAttributesCommand\n} from \"@aws-sdk/client-cognito-identity-provider-node\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst cognitoIdentityProvider = new CognitoIdentityProviderClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n UserPoolId: /**a string value*/,\n CustomAttributes: [ /**a list of structure*/ ],\n};\nconst addCustomAttributesCommand = new AddCustomAttributesCommand(params);\ncognitoIdentityProvider.send(addCustomAttributesCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await cognitoIdentityProvider.send(addCustomAttributesCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncognitoIdentityProvider.send(addCustomAttributesCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-cognito-identity-provider-node\";\nconst cognitoIdentityProvider = new AWS.CognitoIdentityProvider({\n region: \"region\"\n});\ncognitoIdentityProvider.addCustomAttributes(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await cognitoIdentityProvider.send(addCustomAttributesCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come 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)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cognito-identity-provider-node' package is updated. To contribute to SDK you can checkout our [code generator package][].\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[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"npm run pretest && node ./test/smoke/index.spec.js","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-cognito-identity-provider-node has been renamed to @aws-sdk/client-cognito-identity-provider. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node SDK for Amazon Cognito Identity Provider","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.6","@aws-sdk/hash-node":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.6","@aws-sdk/core-handler":"^0.1.0-preview.6","@aws-sdk/json-builder":"^0.1.0-preview.6","@aws-sdk/signature-v4":"^0.1.0-preview.8","@aws-sdk/util-utf8-node":"^0.1.0-preview.4","@aws-sdk/config-resolver":"^0.1.0-preview.6","@aws-sdk/region-provider":"^0.1.0-preview.6","@aws-sdk/url-parser-node":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.7","@aws-sdk/retry-middleware":"^0.1.0-preview.6","@aws-sdk/util-base64-node":"^0.1.0-preview.4","@aws-sdk/node-http-handler":"^0.1.0-preview.7","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.7","@aws-sdk/signing-middleware":"^0.1.0-preview.8","@aws-sdk/util-user-agent-node":"^0.1.0-preview.8","@aws-sdk/middleware-serializer":"^0.1.0-preview.6","@aws-sdk/stream-collector-node":"^0.1.0-preview.7","@aws-sdk/util-body-length-node":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.7","@aws-sdk/credential-provider-node":"^0.1.0-preview.8","@aws-sdk/middleware-content-length":"^0.1.0-preview.6","@aws-sdk/middleware-header-default":"^0.1.0-preview.6"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^24.7.1","rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@types/jest":"^24.0.12","@types/node":"^10.0.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-cognito-identity-provider-node_0.1.0-preview.4_1572393043946_0.9804959780899083","host":"s3://npm-registry-packages"}},"0.1.0-preview.5":{"name":"@aws-sdk/client-cognito-identity-provider-node","version":"0.1.0-preview.5","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-cognito-identity-provider-node@0.1.0-preview.5","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"dd0f208fd8f620bbce44d12510f401791dd17776","tarball":"https://registry.npmjs.org/@aws-sdk/client-cognito-identity-provider-node/-/client-cognito-identity-provider-node-0.1.0-preview.5.tgz","fileCount":2831,"integrity":"sha512-Rp6QYJbDQy+K+ilrWOYuAuKIsCUc+5QukmInis3yNQkHfSO5NTWo/GUBa9HHmiQTqqHauhY8oqsmWEhmrFh6fw==","signatures":[{"sig":"MEUCID6+YpRlH27oPLpAo7wjDtFsKfUHGFBN1uu0PH9lYMDNAiEArZaaphcN3UZBvpWx0VIYAD+VdY4GfvO7nW1oWOi/AP4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1866221,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdueNbCRA9TVsSAnZWagAA3FEP+QFmUBJFRNmhInxKEn5p\no7AH5P2ne9KGS8zLVNEs9McDM4utyhjbO5QeR2RHIhVClbOHtmQ/l0/9ZdMz\n0PS3n16HhGP1XKhDdE9qNIec5eP5ygXq+hLqRz/yNHeuxoegkXwSqJ/zA9jy\n9/I+PIwIOSvjedaUSgY6lzwTy90oFEfNaW4w6NY408g+P5eiVF4dxiVD8avB\nPhh6MfFqnhlt3FxSDx4Kv7wrKnJl3ypE3bBdr+kqzEotWBVb4nNC0o7yEPNe\nmJKRW1wxafHsMZcfnTpmQGF5+LZwh4STPEnCFLD+iElvBGouVkAQYo7Ayjiw\nAAoh1D2z2pcJx6JrWXT3qe590QHhYpOSES41JKUeg49abQ2ZRHwUt2FZRo6J\noUFyAD2DppfATooVxRMvMIwnvIbO/eYggLhM7U/YJ7HbOWSHkd1RWyQhoPNM\nKxh4eXFs1natqIrIBBOgus7KZBihmnY8QMBstJF4u0vR2eJQHzXYk2jhJDQK\nTDnVCUbx0NMsqZa13XydOD8Te87kNOffYaWLfdL53UC7si7aOgvS4kHJjSSK\nBmai16R7k/tEyTQb2A1Cnst4Xthe8Glsu3QSN0rwG7aJDiRa/m2nuqVr1EAL\nreaO8taA5TmnnxCqi7AbkiuuobzirIZTiCDvTztFgqk0jFGuC7ezUKRyIV6I\nF8Mm\r\n=1A9R\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-cognito-identity-provider-node\n\n[](https://www.npmjs.com/package/@aws-sdk/client-cognito-identity-provider-node)\n[](https://www.npmjs.com/package/@aws-sdk/client-cognito-identity-provider-node)\n\n## Description\n\nUsing 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.
This API reference provides information about user pools in Amazon Cognito User Pools.
For more information, see the Amazon Cognito Documentation.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-cognito-identity-provider-node\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`CognitoIdentityProviderClient`) and the commands you need, for example `AddCustomAttributesCommand`:\n\n```javascript\n//JavaScript\nconst {\n CognitoIdentityProviderClient,\n AddCustomAttributesCommand\n} = require(\"@aws-sdk/client-cognito-identity-provider-node\");\n```\n\n```javascript\n//TypeScript\nimport {\n CognitoIdentityProviderClient,\n AddCustomAttributesCommand\n} from \"@aws-sdk/client-cognito-identity-provider-node\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst cognitoIdentityProvider = new CognitoIdentityProviderClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n UserPoolId: /**a string value*/,\n CustomAttributes: [ /**a list of structure*/ ],\n};\nconst addCustomAttributesCommand = new AddCustomAttributesCommand(params);\ncognitoIdentityProvider.send(addCustomAttributesCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await cognitoIdentityProvider.send(addCustomAttributesCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncognitoIdentityProvider.send(addCustomAttributesCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-cognito-identity-provider-node\";\nconst cognitoIdentityProvider = new AWS.CognitoIdentityProvider({\n region: \"region\"\n});\ncognitoIdentityProvider.addCustomAttributes(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await cognitoIdentityProvider.send(addCustomAttributesCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come 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)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cognito-identity-provider-node' package is updated. To contribute to SDK you can checkout our [code generator package][].\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[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"npm run pretest && node ./test/smoke/index.spec.js","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-cognito-identity-provider-node has been renamed to @aws-sdk/client-cognito-identity-provider. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node SDK for Amazon Cognito Identity Provider","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/hash-node":"^0.1.0-preview.8","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.9","@aws-sdk/util-utf8-node":"^0.1.0-preview.4","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/region-provider":"^0.1.0-preview.7","@aws-sdk/url-parser-node":"^0.1.0-preview.8","@aws-sdk/middleware-stack":"^0.1.0-preview.8","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-sdk/util-base64-node":"^0.1.0-preview.4","@aws-sdk/node-http-handler":"^0.1.0-preview.8","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.9","@aws-sdk/util-user-agent-node":"^0.1.0-preview.9","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/stream-collector-node":"^0.1.0-preview.8","@aws-sdk/util-body-length-node":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/credential-provider-node":"^0.1.0-preview.9","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^24.7.1","rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@types/jest":"^24.0.12","@types/node":"^10.0.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-cognito-identity-provider-node_0.1.0-preview.5_1572463451316_0.1862493937903229","host":"s3://npm-registry-packages"}},"0.1.0-preview.6":{"name":"@aws-sdk/client-cognito-identity-provider-node","version":"0.1.0-preview.6","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-cognito-identity-provider-node@0.1.0-preview.6","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"f3740b7189ea9ddbfd1bc19b43e04c6786f86624","tarball":"https://registry.npmjs.org/@aws-sdk/client-cognito-identity-provider-node/-/client-cognito-identity-provider-node-0.1.0-preview.6.tgz","fileCount":2831,"integrity":"sha512-WCs6nkF5s+qktcMccV+6QePRVYHWcBNZTHZjPdKHU3YJQbs0ZeXzP4/tMTdRlGH4ZVFfZG/d4OVK31CgDo4M5Q==","signatures":[{"sig":"MEQCIFj/rYfpm3auhpy35nUXj9k8AzcaRANcOpamTq31Nbw5AiAFuOf/K9xyESY3YM2I12m97kg9XiIhhnspI6QFZ1UXgw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1866493,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd1FQVCRA9TVsSAnZWagAA3qsP/iY8lwobYhrxNWoRWgi1\nPsZ4ZwFuOSKlzP8kHLagtyYmMMFGKaW9dq7a6PF8WdoCTC7KI4mp8cvvoowX\nsYYfckrFVfH3Qb+qR3N2xCcwycZ9Sjdc3T58tkWLnOchuTSwwptzgAZminMS\nSObhGe30VkEOxQbRg0Zzcl+/BDcjxS6P5jD65bo0FXFrJA79hUTKxq4bEwav\nBTC6CQRyzRd7EmUT8RLGtMF86HOb8RVv3Jq9p2TWdlOZBIc9xr/9aCFlm7WK\nTIN1LkwpNS24H8tdc18ZMgMDz3pSlYvn5cy+DZLbbfM7MewMdKNl3v5ewuUR\n67h+ttacBUFswSkEvKE/0SJRQTm7KE926nLro+IkKueSsAl1rdOWYvZiPt+P\nzRWKvtBLx1Rp2LZUD6NYeFuIbhfU4MK/LmMS+OrEXfdYg7Imq5kJkYIFIuL0\nHwSyjiDFrwlbY/Fz18bkibfYvtYcRxA+IDrJve32+KdHiDjB8/4ZEJmOceW+\nFqeEaQWBVTnQ+Boyj7ERN1R2YGMP2R7Cjke1g678vzF4vxPLkQKSNdhgx/w1\nKco8ZtOhf1Kb9ghEl8g2OTtcc0FllamKjcq7tKE+0IoLjQc5T/nAmGb66N8Z\nx7nB+Q1IjZD6mzNYABpuUAyDESN/MsTKmJwPDQFpxPry911FN58UIVF/VrV4\nTmMN\r\n=cvK+\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-cognito-identity-provider-node\n\n[](https://www.npmjs.com/package/@aws-sdk/client-cognito-identity-provider-node)\n[](https://www.npmjs.com/package/@aws-sdk/client-cognito-identity-provider-node)\n\n## Description\n\nUsing 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.
This API reference provides information about user pools in Amazon Cognito User Pools.
For more information, see the Amazon Cognito Documentation.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-cognito-identity-provider-node\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`CognitoIdentityProviderClient`) and the commands you need, for example `AddCustomAttributesCommand`:\n\n```javascript\n//JavaScript\nconst {\n CognitoIdentityProviderClient,\n AddCustomAttributesCommand\n} = require(\"@aws-sdk/client-cognito-identity-provider-node\");\n```\n\n```javascript\n//TypeScript\nimport {\n CognitoIdentityProviderClient,\n AddCustomAttributesCommand\n} from \"@aws-sdk/client-cognito-identity-provider-node\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst cognitoIdentityProvider = new CognitoIdentityProviderClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n UserPoolId: /**a string value*/,\n CustomAttributes: [ /**a list of structure*/ ],\n};\nconst addCustomAttributesCommand = new AddCustomAttributesCommand(params);\ncognitoIdentityProvider.send(addCustomAttributesCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await cognitoIdentityProvider.send(addCustomAttributesCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncognitoIdentityProvider.send(addCustomAttributesCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-cognito-identity-provider-node\";\nconst cognitoIdentityProvider = new AWS.CognitoIdentityProvider({\n region: \"region\"\n});\ncognitoIdentityProvider.addCustomAttributes(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await cognitoIdentityProvider.send(addCustomAttributesCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come 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)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cognito-identity-provider-node' package is updated. To contribute to SDK you can checkout our [code generator package][].\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[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"npm run pretest && node ./test/smoke/index.spec.js","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-cognito-identity-provider-node has been renamed to @aws-sdk/client-cognito-identity-provider. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node SDK for Amazon Cognito Identity Provider","directories":{},"_nodeVersion":"10.16.3","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/hash-node":"^0.1.0-preview.8","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.10","@aws-sdk/util-utf8-node":"^0.1.0-preview.4","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/region-provider":"^0.1.0-preview.7","@aws-sdk/url-parser-node":"^0.1.0-preview.8","@aws-sdk/middleware-stack":"^0.1.0-preview.9","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-sdk/util-base64-node":"^0.1.0-preview.4","@aws-sdk/node-http-handler":"^0.1.0-preview.8","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.10","@aws-sdk/util-user-agent-node":"^0.1.0-preview.10","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/stream-collector-node":"^0.1.0-preview.9","@aws-sdk/util-body-length-node":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/credential-provider-node":"^0.1.0-preview.10","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^24.7.1","rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@types/jest":"^24.0.12","@types/node":"^10.0.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-cognito-identity-provider-node_0.1.0-preview.6_1574196244649_0.9811801405552034","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-09-09T17:49:08.953Z","modified":"2025-03-27T18:37:19.944Z","0.1.0-preview.2":"2019-09-09T17:49:09.411Z","0.1.0-preview.3":"2019-09-19T16:02:38.481Z","0.1.0-preview.4":"2019-10-29T23:50:44.153Z","0.1.0-preview.5":"2019-10-30T19:24:11.539Z","0.1.0-preview.6":"2019-11-19T20:44:04.890Z"},"author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","description":"Node SDK for Amazon Cognito Identity Provider","maintainers":[{"email":"osa-3p@amazon.com","name":"amzn-oss"},{"email":"aws-sdk-js-automation@amazon.com","name":"aws-sdk-bot"}],"readme":"","readmeFilename":""}