@aws-sdk/client-rekognition
Advanced tools
AWS SDK for JavaScript Rekognition Client for Node.js, Browser and React Native
@aws-sdk/client-rekognition is an AWS SDK for JavaScript package that provides a client for Amazon Rekognition, a service that makes it easy to add image and video analysis to your applications. The package allows you to perform a variety of tasks such as object detection, facial analysis, and text recognition.
Detecting Labels in an Image
This feature allows you to detect objects, scenes, and concepts in an image stored in an S3 bucket. The code sample demonstrates how to use the DetectLabelsCommand to get labels for an image.
const { RekognitionClient, DetectLabelsCommand } = require('@aws-sdk/client-rekognition');
const client = new RekognitionClient({ region: 'us-west-2' });
const params = {
Image: {
S3Object: {
Bucket: 'example-bucket',
Name: 'example.jpg'
}
},
MaxLabels: 10
};
const run = async () => {
try {
const data = await client.send(new DetectLabelsCommand(params));
console.log('Labels detected:', data.Labels);
} catch (err) {
console.error('Error:', err);
}
};
run();Facial Analysis
This feature allows you to analyze faces in an image to detect attributes such as age range, emotions, and facial landmarks. The code sample demonstrates how to use the DetectFacesCommand to get detailed facial analysis.
const { RekognitionClient, DetectFacesCommand } = require('@aws-sdk/client-rekognition');
const client = new RekognitionClient({ region: 'us-west-2' });
const params = {
Image: {
S3Object: {
Bucket: 'example-bucket',
Name: 'example.jpg'
}
},
Attributes: ['ALL']
};
const run = async () => {
try {
const data = await client.send(new DetectFacesCommand(params));
console.log('Face details:', data.FaceDetails);
} catch (err) {
console.error('Error:', err);
}
};
run();Text Detection in Images
This feature allows you to detect and recognize text within an image. The code sample demonstrates how to use the DetectTextCommand to extract text from an image stored in an S3 bucket.
const { RekognitionClient, DetectTextCommand } = require('@aws-sdk/client-rekognition');
const client = new RekognitionClient({ region: 'us-west-2' });
const params = {
Image: {
S3Object: {
Bucket: 'example-bucket',
Name: 'example.jpg'
}
}
};
const run = async () => {
try {
const data = await client.send(new DetectTextCommand(params));
console.log('Detected text:', data.TextDetections);
} catch (err) {
console.error('Error:', err);
}
};
run();face-api.js is a JavaScript library for face detection and face recognition in the browser and Node.js. It provides functionalities similar to Amazon Rekognition's facial analysis but is more focused on client-side applications. Unlike @aws-sdk/client-rekognition, it does not require AWS services and can be used offline.
tesseract.js is a JavaScript library that provides OCR (Optical Character Recognition) capabilities. It allows you to recognize text in images, similar to the text detection feature of Amazon Rekognition. However, tesseract.js is an open-source library and does not rely on cloud services, making it suitable for offline use.
opencv4nodejs is a Node.js binding to OpenCV, a popular computer vision library. It provides a wide range of image processing and computer vision functionalities, including object detection and facial recognition. While it offers more flexibility and control compared to @aws-sdk/client-rekognition, it requires more setup and does not provide out-of-the-box cloud integration.
AWS SDK for JavaScript Rekognition Client for Node.js, Browser and React Native.
This is the API Reference for Amazon Rekognition Image, Amazon Rekognition Custom Labels, Amazon Rekognition Stored Video, Amazon Rekognition Streaming Video. It provides descriptions of actions, data types, common parameters, and common errors.
Amazon Rekognition Image
Amazon Rekognition Custom Labels
Amazon Rekognition Video Stored Video
Amazon Rekognition Video Streaming Video
To install the this package, simply type add or install @aws-sdk/client-rekognition using your favorite package manager:
npm install @aws-sdk/client-rekognitionyarn add @aws-sdk/client-rekognitionpnpm add @aws-sdk/client-rekognitionThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the RekognitionClient and
the commands you need, for example ListCollectionsCommand:
// ES5 example
const { RekognitionClient, ListCollectionsCommand } = require("@aws-sdk/client-rekognition");
// ES6+ example
import { RekognitionClient, ListCollectionsCommand } from "@aws-sdk/client-rekognition";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new RekognitionClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListCollectionsCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-rekognition";
const client = new AWS.Rekognition({ region: "REGION" });
// async/await.
try {
const data = await client.listCollections(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listCollections(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listCollections(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-rekognition package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.654.0 (2024-09-18)
launchType and sourceIPs fields to GuardDuty findings. (13c3582)FAQs
AWS SDK for JavaScript Rekognition Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-rekognition receives a total of 160,757 weekly downloads. As such, @aws-sdk/client-rekognition popularity was classified as popular.
We found that @aws-sdk/client-rekognition demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.