This is the Amazon Rekognition API reference.
\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-rekognition-browser\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(`RekognitionClient`) and the commands you need, for example `CompareFacesCommand`:\n\n```javascript\n//JavaScript\nconst {\n RekognitionClient\n} = require(\"@aws-sdk/client-rekognition-browser/RekognitionClient\");\nconst {\n CompareFacesCommand\n} = require(\"@aws-sdk/client-rekognition-browser/commands/CompareFacesCommand\");\n```\n\n```javascript\n//TypeScript\nimport { RekognitionClient } from \"@aws-sdk/client-rekognition-browser/RekognitionClient\";\nimport { CompareFacesCommand } from \"@aws-sdk/client-rekognition-browser/commands/CompareFacesCommand\";\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 rekognition = new RekognitionClient({ region: \"region\" });\n//clients can be shared by different commands\nconst params = {\n SourceImage: {\n /**an object specifying SourceImage*/\n },\n TargetImage: {\n /**an object specifying TargetImage*/\n }\n};\nconst compareFacesCommand = new CompareFacesCommand(params);\nrekognition\n .send(compareFacesCommand)\n .then(data => {\n // do something\n })\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 rekognition.send(compareFacesCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nrekognition.send(compareFacesCommand, (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-rekognition-browser/Rekognition\";\nconst rekognition = new AWS.Rekognition({ region: \"region\" });\nrekognition.compareFaces(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 rekognition.send(compareFacesCommand);\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-rekognition-browser' 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":"karma start karma.conf","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-rekognition-browser has been renamed to @aws-sdk/client-rekognition. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Rekognition","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.5","@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/config-resolver":"^0.1.0-preview.5","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.6","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.5","@aws-sdk/signing-middleware":"^0.1.0-preview.7","@aws-sdk/url-parser-browser":"^0.1.0-preview.5","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.6","@aws-sdk/stream-collector-browser":"^0.1.0-preview.5","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@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","karma":"^4.1.0","rimraf":"^2.6.2","typedoc":"^0.14.2","puppeteer":"^1.0.0","typescript":"~3.4.0","@types/jest":"^24.0.12","jasmine-core":"^3.4.0","karma-jasmine":"^2.0.1","karma-coverage":"^1.1.1","karma-typescript":"^4.0.0","karma-chrome-launcher":"^3.0.0","@aws-sdk/karma-credential-loader":"^0.1.0-preview.7","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-rekognition-browser_0.1.0-preview.3_1568908606593_0.5749149249925027","host":"s3://npm-registry-packages"}},"0.1.0-preview.4":{"name":"@aws-sdk/client-rekognition-browser","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-rekognition-browser@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":"6cb753c9ea1d23f45030dd9db900475302fa4d6b","tarball":"https://registry.npmjs.org/@aws-sdk/client-rekognition-browser/-/client-rekognition-browser-0.1.0-preview.4.tgz","fileCount":1224,"integrity":"sha512-YpzbFWqF6otnk/JXDAHgouAHEBmGXezA8dmcZ3mr1M1Kk8wRGazbrCGpoyA3F+VGf0m9hGlR3yRIEJuFn5Kemg==","signatures":[{"sig":"MEUCIQDSk2blTCKJERqqiLE/HTPhgT6vZMSwWGYV3fjXqecx7gIgCdwPd43mzYqEzC1bkvwOpTjYfOjtIH1xyGsYAytG65c=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":760587,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduNN3CRA9TVsSAnZWagAAhpUP/2q+x8dYzzUyYerVWCod\nx6GfX81Kr/FLz78/5X91WO2Ms1mdynC8rnpPml4M8pW1Wa+TYLI8qTkqJLcj\nqbo1eehZUzirnxa3nY6tKnVkOZtw77QwchySHgzCsgIbe8XXhiRqlpdx5szY\nRL4IOSTxNFJJi1aer/+7tciUr1x1jTI6k5G4AXOwWJIwdI/k+aIX5LoTbfKD\n8ChazLx/9RXcaGjwvmVSTg4guGeD6hlfMnM9aWL8IwhenDIOy0uL/BxqMZ5d\npLx1A4vf53t6aHQ5sCvRIqDuJSYct4Jtjs3+AlnrtPr9NoHopuk5Ny6LP0Kc\nYn5YQ48Cyu2OgYdsxo9278ccG5HX0CCaWGw++MEGBRjSQPZQbKq+qSm8NWe+\nCUsHzGIyZW4rHa05r2yGmLTtzDAdIhYUCFHODKNfgjD6FxL8NX1yeR8n5/xB\nUoNpRwwyd6K0XmWrK2CWREXASPs5SZ3aglbFWk721PaCy0SdlUYg/SsM3FNj\ni3I+Gy5VhpMesvHiedwTWtg2tlZwLqyWLx/bduOpTHm9sP5x1yQ4IuGN7HWe\nku+zlgbNITsC5pxOPk4P3o2cIa3sWuTzRn7Bo/Q/aW7zoeZ7a6iEfDf2Vs8K\nlsKXYIvs/JVxNRG1ZjObtV6/RX8T9+ATRhPfJ5DqoD4GHyzNzUb17xP6KstV\nzTwM\r\n=/kIW\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-rekognition-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-rekognition-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-rekognition-browser)\n\n## Description\n\nThis is the Amazon Rekognition API reference.
\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-rekognition-browser\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(`RekognitionClient`) and the commands you need, for example `CompareFacesCommand`:\n\n```javascript\n//JavaScript\nconst {\n RekognitionClient,\n CompareFacesCommand\n} = require(\"@aws-sdk/client-rekognition-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n RekognitionClient,\n CompareFacesCommand\n} from \"@aws-sdk/client-rekognition-browser\";\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 rekognition = new RekognitionClient({ region: \"region\" });\n//clients can be shared by different commands\nconst params = {\n SourceImage: {\n /**an object specifying SourceImage*/\n },\n TargetImage: {\n /**an object specifying TargetImage*/\n }\n};\nconst compareFacesCommand = new CompareFacesCommand(params);\nrekognition\n .send(compareFacesCommand)\n .then(data => {\n // do something\n })\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 rekognition.send(compareFacesCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nrekognition.send(compareFacesCommand, (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-rekognition-browser\";\nconst rekognition = new AWS.Rekognition({ region: \"region\" });\nrekognition.compareFaces(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 rekognition.send(compareFacesCommand);\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-rekognition-browser' 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":"karma start karma.conf","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-rekognition-browser has been renamed to @aws-sdk/client-rekognition. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Rekognition","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.6","@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/config-resolver":"^0.1.0-preview.6","@aws-sdk/middleware-stack":"^0.1.0-preview.7","@aws-sdk/retry-middleware":"^0.1.0-preview.6","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.7","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.6","@aws-sdk/signing-middleware":"^0.1.0-preview.8","@aws-sdk/url-parser-browser":"^0.1.0-preview.6","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.6","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.7","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.7","@aws-sdk/stream-collector-browser":"^0.1.0-preview.6","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@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","karma":"^4.1.0","rimraf":"^2.6.2","typedoc":"^0.14.2","puppeteer":"^1.0.0","typescript":"~3.4.0","@types/jest":"^24.0.12","jasmine-core":"^3.4.0","karma-jasmine":"^2.0.1","karma-coverage":"^1.1.1","karma-typescript":"^4.0.0","karma-chrome-launcher":"^3.0.0","@aws-sdk/karma-credential-loader":"^0.1.0-preview.8","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-rekognition-browser_0.1.0-preview.4_1572393846460_0.7774632673516924","host":"s3://npm-registry-packages"}},"0.1.0-preview.5":{"name":"@aws-sdk/client-rekognition-browser","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-rekognition-browser@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":"9d2e921d4ab4c5ca6549f79dae88ed6bb8f77ebc","tarball":"https://registry.npmjs.org/@aws-sdk/client-rekognition-browser/-/client-rekognition-browser-0.1.0-preview.5.tgz","fileCount":1224,"integrity":"sha512-sVjGWRSb9dzoTpX2FAfHjNxtf2fwHRbeBWFNceFRnbgGzI0nnS5o0RuWTA/4QX8Gl+xn7ww+vdmCXMeOSUAMnA==","signatures":[{"sig":"MEUCIF1KYmtnwETCyX92DbQ9xblZT6YvaS7aJDohh1t7zMerAiEA56KQiF4Fu7XPBMOXH/2wDPqeZHWAbGhj5DLIyahBcdQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":760831,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduecPCRA9TVsSAnZWagAASdAP/1d9BXCKPk6MRvrSGs1o\nDEvol3sbvcutvjf6KTeTDaO7xHx4DPL54onYmNIIgScYYap4pZVNI524A3TL\n5tbAhBNvQb3bnvkk6H0xseImlrH6qRvjCN7sjLM0l/gKe0KEdtfV/UeWfVKN\na69pR8yNBvpKo36SaBZSnlo2FvTNJflg+VprX5R/M8glzK+0+sdsz5jTBhrZ\new0sZc+a505mHr/QG52cPYPP/Ruguw5pH2iuEOf4mSkP3QKXuYMiMfcSr1VD\ny/+9MWOSupd+4X2Xsf8NQHPixyOHDPluhuetn9iWYsS+wZirgVzldwATRCkS\n422XB+1pc33P5YipfkxhYzAer1IyBNKcVfAImjvsclP0DxfaCLqmRNQycFS/\nCo51C2yObihenUfpbYYWUHX9Q7Ji1lLiPaoQoMmD/FRqx4F8IWUjCJR0/d4V\na6ROmHqm4gGpUfKnL2JQ83qpVA+jA2uURpCanvNW6/3Pm2vQq5kyyZJeUg0W\nyeL/rO2pgyiQGdtB2g5MkMTSOGketEf1LBRsVGbxoYFZcyt0sVlXdSn0VvpD\n4SmthxrHEocWOWVm3LrNzQ57l3X6O9oXGjjVQP9tneMYaX0jJt3x4wgt06DN\npHXEgie0sW8oe9+h1xVEN4WMRUBOyzrO5j57nQA+cYB8AHPxJi+Hkd9alX2p\n/eOy\r\n=Pc3c\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-rekognition-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-rekognition-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-rekognition-browser)\n\n## Description\n\nThis is the Amazon Rekognition API reference.
\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-rekognition-browser\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(`RekognitionClient`) and the commands you need, for example `CompareFacesCommand`:\n\n```javascript\n//JavaScript\nconst {\n RekognitionClient,\n CompareFacesCommand\n} = require(\"@aws-sdk/client-rekognition-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n RekognitionClient,\n CompareFacesCommand\n} from \"@aws-sdk/client-rekognition-browser\";\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 rekognition = new RekognitionClient({ region: \"region\" });\n//clients can be shared by different commands\nconst params = {\n SourceImage: {\n /**an object specifying SourceImage*/\n },\n TargetImage: {\n /**an object specifying TargetImage*/\n }\n};\nconst compareFacesCommand = new CompareFacesCommand(params);\nrekognition\n .send(compareFacesCommand)\n .then(data => {\n // do something\n })\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 rekognition.send(compareFacesCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nrekognition.send(compareFacesCommand, (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-rekognition-browser\";\nconst rekognition = new AWS.Rekognition({ region: \"region\" });\nrekognition.compareFaces(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 rekognition.send(compareFacesCommand);\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-rekognition-browser' 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":"karma start karma.conf","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-rekognition-browser has been renamed to @aws-sdk/client-rekognition. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Rekognition","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@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/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.8","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.7","@aws-sdk/signing-middleware":"^0.1.0-preview.9","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.8","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@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","karma":"^4.1.0","rimraf":"^2.6.2","typedoc":"^0.14.2","puppeteer":"^1.0.0","typescript":"~3.4.0","@types/jest":"^24.0.12","jasmine-core":"^3.4.0","karma-jasmine":"^2.0.1","karma-coverage":"^1.1.1","karma-typescript":"^4.0.0","karma-chrome-launcher":"^3.0.0","@aws-sdk/karma-credential-loader":"^0.1.0-preview.9","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-rekognition-browser_0.1.0-preview.5_1572464399558_0.7551170081326242","host":"s3://npm-registry-packages"}},"0.1.0-preview.6":{"name":"@aws-sdk/client-rekognition-browser","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-rekognition-browser@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":"6cd27c692d3d7cc7a9242a7f3fe4d4185600ed8a","tarball":"https://registry.npmjs.org/@aws-sdk/client-rekognition-browser/-/client-rekognition-browser-0.1.0-preview.6.tgz","fileCount":1224,"integrity":"sha512-T8THZVQrIQ0Re7VzUkSUFzXAngn4Km27yWQkmvIxNkhYmCREnyf5EW8DgVAJ6s1iAgbOva2YZoS/4sxO9GRRww==","signatures":[{"sig":"MEUCIQDzeDvAUJozvOH+Iv27E7kJC+Ska4EzR1kRX4cCxkrRYgIgIWpiGUvYrL7RCh5DoI1ws8JekwiQR+MgKEiusHayfZc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":761102,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd1FWFCRA9TVsSAnZWagAARioQAIjKtHvk8fxvSoatdniP\nnF5jYE/1i9IqK4E5lQxnCAdOQFiU1cOFMs2WvSgyZgnExWsVTQHn6HFx0DAh\nz4irErSFSPGjlGJkcYmB5BCgbBxTWTVhLs01xsnvpkwjuOtYupq/OIPcjqHs\nC9pvdYQ+F2WzL7Semdbhh0txTL8pu+VWKP3g220jSgzTVhtjRFOhCeJLOr6m\naSq3F6RkWM642q4JPlb8N5PfiOtIgM4MCES2k4WOmJJ6bvJBcFZUTy2W5hEq\nHm4szUyGjYNUqeeQZs64J31Uep0DYBhvvjcNzOBu59RV0g2NVzLjrJ/mOYRh\nAOLSBF69pyQ9E9ZMlGIKKdda7CqB7vpxR+8AnRkQ5zy/Ao1VfOuTc2iKp0zN\noqNPSocbdUr+/A9qD05RFQYe3OG5BqaU5sqQiRogASFq3lF3GLsVNY9QuLX1\naCa8muOHKMV909ruQA5IdFmzxLeDHMTUi1lhhkALhCNfDIK5BGzyAk7ouHul\nfSXgJMbvgPQ3hKBna6USbWYlejl/6VfVPKooBzI97C5FIEfIFF1P69jMvMBT\nG7e9eiEKkSC66GASoikC/D3j+x9RqBQI71yWELyPnF+1ohmW/taQ7PjYgKFm\ntunPIH00OJuIT6hGQ4e41R5qyGPoEUm5WmpRgrtJaB72BhJqOTSw3L8u4WlB\nP08y\r\n=D8DF\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-rekognition-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-rekognition-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-rekognition-browser)\n\n## Description\n\nThis is the Amazon Rekognition API reference.
\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-rekognition-browser\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(`RekognitionClient`) and the commands you need, for example `CompareFacesCommand`:\n\n```javascript\n//JavaScript\nconst {\n RekognitionClient,\n CompareFacesCommand\n} = require(\"@aws-sdk/client-rekognition-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n RekognitionClient,\n CompareFacesCommand\n} from \"@aws-sdk/client-rekognition-browser\";\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 rekognition = new RekognitionClient({ region: \"region\" });\n//clients can be shared by different commands\nconst params = {\n SourceImage: {\n /**an object specifying SourceImage*/\n },\n TargetImage: {\n /**an object specifying TargetImage*/\n }\n};\nconst compareFacesCommand = new CompareFacesCommand(params);\nrekognition\n .send(compareFacesCommand)\n .then(data => {\n // do something\n })\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 rekognition.send(compareFacesCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nrekognition.send(compareFacesCommand, (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-rekognition-browser\";\nconst rekognition = new AWS.Rekognition({ region: \"region\" });\nrekognition.compareFaces(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 rekognition.send(compareFacesCommand);\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-rekognition-browser' 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":"karma start karma.conf","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-rekognition-browser has been renamed to @aws-sdk/client-rekognition. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Rekognition","directories":{},"_nodeVersion":"10.16.3","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@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/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.9","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.10","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.9","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@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","karma":"^4.1.0","rimraf":"^2.6.2","typedoc":"^0.14.2","puppeteer":"^1.0.0","typescript":"~3.4.0","@types/jest":"^24.0.12","jasmine-core":"^3.4.0","karma-jasmine":"^2.0.1","karma-coverage":"^1.1.1","karma-typescript":"^4.0.0","karma-chrome-launcher":"^3.0.0","@aws-sdk/karma-credential-loader":"^0.1.0-preview.10","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-rekognition-browser_0.1.0-preview.6_1574196613165_0.3419464294736949","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-09-09T18:04:54.029Z","modified":"2025-03-27T18:41:50.465Z","0.1.0-preview.2":"2019-09-09T18:04:54.401Z","0.1.0-preview.3":"2019-09-19T15:56:46.749Z","0.1.0-preview.4":"2019-10-30T00:04:06.711Z","0.1.0-preview.5":"2019-10-30T19:39:59.652Z","0.1.0-preview.6":"2019-11-19T20:50:13.294Z"},"author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","description":"Browser SDK for Amazon Rekognition","maintainers":[{"email":"osa-3p@amazon.com","name":"amzn-oss"},{"email":"aws-sdk-js-automation@amazon.com","name":"aws-sdk-bot"}],"readme":"","readmeFilename":""}