The AWS SDK for JavaScript v2 has reached end-of-support.
We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the announcement.

Class: AWS.Rekognition

Inherits:
AWS.Service show all
Identifier:
rekognition
API Version:
2016-06-27
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Sending a Request Using Rekognition

var rekognition = new AWS.Rekognition();
rekognition.associateFaces(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Rekognition object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var rekognition = new AWS.Rekognition({apiVersion: '2016-06-27'});

You can also set the API version globally in AWS.config.apiVersions using the rekognition service identifier:

AWS.config.apiVersions = {
  rekognition: '2016-06-27',
  // other service API versions
};

var rekognition = new AWS.Rekognition();

Version:

  • 2016-06-27

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

projectVersionTrainingCompleted, projectVersionRunning

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse