You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

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 Amazon Rekognition API reference.

Sending a Request Using Rekognition

var rekognition = new AWS.Rekognition();
rekognition.compareFaces(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

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.Rekognition(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Rekognition object

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

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Rekognition.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Rekognition.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Rekognition.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

compareFaces(params = {}, callback) ⇒ AWS.Request

Compares a face in the source input image with each of the 100 largest faces detected in the target input image.

If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image.

Note: CompareFaces uses machine learning algorithms, which are probabilistic. A false negative is an incorrect prediction that a face in the target image has a low similarity confidence score when compared to the face in the source image. To reduce the probability of false negatives, we recommend that you compare the target image against multiple source images. If you plan to use CompareFaces to make a decision that impacts an individual's rights, privacy, or access to services, we recommend that you pass the result to a human for review and further validation before taking action.

You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.

In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match.

Note: By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter.

CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.

If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation.

If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error.

Note: This is a stateless API operation. That is, data returned by this operation doesn't persist.

For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:CompareFaces action.

Service Reference:

Examples:

To compare two images


/* This operation compares the largest face detected in the source image with each face detected in the target image. */

 var params = {
  SimilarityThreshold: 90, 
  SourceImage: {
   S3Object: {
    Bucket: "mybucket", 
    Name: "mysourceimage"
   }
  }, 
  TargetImage: {
   S3Object: {
    Bucket: "mybucket", 
    Name: "mytargetimage"
   }
  }
 };
 rekognition.compareFaces(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    FaceMatches: [
       {
      Face: {
       BoundingBox: {
        Height: 0.33481481671333313, 
        Left: 0.31888890266418457, 
        Top: 0.4933333396911621, 
        Width: 0.25
       }, 
       Confidence: 99.9991226196289
      }, 
      Similarity: 100
     }
    ], 
    SourceImageFace: {
     BoundingBox: {
      Height: 0.33481481671333313, 
      Left: 0.31888890266418457, 
      Top: 0.4933333396911621, 
      Width: 0.25
     }, 
     Confidence: 99.9991226196289
    }
   }
   */
 });

Calling the compareFaces operation

var params = {
  SourceImage: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  TargetImage: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  QualityFilter: NONE | AUTO | LOW | MEDIUM | HIGH,
  SimilarityThreshold: 'NUMBER_VALUE'
};
rekognition.compareFaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SourceImage — (map)

      The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

      If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

      • Bytes — (Buffer, Typed Array, Blob, String)

        Blob of image bytes up to 5 MBs.

      • S3Object — (map)

        Identifies an S3 object as the image source.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • TargetImage — (map)

      The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

      If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

      • Bytes — (Buffer, Typed Array, Blob, String)

        Blob of image bytes up to 5 MBs.

      • S3Object — (map)

        Identifies an S3 object as the image source.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • SimilarityThreshold — (Float)

      The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

    • QualityFilter — (String)

      A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

      To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

      Possible values include:
      • "NONE"
      • "AUTO"
      • "LOW"
      • "MEDIUM"
      • "HIGH"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SourceImageFace — (map)

        The face in the source image that was used for comparison.

        • BoundingBox — (map)

          Bounding box of the face.

          • Width — (Float)

            Width of the bounding box as a ratio of the overall image width.

          • Height — (Float)

            Height of the bounding box as a ratio of the overall image height.

          • Left — (Float)

            Left coordinate of the bounding box as a ratio of overall image width.

          • Top — (Float)

            Top coordinate of the bounding box as a ratio of overall image height.

        • Confidence — (Float)

          Confidence level that the selected bounding box contains a face.

      • FaceMatches — (Array<map>)

        An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

        • Similarity — (Float)

          Level of confidence that the faces match.

        • Face — (map)

          Provides face metadata (bounding box and confidence that the bounding box actually contains a face).

          • BoundingBox — (map)

            Bounding box of the face.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • Confidence — (Float)

            Level of confidence that what the bounding box contains is a face.

          • Landmarks — (Array<map>)

            An array of facial landmarks.

            • Type — (String)

              Type of landmark.

              Possible values include:
              • "eyeLeft"
              • "eyeRight"
              • "nose"
              • "mouthLeft"
              • "mouthRight"
              • "leftEyeBrowLeft"
              • "leftEyeBrowRight"
              • "leftEyeBrowUp"
              • "rightEyeBrowLeft"
              • "rightEyeBrowRight"
              • "rightEyeBrowUp"
              • "leftEyeLeft"
              • "leftEyeRight"
              • "leftEyeUp"
              • "leftEyeDown"
              • "rightEyeLeft"
              • "rightEyeRight"
              • "rightEyeUp"
              • "rightEyeDown"
              • "noseLeft"
              • "noseRight"
              • "mouthUp"
              • "mouthDown"
              • "leftPupil"
              • "rightPupil"
              • "upperJawlineLeft"
              • "midJawlineLeft"
              • "chinBottom"
              • "midJawlineRight"
              • "upperJawlineRight"
            • X — (Float)

              The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

            • Y — (Float)

              The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

          • Pose — (map)

            Indicates the pose of the face as determined by its pitch, roll, and yaw.

            • Roll — (Float)

              Value representing the face rotation on the roll axis.

            • Yaw — (Float)

              Value representing the face rotation on the yaw axis.

            • Pitch — (Float)

              Value representing the face rotation on the pitch axis.

          • Quality — (map)

            Identifies face image brightness and sharpness.

            • Brightness — (Float)

              Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

            • Sharpness — (Float)

              Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

          • Emotions — (Array<map>)

            The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

            • Type — (String)

              Type of emotion detected.

              Possible values include:
              • "HAPPY"
              • "SAD"
              • "ANGRY"
              • "CONFUSED"
              • "DISGUSTED"
              • "SURPRISED"
              • "CALM"
              • "UNKNOWN"
              • "FEAR"
            • Confidence — (Float)

              Level of confidence in the determination.

          • Smile — (map)

            Indicates whether or not the face is smiling, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face is smiling or not.

            • Confidence — (Float)

              Level of confidence in the determination.

      • UnmatchedFaces — (Array<map>)

        An array of faces in the target image that did not match the source image face.

        • BoundingBox — (map)

          Bounding box of the face.

          • Width — (Float)

            Width of the bounding box as a ratio of the overall image width.

          • Height — (Float)

            Height of the bounding box as a ratio of the overall image height.

          • Left — (Float)

            Left coordinate of the bounding box as a ratio of overall image width.

          • Top — (Float)

            Top coordinate of the bounding box as a ratio of overall image height.

        • Confidence — (Float)

          Level of confidence that what the bounding box contains is a face.

        • Landmarks — (Array<map>)

          An array of facial landmarks.

          • Type — (String)

            Type of landmark.

            Possible values include:
            • "eyeLeft"
            • "eyeRight"
            • "nose"
            • "mouthLeft"
            • "mouthRight"
            • "leftEyeBrowLeft"
            • "leftEyeBrowRight"
            • "leftEyeBrowUp"
            • "rightEyeBrowLeft"
            • "rightEyeBrowRight"
            • "rightEyeBrowUp"
            • "leftEyeLeft"
            • "leftEyeRight"
            • "leftEyeUp"
            • "leftEyeDown"
            • "rightEyeLeft"
            • "rightEyeRight"
            • "rightEyeUp"
            • "rightEyeDown"
            • "noseLeft"
            • "noseRight"
            • "mouthUp"
            • "mouthDown"
            • "leftPupil"
            • "rightPupil"
            • "upperJawlineLeft"
            • "midJawlineLeft"
            • "chinBottom"
            • "midJawlineRight"
            • "upperJawlineRight"
          • X — (Float)

            The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

          • Y — (Float)

            The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

        • Pose — (map)

          Indicates the pose of the face as determined by its pitch, roll, and yaw.

          • Roll — (Float)

            Value representing the face rotation on the roll axis.

          • Yaw — (Float)

            Value representing the face rotation on the yaw axis.

          • Pitch — (Float)

            Value representing the face rotation on the pitch axis.

        • Quality — (map)

          Identifies face image brightness and sharpness.

          • Brightness — (Float)

            Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

          • Sharpness — (Float)

            Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

        • Emotions — (Array<map>)

          The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

          • Type — (String)

            Type of emotion detected.

            Possible values include:
            • "HAPPY"
            • "SAD"
            • "ANGRY"
            • "CONFUSED"
            • "DISGUSTED"
            • "SURPRISED"
            • "CALM"
            • "UNKNOWN"
            • "FEAR"
          • Confidence — (Float)

            Level of confidence in the determination.

        • Smile — (map)

          Indicates whether or not the face is smiling, and the confidence level in the determination.

          • Value — (Boolean)

            Boolean value that indicates whether the face is smiling or not.

          • Confidence — (Float)

            Level of confidence in the determination.

      • SourceImageOrientationCorrection — (String)

        The value of SourceImageOrientationCorrection is always null.

        If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

        Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

        Possible values include:
        • "ROTATE_0"
        • "ROTATE_90"
        • "ROTATE_180"
        • "ROTATE_270"
      • TargetImageOrientationCorrection — (String)

        The value of TargetImageOrientationCorrection is always null.

        If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

        Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

        Possible values include:
        • "ROTATE_0"
        • "ROTATE_90"
        • "ROTATE_180"
        • "ROTATE_270"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCollection(params = {}, callback) ⇒ AWS.Request

Creates a collection in an AWS Region. You can add faces to the collection using the IndexFaces operation.

For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container.

When you create a collection, it is associated with the latest version of the face model version.

Note: Collection names are case-sensitive.

This operation requires permissions to perform the rekognition:CreateCollection action. If you want to tag your collection, you also require permission to perform the rekognition:TagResource operation.

Service Reference:

Examples:

To create a collection


/* This operation creates a Rekognition collection for storing image data. */

 var params = {
  CollectionId: "myphotos"
 };
 rekognition.createCollection(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CollectionArn: "aws:rekognition:us-west-2:123456789012:collection/myphotos", 
    StatusCode: 200
   }
   */
 });

Calling the createCollection operation

var params = {
  CollectionId: 'STRING_VALUE', /* required */
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
rekognition.createCollection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CollectionId — (String)

      ID for the collection that you are creating.

    • Tags — (map<String>)

      A set of tags (key-value pairs) that you want to attach to the collection.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StatusCode — (Integer)

        HTTP status code indicating the result of the operation.

      • CollectionArn — (String)

        Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.

      • FaceModelVersion — (String)

        Version number of the face detection model associated with the collection you are creating.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDataset(params = {}, callback) ⇒ AWS.Request

Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.

To create a training dataset for a project, specify train for the value of DatasetType. To create the test dataset for a project, specify test for the value of DatasetType.

The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete. Use DescribeDataset to check the current status. The dataset created successfully if the value of Status is CREATE_COMPLETE.

To check if any non-terminal errors occurred, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.

Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). Currently, you can't access the terminal error information.

For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.

This operation requires permissions to perform the rekognition:CreateDataset action. If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.

Service Reference:

Examples:

Calling the createDataset operation

var params = {
  DatasetType: TRAIN | TEST, /* required */
  ProjectArn: 'STRING_VALUE', /* required */
  DatasetSource: {
    DatasetArn: 'STRING_VALUE',
    GroundTruthManifest: {
      S3Object: {
        Bucket: 'STRING_VALUE',
        Name: 'STRING_VALUE',
        Version: 'STRING_VALUE'
      }
    }
  }
};
rekognition.createDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetSource — (map)

      The source files for the dataset. You can specify the ARN of an existing dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker format manifest file. If you don't specify datasetSource, an empty dataset is created. To add labeled images to the dataset, You can use the console or call UpdateDatasetEntries.

      • GroundTruthManifest — (map)

        The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

        • S3Object — (map)

          Provides the S3 bucket name and object name.

          The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

          For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

          • Bucket — (String)

            Name of the S3 bucket.

          • Name — (String)

            S3 object key name.

          • Version — (String)

            If the bucket is versioning enabled, you can specify the object version.

      • DatasetArn — (String)

        The ARN of an Amazon Rekognition Custom Labels dataset that you want to copy.

    • DatasetType — (String)

      The type of the dataset. Specify train to create a training dataset. Specify test to create a test dataset.

      Possible values include:
      • "TRAIN"
      • "TEST"
    • ProjectArn — (String)

      The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetArn — (String)

        The ARN of the created Amazon Rekognition Custom Labels dataset.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createProject(params = {}, callback) ⇒ AWS.Request

Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions) that you use to create and manage Amazon Rekognition Custom Labels models.

This operation requires permissions to perform the rekognition:CreateProject action.

Service Reference:

Examples:

Calling the createProject operation

var params = {
  ProjectName: 'STRING_VALUE' /* required */
};
rekognition.createProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProjectName — (String)

      The name of the project to create.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProjectArn — (String)

        The Amazon Resource Name (ARN) of the new project. You can use the ARN to configure IAM access to the project.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createProjectVersion(params = {}, callback) ⇒ AWS.Request

Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom Labels project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the version of the model.

Training uses the training and test datasets associated with the project. For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.

Note: You can train a modelin a project that doesn't have associated datasets by specifying manifest files in the TrainingData and TestingData fields. If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files. Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project.

Training takes a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the Status field is TRAINING_COMPLETED.

If training fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.

Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels developers guide.

After evaluating the model, you start the model by calling StartProjectVersion.

This operation requires permissions to perform the rekognition:CreateProjectVersion action.

Service Reference:

Examples:

Calling the createProjectVersion operation

var params = {
  OutputConfig: { /* required */
    S3Bucket: 'STRING_VALUE',
    S3KeyPrefix: 'STRING_VALUE'
  },
  ProjectArn: 'STRING_VALUE', /* required */
  VersionName: 'STRING_VALUE', /* required */
  KmsKeyId: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  TestingData: {
    Assets: [
      {
        GroundTruthManifest: {
          S3Object: {
            Bucket: 'STRING_VALUE',
            Name: 'STRING_VALUE',
            Version: 'STRING_VALUE'
          }
        }
      },
      /* more items */
    ],
    AutoCreate: true || false
  },
  TrainingData: {
    Assets: [
      {
        GroundTruthManifest: {
          S3Object: {
            Bucket: 'STRING_VALUE',
            Name: 'STRING_VALUE',
            Version: 'STRING_VALUE'
          }
        }
      },
      /* more items */
    ]
  }
};
rekognition.createProjectVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProjectArn — (String)

      The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.

    • VersionName — (String)

      A name for the version of the model. This value must be unique.

    • OutputConfig — (map)

      The Amazon S3 bucket location to store the results of training. The S3 bucket can be in any AWS account as long as the caller has s3:PutObject permissions on the S3 bucket.

      • S3Bucket — (String)

        The S3 bucket where training output is placed.

      • S3KeyPrefix — (String)

        The prefix applied to the training output files.

    • TrainingData — (map)

      Specifies an external manifest that the services uses to train the model. If you specify TrainingData you must also specify TestingData. The project must not have any associated datasets.

      • Assets — (Array<map>)

        A Sagemaker GroundTruth manifest file that contains the training images (assets).

        • GroundTruthManifest — (map)

          The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

          • S3Object — (map)

            Provides the S3 bucket name and object name.

            The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

            For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

            • Bucket — (String)

              Name of the S3 bucket.

            • Name — (String)

              S3 object key name.

            • Version — (String)

              If the bucket is versioning enabled, you can specify the object version.

    • TestingData — (map)

      Specifies an external manifest that the service uses to test the model. If you specify TestingData you must also specify TrainingData. The project must not have any associated datasets.

      • Assets — (Array<map>)

        The assets used for testing.

        • GroundTruthManifest — (map)

          The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

          • S3Object — (map)

            Provides the S3 bucket name and object name.

            The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

            For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

            • Bucket — (String)

              Name of the S3 bucket.

            • Name — (String)

              S3 object key name.

            • Version — (String)

              If the bucket is versioning enabled, you can specify the object version.

      • AutoCreate — (Boolean)

        If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job. After training completes, the test dataset is not stored and the training dataset reverts to its previous size.

    • Tags — (map<String>)

      A set of tags (key-value pairs) that you want to attach to the model.

    • KmsKeyId — (String)

      The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig).

      If you choose to use your own KMS key, you need the following permissions on the KMS key.

      • kms:CreateGrant

      • kms:DescribeKey

      • kms:GenerateDataKey

      • kms:Decrypt

      If you don't specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProjectVersionArn — (String)

        The ARN of the model version that was created. Use DescribeProjectVersion to get the current status of the training operation.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createStreamProcessor(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.

You provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field.

After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. You can delete the stream processor by calling DeleteStreamProcessor.

This operation requires permissions to perform the rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.

Service Reference:

Examples:

Calling the createStreamProcessor operation

var params = {
  Input: { /* required */
    KinesisVideoStream: {
      Arn: 'STRING_VALUE'
    }
  },
  Name: 'STRING_VALUE', /* required */
  Output: { /* required */
    KinesisDataStream: {
      Arn: 'STRING_VALUE'
    }
  },
  RoleArn: 'STRING_VALUE', /* required */
  Settings: { /* required */
    FaceSearch: {
      CollectionId: 'STRING_VALUE',
      FaceMatchThreshold: 'NUMBER_VALUE'
    }
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
rekognition.createStreamProcessor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Input — (map)

      Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.

      • KinesisVideoStream — (map)

        The Kinesis video stream input stream for the source streaming video.

        • Arn — (String)

          ARN of the Kinesis video stream stream that streams the source video.

    • Output — (map)

      Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.

      • KinesisDataStream — (map)

        The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.

        • Arn — (String)

          ARN of the output Amazon Kinesis Data Streams stream.

    • Name — (String)

      An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor. Name is idempotent.

    • Settings — (map)

      Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

      • FaceSearch — (map)

        Face search settings to use on a streaming video.

        • CollectionId — (String)

          The ID of a collection that contains faces that you want to search for.

        • FaceMatchThreshold — (Float)

          Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.

    • RoleArn — (String)

      ARN of the IAM role that allows access to the stream processor.

    • Tags — (map<String>)

      A set of tags (key-value pairs) that you want to attach to the stream processor.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StreamProcessorArn — (String)

        ARN for the newly create stream processor.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteCollection(params = {}, callback) ⇒ AWS.Request

Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure.

This operation requires permissions to perform the rekognition:DeleteCollection action.

Service Reference:

Examples:

To delete a collection


/* This operation deletes a Rekognition collection. */

 var params = {
  CollectionId: "myphotos"
 };
 rekognition.deleteCollection(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    StatusCode: 200
   }
   */
 });

Calling the deleteCollection operation

var params = {
  CollectionId: 'STRING_VALUE' /* required */
};
rekognition.deleteCollection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CollectionId — (String)

      ID of the collection to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StatusCode — (Integer)

        HTTP status code that indicates the result of the operation.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDataset(params = {}, callback) ⇒ AWS.Request

Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset might take while. Use DescribeDataset to check the current status. The dataset is still deleting if the value of Status is DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get a ResourceNotFoundException exception.

You can't delete a dataset while it is creating (Status = CREATE_IN_PROGRESS) or if the dataset is updating (Status = UPDATE_IN_PROGRESS).

This operation requires permissions to perform the rekognition:DeleteDataset action.

Service Reference:

Examples:

Calling the deleteDataset operation

var params = {
  DatasetArn: 'STRING_VALUE' /* required */
};
rekognition.deleteDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetArn — (String)

      The ARN of the Amazon Rekognition Custom Labels dataset that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteFaces(params = {}, callback) ⇒ AWS.Request

Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.

This operation requires permissions to perform the rekognition:DeleteFaces action.

Service Reference:

Examples:

To delete a face


/* This operation deletes one or more faces from a Rekognition collection. */

 var params = {
  CollectionId: "myphotos", 
  FaceIds: [
     "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
  ]
 };
 rekognition.deleteFaces(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DeletedFaces: [
       "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
    ]
   }
   */
 });

Calling the deleteFaces operation

var params = {
  CollectionId: 'STRING_VALUE', /* required */
  FaceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
rekognition.deleteFaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CollectionId — (String)

      Collection from which to remove the specific faces.

    • FaceIds — (Array<String>)

      An array of face IDs to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeletedFaces — (Array<String>)

        An array of strings (face IDs) of the faces that were deleted.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteProject(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated with the project. To delete a model, see DeleteProjectVersion.

DeleteProject is an asynchronous operation. To check if the project is deleted, call DescribeProjects. The project is deleted when the project no longer appears in the response.

This operation requires permissions to perform the rekognition:DeleteProject action.

Service Reference:

Examples:

Calling the deleteProject operation

var params = {
  ProjectArn: 'STRING_VALUE' /* required */
};
rekognition.deleteProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProjectArn — (String)

      The Amazon Resource Name (ARN) of the project that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (String)

        The current status of the delete project operation.

        Possible values include:
        • "CREATING"
        • "CREATED"
        • "DELETING"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteProjectVersion(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Rekognition Custom Labels model.

You can't delete a model if it is running or if it is training. To check the status of a model, use the Status field returned from DescribeProjectVersions. To stop a running model call StopProjectVersion. If the model is training, wait until it finishes.

This operation requires permissions to perform the rekognition:DeleteProjectVersion action.

Service Reference:

Examples:

Calling the deleteProjectVersion operation

var params = {
  ProjectVersionArn: 'STRING_VALUE' /* required */
};
rekognition.deleteProjectVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProjectVersionArn — (String)

      The Amazon Resource Name (ARN) of the model version that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (String)

        The status of the deletion operation.

        Possible values include:
        • "TRAINING_IN_PROGRESS"
        • "TRAINING_COMPLETED"
        • "TRAINING_FAILED"
        • "STARTING"
        • "RUNNING"
        • "FAILED"
        • "STOPPING"
        • "STOPPED"
        • "DELETING"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteStreamProcessor(params = {}, callback) ⇒ AWS.Request

Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor.

Service Reference:

Examples:

Calling the deleteStreamProcessor operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
rekognition.deleteStreamProcessor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      The name of the stream processor you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeCollection(params = {}, callback) ⇒ AWS.Request

Describes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection.

For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.

Service Reference:

Examples:

Calling the describeCollection operation

var params = {
  CollectionId: 'STRING_VALUE' /* required */
};
rekognition.describeCollection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CollectionId — (String)

      The ID of the collection to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FaceCount — (Integer)

        The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.

      • FaceModelVersion — (String)

        The version of the face model that's used by the collection for face detection.

        For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

      • CollectionARN — (String)

        The Amazon Resource Name (ARN) of the collection.

      • CreationTimestamp — (Date)

        The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDataset(params = {}, callback) ⇒ AWS.Request

Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and statistics about the images and labels in a dataset.

This operation requires permissions to perform the rekognition:DescribeDataset action.

Service Reference:

Examples:

Calling the describeDataset operation

var params = {
  DatasetArn: 'STRING_VALUE' /* required */
};
rekognition.describeDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetArn — (String)

      The Amazon Resource Name (ARN) of the dataset that you want to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetDescription — (map)

        The description for the dataset.

        • CreationTimestamp — (Date)

          The Unix timestamp for the time and date that the dataset was created.

        • LastUpdatedTimestamp — (Date)

          The Unix timestamp for the date and time that the dataset was last updated.

        • Status — (String)

          The status of the dataset.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_COMPLETE"
          • "CREATE_FAILED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_COMPLETE"
          • "UPDATE_FAILED"
          • "DELETE_IN_PROGRESS"
        • StatusMessage — (String)

          The status message for the dataset.

        • StatusMessageCode — (String)

          The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.

          Possible values include:
          • "SUCCESS"
          • "SERVICE_ERROR"
          • "CLIENT_ERROR"
        • DatasetStats — (map)

          The status message code for the dataset.

          • LabeledEntries — (Integer)

            The total number of images in the dataset that have labels.

          • TotalEntries — (Integer)

            The total number of images in the dataset.

          • TotalLabels — (Integer)

            The total number of labels declared in the dataset.

          • ErrorEntries — (Integer)

            The total number of entries that contain at least one error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeProjects(params = {}, callback) ⇒ AWS.Request

Gets information about your Amazon Rekognition Custom Labels projects.

This operation requires permissions to perform the rekognition:DescribeProjects action.

Service Reference:

Examples:

Calling the describeProjects operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProjectNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
rekognition.describeProjects(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

    • ProjectNames — (Array<String>)

      A list of the projects that you want Amazon Rekognition Custom Labels to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProjectDescriptions — (Array<map>)

        A list of project descriptions. The list is sorted by the date and time the projects are created.

        • ProjectArn — (String)

          The Amazon Resource Name (ARN) of the project.

        • CreationTimestamp — (Date)

          The Unix timestamp for the date and time that the project was created.

        • Status — (String)

          The current status of the project.

          Possible values include:
          • "CREATING"
          • "CREATED"
          • "DELETING"
        • Datasets — (Array<map>)

          Information about the training and test datasets in the project.

          • CreationTimestamp — (Date)

            The Unix timestamp for the date and time that the dataset was created.

          • DatasetType — (String)

            The type of the dataset.

            Possible values include:
            • "TRAIN"
            • "TEST"
          • DatasetArn — (String)

            The Amazon Resource Name (ARN) for the dataset.

          • Status — (String)

            The status for the dataset.

            Possible values include:
            • "CREATE_IN_PROGRESS"
            • "CREATE_COMPLETE"
            • "CREATE_FAILED"
            • "UPDATE_IN_PROGRESS"
            • "UPDATE_COMPLETE"
            • "UPDATE_FAILED"
            • "DELETE_IN_PROGRESS"
          • StatusMessage — (String)

            The status message for the dataset.

          • StatusMessageCode — (String)

            The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.

            Possible values include:
            • "SUCCESS"
            • "SERVICE_ERROR"
            • "CLIENT_ERROR"
      • NextToken — (String)

        If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeProjectVersions(params = {}, callback) ⇒ AWS.Request

Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You can specify up to 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all model versions in the project are returned.

This operation requires permissions to perform the rekognition:DescribeProjectVersions action.

Service Reference:

Examples:

Calling the describeProjectVersions operation

var params = {
  ProjectArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  VersionNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
rekognition.describeProjectVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProjectArn — (String)

      The Amazon Resource Name (ARN) of the project that contains the models you want to describe.

    • VersionNames — (Array<String>)

      A list of model version names that you want to describe. You can add up to 10 model version names to the list. If you don't specify a value, all model descriptions are returned. A version name is part of a model (ProjectVersion) ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the following ARN. arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.

    • NextToken — (String)

      If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProjectVersionDescriptions — (Array<map>)

        A list of model descriptions. The list is sorted by the creation date and time of the model versions, latest to earliest.

        • ProjectVersionArn — (String)

          The Amazon Resource Name (ARN) of the model version.

        • CreationTimestamp — (Date)

          The Unix datetime for the date and time that training started.

        • MinInferenceUnits — (Integer)

          The minimum number of inference units used by the model. For more information, see StartProjectVersion.

        • Status — (String)

          The current status of the model version.

          Possible values include:
          • "TRAINING_IN_PROGRESS"
          • "TRAINING_COMPLETED"
          • "TRAINING_FAILED"
          • "STARTING"
          • "RUNNING"
          • "FAILED"
          • "STOPPING"
          • "STOPPED"
          • "DELETING"
        • StatusMessage — (String)

          A descriptive message for an error or warning that occurred.

        • BillableTrainingTimeInSeconds — (Integer)

          The duration, in seconds, that you were billed for a successful training of the model version. This value is only returned if the model version has been successfully trained.

        • TrainingEndTimestamp — (Date)

          The Unix date and time that training of the model ended.

        • OutputConfig — (map)

          The location where training results are saved.

          • S3Bucket — (String)

            The S3 bucket where training output is placed.

          • S3KeyPrefix — (String)

            The prefix applied to the training output files.

        • TrainingDataResult — (map)

          Contains information about the training results.

          • Input — (map)

            The training assets that you supplied for training.

            • Assets — (Array<map>)

              A Sagemaker GroundTruth manifest file that contains the training images (assets).

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

          • Output — (map)

            The images (assets) that were actually trained by Amazon Rekognition Custom Labels.

            • Assets — (Array<map>)

              A Sagemaker GroundTruth manifest file that contains the training images (assets).

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

          • Validation — (map)

            The location of the data validation manifest. The data validation manifest is created for the training dataset during model training.

            • Assets — (Array<map>)

              The assets that comprise the validation data.

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

        • TestingDataResult — (map)

          Contains information about the testing results.

          • Input — (map)

            The testing dataset that was supplied for training.

            • Assets — (Array<map>)

              The assets used for testing.

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

            • AutoCreate — (Boolean)

              If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job. After training completes, the test dataset is not stored and the training dataset reverts to its previous size.

          • Output — (map)

            The subset of the dataset that was actually tested. Some images (assets) might not be tested due to file formatting and other issues.

            • Assets — (Array<map>)

              The assets used for testing.

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

            • AutoCreate — (Boolean)

              If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job. After training completes, the test dataset is not stored and the training dataset reverts to its previous size.

          • Validation — (map)

            The location of the data validation manifest. The data validation manifest is created for the test dataset during model training.

            • Assets — (Array<map>)

              The assets that comprise the validation data.

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

        • EvaluationResult — (map)

          The training results. EvaluationResult is only returned if training is successful.

          • F1Score — (Float)

            The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision and recall performance of the model as a single value. A higher value indicates better precision and recall performance. A lower score indicates that precision, recall, or both are performing poorly.

          • Summary — (map)

            The S3 bucket that contains the training summary.

            • S3Object — (map)

              Provides the S3 bucket name and object name.

              The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

              For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

              • Bucket — (String)

                Name of the S3 bucket.

              • Name — (String)

                S3 object key name.

              • Version — (String)

                If the bucket is versioning enabled, you can specify the object version.

        • ManifestSummary — (map)

          The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.

          • S3Object — (map)

            Provides the S3 bucket name and object name.

            The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

            For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

            • Bucket — (String)

              Name of the S3 bucket.

            • Name — (String)

              S3 object key name.

            • Version — (String)

              If the bucket is versioning enabled, you can specify the object version.

        • KmsKeyId — (String)

          The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.

      • NextToken — (String)

        If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeStreamProcessor(params = {}, callback) ⇒ AWS.Request

Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.

Service Reference:

Examples:

Calling the describeStreamProcessor operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
rekognition.describeStreamProcessor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      Name of the stream processor for which you want information.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Name — (String)

        Name of the stream processor.

      • StreamProcessorArn — (String)

        ARN of the stream processor.

      • Status — (String)

        Current status of the stream processor.

        Possible values include:
        • "STOPPED"
        • "STARTING"
        • "RUNNING"
        • "FAILED"
        • "STOPPING"
      • StatusMessage — (String)

        Detailed status message about the stream processor.

      • CreationTimestamp — (Date)

        Date and time the stream processor was created

      • LastUpdateTimestamp — (Date)

        The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.

      • Input — (map)

        Kinesis video stream that provides the source streaming video.

        • KinesisVideoStream — (map)

          The Kinesis video stream input stream for the source streaming video.

          • Arn — (String)

            ARN of the Kinesis video stream stream that streams the source video.

      • Output — (map)

        Kinesis data stream to which Amazon Rekognition Video puts the analysis results.

        • KinesisDataStream — (map)

          The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.

          • Arn — (String)

            ARN of the output Amazon Kinesis Data Streams stream.

      • RoleArn — (String)

        ARN of the IAM role that allows access to the stream processor.

      • Settings — (map)

        Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

        • FaceSearch — (map)

          Face search settings to use on a streaming video.

          • CollectionId — (String)

            The ID of a collection that contains faces that you want to search for.

          • FaceMatchThreshold — (Float)

            Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

detectCustomLabels(params = {}, callback) ⇒ AWS.Request

Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.

You specify which version of a model version to use by using the ProjectVersionArn input parameter.

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

For each object that the model version detects on an image, the API returns a (CustomLabel) object in an array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of confidence that the image contains the object (Confidence), and object location information, if it exists, for the label on the image (Geometry).

To filter labels that are returned, specify a value for MinConfidence. DetectCustomLabelsLabels only returns labels with a confidence that's higher than the specified value. The value of MinConfidence maps to the assumed threshold values created during training. For more information, see Assumed threshold in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence responses from DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change the precision and recall or your model. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.

This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectCustomLabels action.

For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

Service Reference:

Examples:

Calling the detectCustomLabels operation

var params = {
  Image: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  ProjectVersionArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  MinConfidence: 'NUMBER_VALUE'
};
rekognition.detectCustomLabels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProjectVersionArn — (String)

      The ARN of the model version that you want to use.

    • Image — (map)

      Provides the input image either as bytes or an S3 object.

      You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.

      For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.

      You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.

      The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

      If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.

      For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.

      • Bytes — (Buffer, Typed Array, Blob, String)

        Blob of image bytes up to 5 MBs.

      • S3Object — (map)

        Identifies an S3 object as the image source.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • MaxResults — (Integer)

      Maximum number of results you want the service to return in the response. The service returns the specified number of highest confidence labels ranked from highest confidence to lowest.

    • MinConfidence — (Float)

      Specifies the minimum confidence level for the labels to return. DetectCustomLabels doesn't return any labels with a confidence value that's lower than this specified value. If you specify a value of 0, DetectCustomLabels returns all labels, regardless of the assumed threshold applied to each label. If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CustomLabels — (Array<map>)

        An array of custom labels detected in the input image.

        • Name — (String)

          The name of the custom label.

        • Confidence — (Float)

          The confidence that the model has in the detection of the custom label. The range is 0-100. A higher value indicates a higher confidence.

        • Geometry — (map)

          The location of the detected object on the image that corresponds to the custom label. Includes an axis aligned coarse bounding box surrounding the object and a finer grain polygon for more accurate spatial information.

          • BoundingBox — (map)

            An axis-aligned coarse representation of the detected item's location on the image.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • Polygon — (Array<map>)

            Within the bounding box, a fine-grained polygon around the detected item.

            • X — (Float)

              The value of the X coordinate for a point on a Polygon.

            • Y — (Float)

              The value of the Y coordinate for a point on a Polygon.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

detectFaces(params = {}, callback) ⇒ AWS.Request

Detects faces within an image that is provided as input.

DetectFaces detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of beard, sunglasses, and so on.

The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

Note: This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectFaces action.

Service Reference:

Examples:

To detect faces in an image


/* This operation detects faces in an image stored in an AWS S3 bucket. */

 var params = {
  Image: {
   S3Object: {
    Bucket: "mybucket", 
    Name: "myphoto"
   }
  }
 };
 rekognition.detectFaces(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    FaceDetails: [
       {
      BoundingBox: {
       Height: 0.18000000715255737, 
       Left: 0.5555555820465088, 
       Top: 0.33666667342185974, 
       Width: 0.23999999463558197
      }, 
      Confidence: 100, 
      Landmarks: [
         {
        Type: "eyeLeft", 
        X: 0.6394737362861633, 
        Y: 0.40819624066352844
       }, 
         {
        Type: "eyeRight", 
        X: 0.7266660928726196, 
        Y: 0.41039225459098816
       }, 
         {
        Type: "eyeRight", 
        X: 0.6912462115287781, 
        Y: 0.44240960478782654
       }, 
         {
        Type: "mouthDown", 
        X: 0.6306198239326477, 
        Y: 0.46700039505958557
       }, 
         {
        Type: "mouthUp", 
        X: 0.7215608954429626, 
        Y: 0.47114261984825134
       }
      ], 
      Pose: {
       Pitch: 4.050806522369385, 
       Roll: 0.9950747489929199, 
       Yaw: 13.693790435791016
      }, 
      Quality: {
       Brightness: 37.60169982910156, 
       Sharpness: 80
      }
     }
    ], 
    OrientationCorrection: "ROTATE_0"
   }
   */
 });

Calling the detectFaces operation

var params = {
  Image: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  Attributes: [
    DEFAULT | ALL,
    /* more items */
  ]
};
rekognition.detectFaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Image — (map)

      The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

      If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

      • Bytes — (Buffer, Typed Array, Blob, String)

        Blob of image bytes up to 5 MBs.

      • S3Object — (map)

        Identifies an S3 object as the image source.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • Attributes — (Array<String>)

      An array of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete.

      If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FaceDetails — (Array<map>)

        Details of each face found in the image.

        • BoundingBox — (map)

          Bounding box of the face. Default attribute.

          • Width — (Float)

            Width of the bounding box as a ratio of the overall image width.

          • Height — (Float)

            Height of the bounding box as a ratio of the overall image height.

          • Left — (Float)

            Left coordinate of the bounding box as a ratio of overall image width.

          • Top — (Float)

            Top coordinate of the bounding box as a ratio of overall image height.

        • AgeRange — (map)

          The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

          • Low — (Integer)

            The lowest estimated age.

          • High — (Integer)

            The highest estimated age.

        • Smile — (map)

          Indicates whether or not the face is smiling, and the confidence level in the determination.

          • Value — (Boolean)

            Boolean value that indicates whether the face is smiling or not.

          • Confidence — (Float)

            Level of confidence in the determination.

        • Eyeglasses — (map)

          Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

          • Value — (Boolean)

            Boolean value that indicates whether the face is wearing eye glasses or not.

          • Confidence — (Float)

            Level of confidence in the determination.

        • Sunglasses — (map)

          Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

          • Value — (Boolean)

            Boolean value that indicates whether the face is wearing sunglasses or not.

          • Confidence — (Float)

            Level of confidence in the determination.

        • Gender — (map)

          The predicted gender of a detected face.

          • Value — (String)

            The predicted gender of the face.

            Possible values include:
            • "Male"
            • "Female"
          • Confidence — (Float)

            Level of confidence in the prediction.

        • Beard — (map)

          Indicates whether or not the face has a beard, and the confidence level in the determination.

          • Value — (Boolean)

            Boolean value that indicates whether the face has beard or not.

          • Confidence — (Float)

            Level of confidence in the determination.

        • Mustache — (map)

          Indicates whether or not the face has a mustache, and the confidence level in the determination.

          • Value — (Boolean)

            Boolean value that indicates whether the face has mustache or not.

          • Confidence — (Float)

            Level of confidence in the determination.

        • EyesOpen — (map)

          Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

          • Value — (Boolean)

            Boolean value that indicates whether the eyes on the face are open.

          • Confidence — (Float)

            Level of confidence in the determination.

        • MouthOpen — (map)

          Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

          • Value — (Boolean)

            Boolean value that indicates whether the mouth on the face is open or not.

          • Confidence — (Float)

            Level of confidence in the determination.

        • Emotions — (Array<map>)

          The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

          • Type — (String)

            Type of emotion detected.

            Possible values include:
            • "HAPPY"
            • "SAD"
            • "ANGRY"
            • "CONFUSED"
            • "DISGUSTED"
            • "SURPRISED"
            • "CALM"
            • "UNKNOWN"
            • "FEAR"
          • Confidence — (Float)

            Level of confidence in the determination.

        • Landmarks — (Array<map>)

          Indicates the location of landmarks on the face. Default attribute.

          • Type — (String)

            Type of landmark.

            Possible values include:
            • "eyeLeft"
            • "eyeRight"
            • "nose"
            • "mouthLeft"
            • "mouthRight"
            • "leftEyeBrowLeft"
            • "leftEyeBrowRight"
            • "leftEyeBrowUp"
            • "rightEyeBrowLeft"
            • "rightEyeBrowRight"
            • "rightEyeBrowUp"
            • "leftEyeLeft"
            • "leftEyeRight"
            • "leftEyeUp"
            • "leftEyeDown"
            • "rightEyeLeft"
            • "rightEyeRight"
            • "rightEyeUp"
            • "rightEyeDown"
            • "noseLeft"
            • "noseRight"
            • "mouthUp"
            • "mouthDown"
            • "leftPupil"
            • "rightPupil"
            • "upperJawlineLeft"
            • "midJawlineLeft"
            • "chinBottom"
            • "midJawlineRight"
            • "upperJawlineRight"
          • X — (Float)

            The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

          • Y — (Float)

            The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

        • Pose — (map)

          Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

          • Roll — (Float)

            Value representing the face rotation on the roll axis.

          • Yaw — (Float)

            Value representing the face rotation on the yaw axis.

          • Pitch — (Float)

            Value representing the face rotation on the pitch axis.

        • Quality — (map)

          Identifies image brightness and sharpness. Default attribute.

          • Brightness — (Float)

            Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

          • Sharpness — (Float)

            Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

        • Confidence — (Float)

          Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.

      • OrientationCorrection — (String)

        The value of OrientationCorrection is always null.

        If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

        Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

        Possible values include:
        • "ROTATE_0"
        • "ROTATE_90"
        • "ROTATE_180"
        • "ROTATE_270"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

detectLabels(params = {}, callback) ⇒ AWS.Request

Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.

For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.

Note: DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

In this example, the detection algorithm more precisely identifies the flower as a tulip.

In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned.

Note: If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.

DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected.

DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectLabels action.

Service Reference:

Examples:

To detect labels


/* This operation detects labels in the supplied image */

 var params = {
  Image: {
   S3Object: {
    Bucket: "mybucket", 
    Name: "myphoto"
   }
  }, 
  MaxLabels: 123, 
  MinConfidence: 70
 };
 rekognition.detectLabels(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Labels: [
       {
      Confidence: 99.25072479248047, 
      Name: "People"
     }, 
       {
      Confidence: 99.25074005126953, 
      Name: "Person"
     }
    ]
   }
   */
 });

Calling the detectLabels operation

var params = {
  Image: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  MaxLabels: 'NUMBER_VALUE',
  MinConfidence: 'NUMBER_VALUE'
};
rekognition.detectLabels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Image — (map)

      The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.

      If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

      • Bytes — (Buffer, Typed Array, Blob, String)

        Blob of image bytes up to 5 MBs.

      • S3Object — (map)

        Identifies an S3 object as the image source.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • MaxLabels — (Integer)

      Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

    • MinConfidence — (Float)

      Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

      If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Labels — (Array<map>)

        An array of labels for the real-world objects detected.

        • Name — (String)

          The name (label) of the object or scene.

        • Confidence — (Float)

          Level of confidence.

        • Instances — (Array<map>)

          If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.

          • BoundingBox — (map)

            The position of the label instance on the image.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • Confidence — (Float)

            The confidence that Amazon Rekognition has in the accuracy of the bounding box.

        • Parents — (Array<map>)

          The parent labels for a label. The response includes all ancestor labels.

          • Name — (String)

            The name of the parent label.

      • OrientationCorrection — (String)

        The value of OrientationCorrection is always null.

        If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

        Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

        Possible values include:
        • "ROTATE_0"
        • "ROTATE_90"
        • "ROTATE_180"
        • "ROTATE_270"
      • LabelModelVersion — (String)

        Version number of the label detection model that was used to detect labels.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

detectModerationLabels(params = {}, callback) ⇒ AWS.Request

Detects unsafe content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.

To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate.

For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

Service Reference:

Examples:

Calling the detectModerationLabels operation

var params = {
  Image: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  HumanLoopConfig: {
    FlowDefinitionArn: 'STRING_VALUE', /* required */
    HumanLoopName: 'STRING_VALUE', /* required */
    DataAttributes: {
      ContentClassifiers: [
        FreeOfPersonallyIdentifiableInformation | FreeOfAdultContent,
        /* more items */
      ]
    }
  },
  MinConfidence: 'NUMBER_VALUE'
};
rekognition.detectModerationLabels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Image — (map)

      The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

      If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

      • Bytes — (Buffer, Typed Array, Blob, String)

        Blob of image bytes up to 5 MBs.

      • S3Object — (map)

        Identifies an S3 object as the image source.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • MinConfidence — (Float)

      Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.

      If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

    • HumanLoopConfig — (map)

      Sets up the configuration for human evaluation, including the FlowDefinition the image will be sent to.

      • HumanLoopName — required — (String)

        The name of the human review used for this image. This should be kept unique within a region.

      • FlowDefinitionArn — required — (String)

        The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by using the Amazon Sagemaker CreateFlowDefinition Operation.

      • DataAttributes — (map)

        Sets attributes of the input data.

        • ContentClassifiers — (Array<String>)

          Sets whether the input image is free of personally identifiable information.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ModerationLabels — (Array<map>)

        Array of detected Moderation labels and the time, in milliseconds from the start of the video, they were detected.

        • Confidence — (Float)

          Specifies the confidence that Amazon Rekognition has that the label has been correctly identified.

          If you don't specify the MinConfidence parameter in the call to DetectModerationLabels, the operation returns labels with a confidence value greater than or equal to 50 percent.

        • Name — (String)

          The label name for the type of unsafe content detected in the image.

        • ParentName — (String)

          The name for the parent label. Labels at the top level of the hierarchy have the parent label "".

      • ModerationModelVersion — (String)

        Version number of the moderation detection model that was used to detect unsafe content.

      • HumanLoopActivationOutput — (map)

        Shows the results of the human in the loop evaluation.

        • HumanLoopArn — (String)

          The Amazon Resource Name (ARN) of the HumanLoop created.

        • HumanLoopActivationReasons — (Array<String>)

          Shows if and why human review was needed.

        • HumanLoopActivationConditionsEvaluationResults — (String)

          Shows the result of condition evaluations, including those conditions which activated a human review.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

detectProtectiveEquipment(params = {}, callback) ⇒ AWS.Request

Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the following types of PPE.

  • Face cover

  • Hand cover

  • Head cover

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPG formatted file.

DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.

For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand). For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE covers the body part. The API returns the confidence it has in each detection (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected person and each detected item of PPE.

You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter. The summary provides the following information.

  • The persons detected as wearing all of the types of PPE that you specify.

  • The persons detected as not wearing all of the types PPE that you specify.

  • The persons detected where PPE adornment could not be determined.

This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectProtectiveEquipment action.

Service Reference:

Examples:

Calling the detectProtectiveEquipment operation

var params = {
  Image: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  SummarizationAttributes: {
    MinConfidence: 'NUMBER_VALUE', /* required */
    RequiredEquipmentTypes: [ /* required */
      FACE_COVER | HAND_COVER | HEAD_COVER,
      /* more items */
    ]
  }
};
rekognition.detectProtectiveEquipment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Image — (map)

      The image in which you want to detect PPE on detected persons. The image can be passed as image bytes or you can reference an image stored in an Amazon S3 bucket.

      • Bytes — (Buffer, Typed Array, Blob, String)

        Blob of image bytes up to 5 MBs.

      • S3Object — (map)

        Identifies an S3 object as the image source.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • SummarizationAttributes — (map)

      An array of PPE types that you want to summarize.

      • MinConfidence — required — (Float)

        The minimum confidence level for which you want summary information. The confidence level applies to person detection, body part detection, equipment detection, and body part coverage. Amazon Rekognition doesn't return summary information with a confidence than this specified value. There isn't a default value.

        Specify a MinConfidence value that is between 50-100% as DetectProtectiveEquipment returns predictions only where the detection confidence is between 50% - 100%. If you specify a value that is less than 50%, the results are the same specifying a value of 50%.

      • RequiredEquipmentTypes — required — (Array<String>)

        An array of personal protective equipment types for which you want summary information. If a person is detected wearing a required requipment type, the person's ID is added to the PersonsWithRequiredEquipment array field returned in ProtectiveEquipmentSummary by DetectProtectiveEquipment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProtectiveEquipmentModelVersion — (String)

        The version number of the PPE detection model used to detect PPE in the image.

      • Persons — (Array<map>)

        An array of persons detected in the image (including persons not wearing PPE).

        • BodyParts — (Array<map>)

          An array of body parts detected on a person's body (including body parts without PPE).

          • Name — (String)

            The detected body part.

            Possible values include:
            • "FACE"
            • "HEAD"
            • "LEFT_HAND"
            • "RIGHT_HAND"
          • Confidence — (Float)

            The confidence that Amazon Rekognition has in the detection accuracy of the detected body part.

          • EquipmentDetections — (Array<map>)

            An array of Personal Protective Equipment items detected around a body part.

            • BoundingBox — (map)

              A bounding box surrounding the item of detected PPE.

              • Width — (Float)

                Width of the bounding box as a ratio of the overall image width.

              • Height — (Float)

                Height of the bounding box as a ratio of the overall image height.

              • Left — (Float)

                Left coordinate of the bounding box as a ratio of overall image width.

              • Top — (Float)

                Top coordinate of the bounding box as a ratio of overall image height.

            • Confidence — (Float)

              The confidence that Amazon Rekognition has that the bounding box (BoundingBox) contains an item of PPE.

            • Type — (String)

              The type of detected PPE.

              Possible values include:
              • "FACE_COVER"
              • "HAND_COVER"
              • "HEAD_COVER"
            • CoversBodyPart — (map)

              Information about the body part covered by the detected PPE.

              • Confidence — (Float)

                The confidence that Amazon Rekognition has in the value of Value.

              • Value — (Boolean)

                True if the PPE covers the corresponding body part, otherwise false.

        • BoundingBox — (map)

          A bounding box around the detected person.

          • Width — (Float)

            Width of the bounding box as a ratio of the overall image width.

          • Height — (Float)

            Height of the bounding box as a ratio of the overall image height.

          • Left — (Float)

            Left coordinate of the bounding box as a ratio of overall image width.

          • Top — (Float)

            Top coordinate of the bounding box as a ratio of overall image height.

        • Confidence — (Float)

          The confidence that Amazon Rekognition has that the bounding box contains a person.

        • Id — (Integer)

          The identifier for the detected person. The identifier is only unique for a single call to DetectProtectiveEquipment.

      • Summary — (map)

        Summary information for the types of PPE specified in the SummarizationAttributes input parameter.

        • PersonsWithRequiredEquipment — (Array<Integer>)

          An array of IDs for persons who are wearing detected personal protective equipment.

        • PersonsWithoutRequiredEquipment — (Array<Integer>)

          An array of IDs for persons who are not wearing all of the types of PPE specified in the RequiredEquipmentTypes field of the detected personal protective equipment.

        • PersonsIndeterminate — (Array<Integer>)

          An array of IDs for persons where it was not possible to determine if they are wearing personal protective equipment.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

detectText(params = {}, callback) ⇒ AWS.Request

Detects text in the input image and converts it into machine-readable text.

Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file.

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was detected in the image.

A word is one or more ISO basic latin script characters that are not separated by spaces. DetectText can detect up to 100 words in an image.

A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines.

To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field.

To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.

For more information, see DetectText in the Amazon Rekognition Developer Guide.

Service Reference:

Examples:

Calling the detectText operation

var params = {
  Image: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  Filters: {
    RegionsOfInterest: [
      {
        BoundingBox: {
          Height: 'NUMBER_VALUE',
          Left: 'NUMBER_VALUE',
          Top: 'NUMBER_VALUE',
          Width: 'NUMBER_VALUE'
        }
      },
      /* more items */
    ],
    WordFilter: {
      MinBoundingBoxHeight: 'NUMBER_VALUE',
      MinBoundingBoxWidth: 'NUMBER_VALUE',
      MinConfidence: 'NUMBER_VALUE'
    }
  }
};
rekognition.detectText(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Image — (map)

      The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.

      If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

      • Bytes — (Buffer, Typed Array, Blob, String)

        Blob of image bytes up to 5 MBs.

      • S3Object — (map)

        Identifies an S3 object as the image source.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • Filters — (map)

      Optional parameters that let you set the criteria that the text must meet to be included in your response.

      • WordFilter — (map)

        A set of parameters that allow you to filter out certain results from your returned results.

        • MinConfidence — (Float)

          Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 50 and 100 as Text in Video will not return any result below 50.

        • MinBoundingBoxHeight — (Float)

          Sets the minimum height of the word bounding box. Words with bounding box heights lesser than this value will be excluded from the result. Value is relative to the video frame height.

        • MinBoundingBoxWidth — (Float)

          Sets the minimum width of the word bounding box. Words with bounding boxes widths lesser than this value will be excluded from the result. Value is relative to the video frame width.

      • RegionsOfInterest — (Array<map>)

        A Filter focusing on a certain area of the image. Uses a BoundingBox object to set the region of the image.

        • BoundingBox — (map)

          The box representing a region of interest on screen.

          • Width — (Float)

            Width of the bounding box as a ratio of the overall image width.

          • Height — (Float)

            Height of the bounding box as a ratio of the overall image height.

          • Left — (Float)

            Left coordinate of the bounding box as a ratio of overall image width.

          • Top — (Float)

            Top coordinate of the bounding box as a ratio of overall image height.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TextDetections — (Array<map>)

        An array of text that was detected in the input image.

        • DetectedText — (String)

          The word or line of text recognized by Amazon Rekognition.

        • Type — (String)

          The type of text that was detected.

          Possible values include:
          • "LINE"
          • "WORD"
        • Id — (Integer)

          The identifier for the detected text. The identifier is only unique for a single call to DetectText.

        • ParentId — (Integer)

          The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.

        • Confidence — (Float)

          The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.

        • Geometry — (map)

          The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.

          • BoundingBox — (map)

            An axis-aligned coarse representation of the detected item's location on the image.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • Polygon — (Array<map>)

            Within the bounding box, a fine-grained polygon around the detected item.

            • X — (Float)

              The value of the X coordinate for a point on a Polygon.

            • Y — (Float)

              The value of the Y coordinate for a point on a Polygon.

      • TextModelVersion — (String)

        The model version used to detect text.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

distributeDatasetEntries(params = {}, callback) ⇒ AWS.Request

Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project. DistributeDatasetEntries moves 20% of the training dataset images to the test dataset. An entry is a JSON Line that describes an image.

You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. The training dataset must contain the images that you want to split. The test dataset must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.

Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. If the dataset split fails, the value of Status is UPDATE_FAILED.

This operation requires permissions to perform the rekognition:DistributeDatasetEntries action.

Service Reference:

Examples:

Calling the distributeDatasetEntries operation

var params = {
  Datasets: [ /* required */
    {
      Arn: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
rekognition.distributeDatasetEntries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Datasets — (Array<map>)

      The ARNS for the training dataset and test dataset that you want to use. The datasets must belong to the same project. The test dataset must be empty.

      • Arn — required — (String)

        The Amazon Resource Name (ARN) of the dataset that you want to use.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCelebrityInfo(params = {}, callback) ⇒ AWS.Request

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.

For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:GetCelebrityInfo action.

Service Reference:

Examples:

Calling the getCelebrityInfo operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
rekognition.getCelebrityInfo(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Urls — (Array<String>)

        An array of URLs pointing to additional celebrity information.

      • Name — (String)

        The name of the celebrity.

      • KnownGender — (map)

        Retrieves the known gender for the celebrity.

        • Type — (String)

          A string value of the KnownGender info about the Celebrity.

          Possible values include:
          • "Male"
          • "Female"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCelebrityRecognition(params = {}, callback) ⇒ AWS.Request

Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId).

When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from the initial call to StartCelebrityDetection.

For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.

GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face attributes, a face bounding box, known gender, the celebrity's name, and a confidence estimate.

Note: GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The BoundingBox field only applies to the detected face instance. The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

By default, the Celebrities array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.

The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.

No information is returned for faces not recognized as celebrities.

Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection and populate the NextToken request parameter with the token value returned from the previous call to GetCelebrityRecognition.

Service Reference:

Examples:

Calling the getCelebrityRecognition operation

var params = {
  JobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: ID | TIMESTAMP
};
rekognition.getCelebrityRecognition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • JobId — (String)

      Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition.

    • MaxResults — (Integer)

      Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

    • NextToken — (String)

      If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.

    • SortBy — (String)

      Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.

      Possible values include:
      • "ID"
      • "TIMESTAMP"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobStatus — (String)

        The current status of the celebrity recognition job.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"
      • StatusMessage — (String)

        If the job fails, StatusMessage provides a descriptive error message.

      • VideoMetadata — (map)

        Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

        • Codec — (String)

          Type of compression used in the analyzed video.

        • DurationMillis — (Integer)

          Length of the video in milliseconds.

        • Format — (String)

          Format of the analyzed video. Possible values are MP4, MOV and AVI.

        • FrameRate — (Float)

          Number of frames per second in the video.

        • FrameHeight — (Integer)

          Vertical pixel dimension of the video.

        • FrameWidth — (Integer)

          Horizontal pixel dimension of the video.

        • ColorRange — (String)

          A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).

          Possible values include:
          • "FULL"
          • "LIMITED"
      • NextToken — (String)

        If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of celebrities.

      • Celebrities — (Array<map>)

        Array of celebrities recognized in the video.

        • Timestamp — (Integer)

          The time, in milliseconds from the start of the video, that the celebrity was recognized.

        • Celebrity — (map)

          Information about a recognized celebrity.

          • Urls — (Array<String>)

            An array of URLs pointing to additional celebrity information.

          • Name — (String)

            The name of the celebrity.

          • Id — (String)

            The unique identifier for the celebrity.

          • Confidence — (Float)

            The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.

          • BoundingBox — (map)

            Bounding box around the body of a celebrity.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • Face — (map)

            Face details for the recognized celebrity.

            • BoundingBox — (map)

              Bounding box of the face. Default attribute.

              • Width — (Float)

                Width of the bounding box as a ratio of the overall image width.

              • Height — (Float)

                Height of the bounding box as a ratio of the overall image height.

              • Left — (Float)

                Left coordinate of the bounding box as a ratio of overall image width.

              • Top — (Float)

                Top coordinate of the bounding box as a ratio of overall image height.

            • AgeRange — (map)

              The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

              • Low — (Integer)

                The lowest estimated age.

              • High — (Integer)

                The highest estimated age.

            • Smile — (map)

              Indicates whether or not the face is smiling, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face is smiling or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Eyeglasses — (map)

              Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face is wearing eye glasses or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Sunglasses — (map)

              Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face is wearing sunglasses or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Gender — (map)

              The predicted gender of a detected face.

              • Value — (String)

                The predicted gender of the face.

                Possible values include:
                • "Male"
                • "Female"
              • Confidence — (Float)

                Level of confidence in the prediction.

            • Beard — (map)

              Indicates whether or not the face has a beard, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face has beard or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Mustache — (map)

              Indicates whether or not the face has a mustache, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face has mustache or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • EyesOpen — (map)

              Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the eyes on the face are open.

              • Confidence — (Float)

                Level of confidence in the determination.

            • MouthOpen — (map)

              Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the mouth on the face is open or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Emotions — (Array<map>)

              The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

              • Type — (String)

                Type of emotion detected.

                Possible values include:
                • "HAPPY"
                • "SAD"
                • "ANGRY"
                • "CONFUSED"
                • "DISGUSTED"
                • "SURPRISED"
                • "CALM"
                • "UNKNOWN"
                • "FEAR"
              • Confidence — (Float)

                Level of confidence in the determination.

            • Landmarks — (Array<map>)

              Indicates the location of landmarks on the face. Default attribute.

              • Type — (String)

                Type of landmark.

                Possible values include:
                • "eyeLeft"
                • "eyeRight"
                • "nose"
                • "mouthLeft"
                • "mouthRight"
                • "leftEyeBrowLeft"
                • "leftEyeBrowRight"
                • "leftEyeBrowUp"
                • "rightEyeBrowLeft"
                • "rightEyeBrowRight"
                • "rightEyeBrowUp"
                • "leftEyeLeft"
                • "leftEyeRight"
                • "leftEyeUp"
                • "leftEyeDown"
                • "rightEyeLeft"
                • "rightEyeRight"
                • "rightEyeUp"
                • "rightEyeDown"
                • "noseLeft"
                • "noseRight"
                • "mouthUp"
                • "mouthDown"
                • "leftPupil"
                • "rightPupil"
                • "upperJawlineLeft"
                • "midJawlineLeft"
                • "chinBottom"
                • "midJawlineRight"
                • "upperJawlineRight"
              • X — (Float)

                The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

              • Y — (Float)

                The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

            • Pose — (map)

              Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

              • Roll — (Float)

                Value representing the face rotation on the roll axis.

              • Yaw — (Float)

                Value representing the face rotation on the yaw axis.

              • Pitch — (Float)

                Value representing the face rotation on the pitch axis.

            • Quality — (map)

              Identifies image brightness and sharpness. Default attribute.

              • Brightness — (Float)

                Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

              • Sharpness — (Float)

                Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

            • Confidence — (Float)

              Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.

          • KnownGender — (map)

            Retrieves the known gender for the celebrity.

            • Type — (String)

              A string value of the KnownGender info about the Celebrity.

              Possible values include:
              • "Male"
              • "Female"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getContentModeration(params = {}, callback) ⇒ AWS.Request

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.

GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection objects.

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter.

Since video analysis can return a large number of results, use the MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration.

For more information, see Content moderation in the Amazon Rekognition Developer Guide.

Service Reference:

Examples:

Calling the getContentModeration operation

var params = {
  JobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: NAME | TIMESTAMP
};
rekognition.getContentModeration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • JobId — (String)

      The identifier for the inappropriate, unwanted, or offensive content moderation job. Use JobId to identify the job in a subsequent call to GetContentModeration.

    • MaxResults — (Integer)

      Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

    • NextToken — (String)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.

    • SortBy — (String)

      Sort to use for elements in the ModerationLabelDetections array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

      Possible values include:
      • "NAME"
      • "TIMESTAMP"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobStatus — (String)

        The current status of the content moderation analysis job.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"
      • StatusMessage — (String)

        If the job fails, StatusMessage provides a descriptive error message.

      • VideoMetadata — (map)

        Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from GetContentModeration.

        • Codec — (String)

          Type of compression used in the analyzed video.

        • DurationMillis — (Integer)

          Length of the video in milliseconds.

        • Format — (String)

          Format of the analyzed video. Possible values are MP4, MOV and AVI.

        • FrameRate — (Float)

          Number of frames per second in the video.

        • FrameHeight — (Integer)

          Vertical pixel dimension of the video.

        • FrameWidth — (Integer)

          Horizontal pixel dimension of the video.

        • ColorRange — (String)

          A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).

          Possible values include:
          • "FULL"
          • "LIMITED"
      • ModerationLabels — (Array<map>)

        The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.

        • Timestamp — (Integer)

          Time, in milliseconds from the beginning of the video, that the content moderation label was detected.

        • ModerationLabel — (map)

          The content moderation label detected by in the stored video.

          • Confidence — (Float)

            Specifies the confidence that Amazon Rekognition has that the label has been correctly identified.

            If you don't specify the MinConfidence parameter in the call to DetectModerationLabels, the operation returns labels with a confidence value greater than or equal to 50 percent.

          • Name — (String)

            The label name for the type of unsafe content detected in the image.

          • ParentName — (String)

            The name for the parent label. Labels at the top level of the hierarchy have the parent label "".

      • NextToken — (String)

        If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of content moderation labels.

      • ModerationModelVersion — (String)

        Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getFaceDetection(params = {}, callback) ⇒ AWS.Request

Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.

Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection which returns a job identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection.

GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected.

Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token value returned from the previous call to GetFaceDetection.

Service Reference:

Examples:

Calling the getFaceDetection operation

var params = {
  JobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
rekognition.getFaceDetection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • JobId — (String)

      Unique identifier for the face detection job. The JobId is returned from StartFaceDetection.

    • MaxResults — (Integer)

      Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

    • NextToken — (String)

      If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobStatus — (String)

        The current status of the face detection job.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"
      • StatusMessage — (String)

        If the job fails, StatusMessage provides a descriptive error message.

      • VideoMetadata — (map)

        Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

        • Codec — (String)

          Type of compression used in the analyzed video.

        • DurationMillis — (Integer)

          Length of the video in milliseconds.

        • Format — (String)

          Format of the analyzed video. Possible values are MP4, MOV and AVI.

        • FrameRate — (Float)

          Number of frames per second in the video.

        • FrameHeight — (Integer)

          Vertical pixel dimension of the video.

        • FrameWidth — (Integer)

          Horizontal pixel dimension of the video.

        • ColorRange — (String)

          A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).

          Possible values include:
          • "FULL"
          • "LIMITED"
      • NextToken — (String)

        If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

      • Faces — (Array<map>)

        An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.

        • Timestamp — (Integer)

          Time, in milliseconds from the start of the video, that the face was detected.

        • Face — (map)

          The face properties for the detected face.

          • BoundingBox — (map)

            Bounding box of the face. Default attribute.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • AgeRange — (map)

            The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

            • Low — (Integer)

              The lowest estimated age.

            • High — (Integer)

              The highest estimated age.

          • Smile — (map)

            Indicates whether or not the face is smiling, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face is smiling or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Eyeglasses — (map)

            Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face is wearing eye glasses or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Sunglasses — (map)

            Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face is wearing sunglasses or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Gender — (map)

            The predicted gender of a detected face.

            • Value — (String)

              The predicted gender of the face.

              Possible values include:
              • "Male"
              • "Female"
            • Confidence — (Float)

              Level of confidence in the prediction.

          • Beard — (map)

            Indicates whether or not the face has a beard, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face has beard or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Mustache — (map)

            Indicates whether or not the face has a mustache, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face has mustache or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • EyesOpen — (map)

            Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the eyes on the face are open.

            • Confidence — (Float)

              Level of confidence in the determination.

          • MouthOpen — (map)

            Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the mouth on the face is open or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Emotions — (Array<map>)

            The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

            • Type — (String)

              Type of emotion detected.

              Possible values include:
              • "HAPPY"
              • "SAD"
              • "ANGRY"
              • "CONFUSED"
              • "DISGUSTED"
              • "SURPRISED"
              • "CALM"
              • "UNKNOWN"
              • "FEAR"
            • Confidence — (Float)

              Level of confidence in the determination.

          • Landmarks — (Array<map>)

            Indicates the location of landmarks on the face. Default attribute.

            • Type — (String)

              Type of landmark.

              Possible values include:
              • "eyeLeft"
              • "eyeRight"
              • "nose"
              • "mouthLeft"
              • "mouthRight"
              • "leftEyeBrowLeft"
              • "leftEyeBrowRight"
              • "leftEyeBrowUp"
              • "rightEyeBrowLeft"
              • "rightEyeBrowRight"
              • "rightEyeBrowUp"
              • "leftEyeLeft"
              • "leftEyeRight"
              • "leftEyeUp"
              • "leftEyeDown"
              • "rightEyeLeft"
              • "rightEyeRight"
              • "rightEyeUp"
              • "rightEyeDown"
              • "noseLeft"
              • "noseRight"
              • "mouthUp"
              • "mouthDown"
              • "leftPupil"
              • "rightPupil"
              • "upperJawlineLeft"
              • "midJawlineLeft"
              • "chinBottom"
              • "midJawlineRight"
              • "upperJawlineRight"
            • X — (Float)

              The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

            • Y — (Float)

              The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

          • Pose — (map)

            Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

            • Roll — (Float)

              Value representing the face rotation on the roll axis.

            • Yaw — (Float)

              Value representing the face rotation on the yaw axis.

            • Pitch — (Float)

              Value representing the face rotation on the pitch axis.

          • Quality — (map)

            Identifies image brightness and sharpness. Default attribute.

            • Brightness — (Float)

              Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

            • Sharpness — (Float)

              Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

          • Confidence — (Float)

            Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getFaceSearch(params = {}, callback) ⇒ AWS.Request

Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.

Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch.

For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

The search results are retured in an array, Persons, of PersonMatch objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.

Note: GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter.

Service Reference:

Examples:

Calling the getFaceSearch operation

var params = {
  JobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: INDEX | TIMESTAMP
};
rekognition.getFaceSearch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • JobId — (String)

      The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

    • MaxResults — (Integer)

      Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

    • NextToken — (String)

      If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

    • SortBy — (String)

      Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

      Possible values include:
      • "INDEX"
      • "TIMESTAMP"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobStatus — (String)

        The current status of the face search job.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"
      • StatusMessage — (String)

        If the job fails, StatusMessage provides a descriptive error message.

      • NextToken — (String)

        If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

      • VideoMetadata — (map)

        Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

        • Codec — (String)

          Type of compression used in the analyzed video.

        • DurationMillis — (Integer)

          Length of the video in milliseconds.

        • Format — (String)

          Format of the analyzed video. Possible values are MP4, MOV and AVI.

        • FrameRate — (Float)

          Number of frames per second in the video.

        • FrameHeight — (Integer)

          Vertical pixel dimension of the video.

        • FrameWidth — (Integer)

          Horizontal pixel dimension of the video.

        • ColorRange — (String)

          A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).

          Possible values include:
          • "FULL"
          • "LIMITED"
      • Persons — (Array<map>)

        An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

        • Timestamp — (Integer)

          The time, in milliseconds from the beginning of the video, that the person was matched in the video.

        • Person — (map)

          Information about the matched person.

          • Index — (Integer)

            Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition.

          • BoundingBox — (map)

            Bounding box around the detected person.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • Face — (map)

            Face details for the detected person.

            • BoundingBox — (map)

              Bounding box of the face. Default attribute.

              • Width — (Float)

                Width of the bounding box as a ratio of the overall image width.

              • Height — (Float)

                Height of the bounding box as a ratio of the overall image height.

              • Left — (Float)

                Left coordinate of the bounding box as a ratio of overall image width.

              • Top — (Float)

                Top coordinate of the bounding box as a ratio of overall image height.

            • AgeRange — (map)

              The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

              • Low — (Integer)

                The lowest estimated age.

              • High — (Integer)

                The highest estimated age.

            • Smile — (map)

              Indicates whether or not the face is smiling, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face is smiling or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Eyeglasses — (map)

              Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face is wearing eye glasses or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Sunglasses — (map)

              Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face is wearing sunglasses or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Gender — (map)

              The predicted gender of a detected face.

              • Value — (String)

                The predicted gender of the face.

                Possible values include:
                • "Male"
                • "Female"
              • Confidence — (Float)

                Level of confidence in the prediction.

            • Beard — (map)

              Indicates whether or not the face has a beard, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face has beard or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Mustache — (map)

              Indicates whether or not the face has a mustache, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face has mustache or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • EyesOpen — (map)

              Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the eyes on the face are open.

              • Confidence — (Float)

                Level of confidence in the determination.

            • MouthOpen — (map)

              Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the mouth on the face is open or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Emotions — (Array<map>)

              The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

              • Type — (String)

                Type of emotion detected.

                Possible values include:
                • "HAPPY"
                • "SAD"
                • "ANGRY"
                • "CONFUSED"
                • "DISGUSTED"
                • "SURPRISED"
                • "CALM"
                • "UNKNOWN"
                • "FEAR"
              • Confidence — (Float)

                Level of confidence in the determination.

            • Landmarks — (Array<map>)

              Indicates the location of landmarks on the face. Default attribute.

              • Type — (String)

                Type of landmark.

                Possible values include:
                • "eyeLeft"
                • "eyeRight"
                • "nose"
                • "mouthLeft"
                • "mouthRight"
                • "leftEyeBrowLeft"
                • "leftEyeBrowRight"
                • "leftEyeBrowUp"
                • "rightEyeBrowLeft"
                • "rightEyeBrowRight"
                • "rightEyeBrowUp"
                • "leftEyeLeft"
                • "leftEyeRight"
                • "leftEyeUp"
                • "leftEyeDown"
                • "rightEyeLeft"
                • "rightEyeRight"
                • "rightEyeUp"
                • "rightEyeDown"
                • "noseLeft"
                • "noseRight"
                • "mouthUp"
                • "mouthDown"
                • "leftPupil"
                • "rightPupil"
                • "upperJawlineLeft"
                • "midJawlineLeft"
                • "chinBottom"
                • "midJawlineRight"
                • "upperJawlineRight"
              • X — (Float)

                The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

              • Y — (Float)

                The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

            • Pose — (map)

              Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

              • Roll — (Float)

                Value representing the face rotation on the roll axis.

              • Yaw — (Float)

                Value representing the face rotation on the yaw axis.

              • Pitch — (Float)

                Value representing the face rotation on the pitch axis.

            • Quality — (map)

              Identifies image brightness and sharpness. Default attribute.

              • Brightness — (Float)

                Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

              • Sharpness — (Float)

                Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

            • Confidence — (Float)

              Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.

        • FaceMatches — (Array<map>)

          Information about the faces in the input collection that match the face of a person in the video.

          • Similarity — (Float)

            Confidence in the match of this face with the input face.

          • Face — (map)

            Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.

            • FaceId — (String)

              Unique identifier that Amazon Rekognition assigns to the face.

            • BoundingBox — (map)

              Bounding box of the face.

              • Width — (Float)

                Width of the bounding box as a ratio of the overall image width.

              • Height — (Float)

                Height of the bounding box as a ratio of the overall image height.

              • Left — (Float)

                Left coordinate of the bounding box as a ratio of overall image width.

              • Top — (Float)

                Top coordinate of the bounding box as a ratio of overall image height.

            • ImageId — (String)

              Unique identifier that Amazon Rekognition assigns to the input image.

            • ExternalImageId — (String)

              Identifier that you assign to all the faces in the input image.

            • Confidence — (Float)

              Confidence level that the bounding box contains a face (and not a different object such as a tree).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getLabelDetection(params = {}, callback) ⇒ AWS.Request

Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.

The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection.

GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter.

The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.

The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection.

Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection and populate the NextToken request parameter with the token value returned from the previous call to GetLabelDetection.

Service Reference:

Examples:

Calling the getLabelDetection operation

var params = {
  JobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: NAME | TIMESTAMP
};
rekognition.getLabelDetection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • JobId — (String)

      Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

    • MaxResults — (Integer)

      Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

    • NextToken — (String)

      If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.

    • SortBy — (String)

      Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

      Possible values include:
      • "NAME"
      • "TIMESTAMP"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobStatus — (String)

        The current status of the label detection job.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"
      • StatusMessage — (String)

        If the job fails, StatusMessage provides a descriptive error message.

      • VideoMetadata — (map)

        Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

        • Codec — (String)

          Type of compression used in the analyzed video.

        • DurationMillis — (Integer)

          Length of the video in milliseconds.

        • Format — (String)

          Format of the analyzed video. Possible values are MP4, MOV and AVI.

        • FrameRate — (Float)

          Number of frames per second in the video.

        • FrameHeight — (Integer)

          Vertical pixel dimension of the video.

        • FrameWidth — (Integer)

          Horizontal pixel dimension of the video.

        • ColorRange — (String)

          A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).

          Possible values include:
          • "FULL"
          • "LIMITED"
      • NextToken — (String)

        If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.

      • Labels — (Array<map>)

        An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

        • Timestamp — (Integer)

          Time, in milliseconds from the start of the video, that the label was detected.

        • Label — (map)

          Details about the detected label.

          • Name — (String)

            The name (label) of the object or scene.

          • Confidence — (Float)

            Level of confidence.

          • Instances — (Array<map>)

            If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.

            • BoundingBox — (map)

              The position of the label instance on the image.

              • Width — (Float)

                Width of the bounding box as a ratio of the overall image width.

              • Height — (Float)

                Height of the bounding box as a ratio of the overall image height.

              • Left — (Float)

                Left coordinate of the bounding box as a ratio of overall image width.

              • Top — (Float)

                Top coordinate of the bounding box as a ratio of overall image height.

            • Confidence — (Float)

              The confidence that Amazon Rekognition has in the accuracy of the bounding box.

          • Parents — (Array<map>)

            The parent labels for a label. The response includes all ancestor labels.

            • Name — (String)

              The name of the parent label.

      • LabelModelVersion — (String)

        Version number of the label detection model that was used to detect labels.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getPersonTracking(params = {}, callback) ⇒ AWS.Request

Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

The person path tracking operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.

To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.

GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their paths were tracked in the video.

Note: GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter.

Use the MaxResults parameter to limit the number of items returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token value returned from the previous call to GetPersonTracking.

Service Reference:

Examples:

Calling the getPersonTracking operation

var params = {
  JobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: INDEX | TIMESTAMP
};
rekognition.getPersonTracking(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • JobId — (String)

      The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

    • MaxResults — (Integer)

      Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

    • NextToken — (String)

      If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.

    • SortBy — (String)

      Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

      Possible values include:
      • "INDEX"
      • "TIMESTAMP"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobStatus — (String)

        The current status of the person tracking job.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"
      • StatusMessage — (String)

        If the job fails, StatusMessage provides a descriptive error message.

      • VideoMetadata — (map)

        Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

        • Codec — (String)

          Type of compression used in the analyzed video.

        • DurationMillis — (Integer)

          Length of the video in milliseconds.

        • Format — (String)

          Format of the analyzed video. Possible values are MP4, MOV and AVI.

        • FrameRate — (Float)

          Number of frames per second in the video.

        • FrameHeight — (Integer)

          Vertical pixel dimension of the video.

        • FrameWidth — (Integer)

          Horizontal pixel dimension of the video.

        • ColorRange — (String)

          A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).

          Possible values include:
          • "FULL"
          • "LIMITED"
      • NextToken — (String)

        If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of persons.

      • Persons — (Array<map>)

        An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person's path is tracked.

        • Timestamp — (Integer)

          The time, in milliseconds from the start of the video, that the person's path was tracked.

        • Person — (map)

          Details about a person whose path was tracked in a video.

          • Index — (Integer)

            Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition.

          • BoundingBox — (map)

            Bounding box around the detected person.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • Face — (map)

            Face details for the detected person.

            • BoundingBox — (map)

              Bounding box of the face. Default attribute.

              • Width — (Float)

                Width of the bounding box as a ratio of the overall image width.

              • Height — (Float)

                Height of the bounding box as a ratio of the overall image height.

              • Left — (Float)

                Left coordinate of the bounding box as a ratio of overall image width.

              • Top — (Float)

                Top coordinate of the bounding box as a ratio of overall image height.

            • AgeRange — (map)

              The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

              • Low — (Integer)

                The lowest estimated age.

              • High — (Integer)

                The highest estimated age.

            • Smile — (map)

              Indicates whether or not the face is smiling, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face is smiling or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Eyeglasses — (map)

              Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face is wearing eye glasses or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Sunglasses — (map)

              Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face is wearing sunglasses or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Gender — (map)

              The predicted gender of a detected face.

              • Value — (String)

                The predicted gender of the face.

                Possible values include:
                • "Male"
                • "Female"
              • Confidence — (Float)

                Level of confidence in the prediction.

            • Beard — (map)

              Indicates whether or not the face has a beard, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face has beard or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Mustache — (map)

              Indicates whether or not the face has a mustache, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the face has mustache or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • EyesOpen — (map)

              Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the eyes on the face are open.

              • Confidence — (Float)

                Level of confidence in the determination.

            • MouthOpen — (map)

              Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

              • Value — (Boolean)

                Boolean value that indicates whether the mouth on the face is open or not.

              • Confidence — (Float)

                Level of confidence in the determination.

            • Emotions — (Array<map>)

              The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

              • Type — (String)

                Type of emotion detected.

                Possible values include:
                • "HAPPY"
                • "SAD"
                • "ANGRY"
                • "CONFUSED"
                • "DISGUSTED"
                • "SURPRISED"
                • "CALM"
                • "UNKNOWN"
                • "FEAR"
              • Confidence — (Float)

                Level of confidence in the determination.

            • Landmarks — (Array<map>)

              Indicates the location of landmarks on the face. Default attribute.

              • Type — (String)

                Type of landmark.

                Possible values include:
                • "eyeLeft"
                • "eyeRight"
                • "nose"
                • "mouthLeft"
                • "mouthRight"
                • "leftEyeBrowLeft"
                • "leftEyeBrowRight"
                • "leftEyeBrowUp"
                • "rightEyeBrowLeft"
                • "rightEyeBrowRight"
                • "rightEyeBrowUp"
                • "leftEyeLeft"
                • "leftEyeRight"
                • "leftEyeUp"
                • "leftEyeDown"
                • "rightEyeLeft"
                • "rightEyeRight"
                • "rightEyeUp"
                • "rightEyeDown"
                • "noseLeft"
                • "noseRight"
                • "mouthUp"
                • "mouthDown"
                • "leftPupil"
                • "rightPupil"
                • "upperJawlineLeft"
                • "midJawlineLeft"
                • "chinBottom"
                • "midJawlineRight"
                • "upperJawlineRight"
              • X — (Float)

                The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

              • Y — (Float)

                The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

            • Pose — (map)

              Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

              • Roll — (Float)

                Value representing the face rotation on the roll axis.

              • Yaw — (Float)

                Value representing the face rotation on the yaw axis.

              • Pitch — (Float)

                Value representing the face rotation on the pitch axis.

            • Quality — (map)

              Identifies image brightness and sharpness. Default attribute.

              • Brightness — (Float)

                Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

              • Sharpness — (Float)

                Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

            • Confidence — (Float)

              Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSegmentDetection(params = {}, callback) ⇒ AWS.Request

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by calling StartSegmentDetection which returns a job identifier (JobId). When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartSegmentDetection. To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call of StartSegmentDetection.

GetSegmentDetection returns detected segments in an array (Segments) of SegmentDetection objects. Segments is sorted by the segment types specified in the SegmentTypes input parameter of StartSegmentDetection. Each element of the array includes the detected segment, the precentage confidence in the acuracy of the detected segment, the type of the segment, and the frame in which the segment was detected.

Use SelectedSegmentTypes to find out the type of segment detection requested in the call to StartSegmentDetection.

Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection and populate the NextToken request parameter with the token value returned from the previous call to GetSegmentDetection.

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

Service Reference:

Examples:

Calling the getSegmentDetection operation

var params = {
  JobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
rekognition.getSegmentDetection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • JobId — (String)

      Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to StartSegmentDetection.

    • MaxResults — (Integer)

      Maximum number of results to return per paginated call. The largest value you can specify is 1000.

    • NextToken — (String)

      If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobStatus — (String)

        Current status of the segment detection job.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"
      • StatusMessage — (String)

        If the job fails, StatusMessage provides a descriptive error message.

      • VideoMetadata — (Array<map>)

        Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

        • Codec — (String)

          Type of compression used in the analyzed video.

        • DurationMillis — (Integer)

          Length of the video in milliseconds.

        • Format — (String)

          Format of the analyzed video. Possible values are MP4, MOV and AVI.

        • FrameRate — (Float)

          Number of frames per second in the video.

        • FrameHeight — (Integer)

          Vertical pixel dimension of the video.

        • FrameWidth — (Integer)

          Horizontal pixel dimension of the video.

        • ColorRange — (String)

          A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).

          Possible values include:
          • "FULL"
          • "LIMITED"
      • AudioMetadata — (Array<map>)

        An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

        • Codec — (String)

          The audio codec used to encode or decode the audio stream.

        • DurationMillis — (Integer)

          The duration of the audio stream in milliseconds.

        • SampleRate — (Integer)

          The sample rate for the audio stream.

        • NumberOfChannels — (Integer)

          The number of audio channels in the segment.

      • NextToken — (String)

        If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

      • Segments — (Array<map>)

        An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

        • Type — (String)

          The type of the segment. Valid values are TECHNICAL_CUE and SHOT.

          Possible values include:
          • "TECHNICAL_CUE"
          • "SHOT"
        • StartTimestampMillis — (Integer)

          The start time of the detected segment in milliseconds from the start of the video. This value is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of 100 millis.

        • EndTimestampMillis — (Integer)

          The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.

        • DurationMillis — (Integer)

          The duration of the detected segment in milliseconds.

        • StartTimecodeSMPTE — (String)

          The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).

        • EndTimecodeSMPTE — (String)

          The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. EndTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).

        • DurationSMPTE — (String)

          The duration of the timecode for the detected segment in SMPTE format.

        • TechnicalCueSegment — (map)

          If the segment is a technical cue, contains information about the technical cue.

          • Type — (String)

            The type of the technical cue.

            Possible values include:
            • "ColorBars"
            • "EndCredits"
            • "BlackFrames"
            • "OpeningCredits"
            • "StudioLogo"
            • "Slate"
            • "Content"
          • Confidence — (Float)

            The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.

        • ShotSegment — (map)

          If the segment is a shot detection, contains information about the shot detection.

          • Index — (Integer)

            An Identifier for a shot detection segment detected in a video.

          • Confidence — (Float)

            The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.

        • StartFrameNumber — (Integer)

          The frame number of the start of a video segment, using a frame index that starts with 0.

        • EndFrameNumber — (Integer)

          The frame number at the end of a video segment, using a frame index that starts with 0.

        • DurationFrames — (Integer)

          The duration of a video segment, expressed in frames.

      • SelectedSegmentTypes — (Array<map>)

        An array containing the segment types requested in the call to StartSegmentDetection.

        • Type — (String)

          The type of a segment (technical cue or shot detection).

          Possible values include:
          • "TECHNICAL_CUE"
          • "SHOT"
        • ModelVersion — (String)

          The version of the model used to detect segments.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getTextDetection(params = {}, callback) ⇒ AWS.Request

Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.

Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling StartTextDetection which returns a job identifier (JobId) When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartTextDetection. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call of StartLabelDetection.

GetTextDetection returns an array of detected text (TextDetections) sorted by the time the text was detected, up to 50 words per frame of video.

Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines.

Use MaxResults parameter to limit the number of text detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection and populate the NextToken request parameter with the token value returned from the previous call to GetTextDetection.

Service Reference:

Examples:

Calling the getTextDetection operation

var params = {
  JobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
rekognition.getTextDetection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • JobId — (String)

      Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to StartTextDetection.

    • MaxResults — (Integer)

      Maximum number of results to return per paginated call. The largest value you can specify is 1000.

    • NextToken — (String)

      If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobStatus — (String)

        Current status of the text detection job.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"
      • StatusMessage — (String)

        If the job fails, StatusMessage provides a descriptive error message.

      • VideoMetadata — (map)

        Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

        • Codec — (String)

          Type of compression used in the analyzed video.

        • DurationMillis — (Integer)

          Length of the video in milliseconds.

        • Format — (String)

          Format of the analyzed video. Possible values are MP4, MOV and AVI.

        • FrameRate — (Float)

          Number of frames per second in the video.

        • FrameHeight — (Integer)

          Vertical pixel dimension of the video.

        • FrameWidth — (Integer)

          Horizontal pixel dimension of the video.

        • ColorRange — (String)

          A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).

          Possible values include:
          • "FULL"
          • "LIMITED"
      • TextDetections — (Array<map>)

        An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

        • Timestamp — (Integer)

          The time, in milliseconds from the start of the video, that the text was detected.

        • TextDetection — (map)

          Details about text detected in a video.

          • DetectedText — (String)

            The word or line of text recognized by Amazon Rekognition.

          • Type — (String)

            The type of text that was detected.

            Possible values include:
            • "LINE"
            • "WORD"
          • Id — (Integer)

            The identifier for the detected text. The identifier is only unique for a single call to DetectText.

          • ParentId — (Integer)

            The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.

          • Confidence — (Float)

            The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.

          • Geometry — (map)

            The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.

            • BoundingBox — (map)

              An axis-aligned coarse representation of the detected item's location on the image.

              • Width — (Float)

                Width of the bounding box as a ratio of the overall image width.

              • Height — (Float)

                Height of the bounding box as a ratio of the overall image height.

              • Left — (Float)

                Left coordinate of the bounding box as a ratio of overall image width.

              • Top — (Float)

                Top coordinate of the bounding box as a ratio of overall image height.

            • Polygon — (Array<map>)

              Within the bounding box, a fine-grained polygon around the detected item.

              • X — (Float)

                The value of the X coordinate for a point on a Polygon.

              • Y — (Float)

                The value of the Y coordinate for a point on a Polygon.

      • NextToken — (String)

        If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.

      • TextModelVersion — (String)

        Version number of the text detection model that was used to detect text.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

indexFaces(params = {}, callback) ⇒ AWS.Request

Detects faces in the input image and adds them to the specified collection.

Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations.

For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.

To get the number of faces in a collection, call DescribeCollection.

If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image.

If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field.

To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces

For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

If you provide the optional ExternalImageId for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.

You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. By default, IndexFaces chooses the quality bar that's used to filter faces. You can also explicitly choose the quality bar. Use QualityFilter, to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE.

Note: To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as:

  • The number of faces detected exceeds the value of the MaxFaces request parameter.

  • The face is too small compared to the image dimensions.

  • The face is too blurry.

  • The image is too dark.

  • The face has an extreme pose.

  • The face doesn’t have enough detail to be suitable for face search.

In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes:

  • The bounding box, BoundingBox, of the detected face.

  • A confidence value, Confidence, which indicates the confidence that the bounding box contains a face.

  • A face ID, FaceId, assigned by the service for each face that's detected and stored.

  • An image ID, ImageId, assigned by the service for the input image.

If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.

This operation requires permissions to perform the rekognition:IndexFaces action.

Service Reference:

Examples:

To add a face to a collection


/* This operation detects faces in an image and adds them to the specified Rekognition collection. */

 var params = {
  CollectionId: "myphotos", 
  DetectionAttributes: [
  ], 
  ExternalImageId: "myphotoid", 
  Image: {
   S3Object: {
    Bucket: "mybucket", 
    Name: "myphoto"
   }
  }
 };
 rekognition.indexFaces(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    FaceRecords: [
       {
      Face: {
       BoundingBox: {
        Height: 0.33481481671333313, 
        Left: 0.31888890266418457, 
        Top: 0.4933333396911621, 
        Width: 0.25
       }, 
       Confidence: 99.9991226196289, 
       FaceId: "ff43d742-0c13-5d16-a3e8-03d3f58e980b", 
       ImageId: "465f4e93-763e-51d0-b030-b9667a2d94b1"
      }, 
      FaceDetail: {
       BoundingBox: {
        Height: 0.33481481671333313, 
        Left: 0.31888890266418457, 
        Top: 0.4933333396911621, 
        Width: 0.25
       }, 
       Confidence: 99.9991226196289, 
       Landmarks: [
          {
         Type: "eyeLeft", 
         X: 0.3976764678955078, 
         Y: 0.6248345971107483
        }, 
          {
         Type: "eyeRight", 
         X: 0.4810936450958252, 
         Y: 0.6317117214202881
        }, 
          {
         Type: "noseLeft", 
         X: 0.41986238956451416, 
         Y: 0.7111940383911133
        }, 
          {
         Type: "mouthDown", 
         X: 0.40525302290916443, 
         Y: 0.7497701048851013
        }, 
          {
         Type: "mouthUp", 
         X: 0.4753248989582062, 
         Y: 0.7558549642562866
        }
       ], 
       Pose: {
        Pitch: -9.713645935058594, 
        Roll: 4.707281112670898, 
        Yaw: -24.438663482666016
       }, 
       Quality: {
        Brightness: 29.23358917236328, 
        Sharpness: 80
       }
      }
     }, 
       {
      Face: {
       BoundingBox: {
        Height: 0.32592591643333435, 
        Left: 0.5144444704055786, 
        Top: 0.15111111104488373, 
        Width: 0.24444444477558136
       }, 
       Confidence: 99.99950408935547, 
       FaceId: "8be04dba-4e58-520d-850e-9eae4af70eb2", 
       ImageId: "465f4e93-763e-51d0-b030-b9667a2d94b1"
      }, 
      FaceDetail: {
       BoundingBox: {
        Height: 0.32592591643333435, 
        Left: 0.5144444704055786, 
        Top: 0.15111111104488373, 
        Width: 0.24444444477558136
       }, 
       Confidence: 99.99950408935547, 
       Landmarks: [
          {
         Type: "eyeLeft", 
         X: 0.6006892323493958, 
         Y: 0.290842205286026
        }, 
          {
         Type: "eyeRight", 
         X: 0.6808141469955444, 
         Y: 0.29609042406082153
        }, 
          {
         Type: "noseLeft", 
         X: 0.6395332217216492, 
         Y: 0.3522595763206482
        }, 
          {
         Type: "mouthDown", 
         X: 0.5892083048820496, 
         Y: 0.38689887523651123
        }, 
          {
         Type: "mouthUp", 
         X: 0.674560010433197, 
         Y: 0.394125759601593
        }
       ], 
       Pose: {
        Pitch: -4.683138370513916, 
        Roll: 2.1029529571533203, 
        Yaw: 6.716655254364014
       }, 
       Quality: {
        Brightness: 34.951698303222656, 
        Sharpness: 160
       }
      }
     }
    ], 
    OrientationCorrection: "ROTATE_0"
   }
   */
 });

Calling the indexFaces operation

var params = {
  CollectionId: 'STRING_VALUE', /* required */
  Image: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  DetectionAttributes: [
    DEFAULT | ALL,
    /* more items */
  ],
  ExternalImageId: 'STRING_VALUE',
  MaxFaces: 'NUMBER_VALUE',
  QualityFilter: NONE | AUTO | LOW | MEDIUM | HIGH
};
rekognition.indexFaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CollectionId — (String)

      The ID of an existing collection to which you want to add the faces that are detected in the input images.

    • Image — (map)

      The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported.

      If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

      • Bytes — (Buffer, Typed Array, Blob, String)

        Blob of image bytes up to 5 MBs.

      • S3Object — (map)

        Identifies an S3 object as the image source.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • ExternalImageId — (String)

      The ID you want to assign to all the faces detected in the image.

    • DetectionAttributes — (Array<String>)

      An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete.

      If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

    • MaxFaces — (Integer)

      The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces.

      If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

      The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the smallest size, in descending order.

      MaxFaces can be used with a collection associated with any version of the face model.

    • QualityFilter — (String)

      A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The default value is AUTO. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed.

      To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

      Possible values include:
      • "NONE"
      • "AUTO"
      • "LOW"
      • "MEDIUM"
      • "HIGH"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FaceRecords — (Array<map>)

        An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

        • Face — (map)

          Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.

          • FaceId — (String)

            Unique identifier that Amazon Rekognition assigns to the face.

          • BoundingBox — (map)

            Bounding box of the face.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • ImageId — (String)

            Unique identifier that Amazon Rekognition assigns to the input image.

          • ExternalImageId — (String)

            Identifier that you assign to all the faces in the input image.

          • Confidence — (Float)

            Confidence level that the bounding box contains a face (and not a different object such as a tree).

        • FaceDetail — (map)

          Structure containing attributes of the face that the algorithm detected.

          • BoundingBox — (map)

            Bounding box of the face. Default attribute.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • AgeRange — (map)

            The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

            • Low — (Integer)

              The lowest estimated age.

            • High — (Integer)

              The highest estimated age.

          • Smile — (map)

            Indicates whether or not the face is smiling, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face is smiling or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Eyeglasses — (map)

            Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face is wearing eye glasses or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Sunglasses — (map)

            Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face is wearing sunglasses or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Gender — (map)

            The predicted gender of a detected face.

            • Value — (String)

              The predicted gender of the face.

              Possible values include:
              • "Male"
              • "Female"
            • Confidence — (Float)

              Level of confidence in the prediction.

          • Beard — (map)

            Indicates whether or not the face has a beard, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face has beard or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Mustache — (map)

            Indicates whether or not the face has a mustache, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face has mustache or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • EyesOpen — (map)

            Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the eyes on the face are open.

            • Confidence — (Float)

              Level of confidence in the determination.

          • MouthOpen — (map)

            Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the mouth on the face is open or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Emotions — (Array<map>)

            The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

            • Type — (String)

              Type of emotion detected.

              Possible values include:
              • "HAPPY"
              • "SAD"
              • "ANGRY"
              • "CONFUSED"
              • "DISGUSTED"
              • "SURPRISED"
              • "CALM"
              • "UNKNOWN"
              • "FEAR"
            • Confidence — (Float)

              Level of confidence in the determination.

          • Landmarks — (Array<map>)

            Indicates the location of landmarks on the face. Default attribute.

            • Type — (String)

              Type of landmark.

              Possible values include:
              • "eyeLeft"
              • "eyeRight"
              • "nose"
              • "mouthLeft"
              • "mouthRight"
              • "leftEyeBrowLeft"
              • "leftEyeBrowRight"
              • "leftEyeBrowUp"
              • "rightEyeBrowLeft"
              • "rightEyeBrowRight"
              • "rightEyeBrowUp"
              • "leftEyeLeft"
              • "leftEyeRight"
              • "leftEyeUp"
              • "leftEyeDown"
              • "rightEyeLeft"
              • "rightEyeRight"
              • "rightEyeUp"
              • "rightEyeDown"
              • "noseLeft"
              • "noseRight"
              • "mouthUp"
              • "mouthDown"
              • "leftPupil"
              • "rightPupil"
              • "upperJawlineLeft"
              • "midJawlineLeft"
              • "chinBottom"
              • "midJawlineRight"
              • "upperJawlineRight"
            • X — (Float)

              The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

            • Y — (Float)

              The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

          • Pose — (map)

            Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

            • Roll — (Float)

              Value representing the face rotation on the roll axis.

            • Yaw — (Float)

              Value representing the face rotation on the yaw axis.

            • Pitch — (Float)

              Value representing the face rotation on the pitch axis.

          • Quality — (map)

            Identifies image brightness and sharpness. Default attribute.

            • Brightness — (Float)

              Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

            • Sharpness — (Float)

              Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

          • Confidence — (Float)

            Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.

      • OrientationCorrection — (String)

        If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

        If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

        • If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction - the bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. The value of OrientationCorrection is null.

        • If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

        Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

        Possible values include:
        • "ROTATE_0"
        • "ROTATE_90"
        • "ROTATE_180"
        • "ROTATE_270"
      • FaceModelVersion — (String)

        The version number of the face detection model that's associated with the input collection (CollectionId).

      • UnindexedFaces — (Array<map>)

        An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.

        • Reasons — (Array<String>)

          An array of reasons that specify why a face wasn't indexed.

          • EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned too far away from the camera.

          • EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the MaxFaces input parameter for IndexFaces.

          • LOW_BRIGHTNESS - The image is too dark.

          • LOW_SHARPNESS - The image is too blurry.

          • LOW_CONFIDENCE - The face was detected with a low confidence.

          • SMALL_BOUNDING_BOX - The bounding box around the face is too small.

        • FaceDetail — (map)

          The structure that contains attributes of a face that IndexFacesdetected, but didn't index.

          • BoundingBox — (map)

            Bounding box of the face. Default attribute.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • AgeRange — (map)

            The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

            • Low — (Integer)

              The lowest estimated age.

            • High — (Integer)

              The highest estimated age.

          • Smile — (map)

            Indicates whether or not the face is smiling, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face is smiling or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Eyeglasses — (map)

            Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face is wearing eye glasses or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Sunglasses — (map)

            Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face is wearing sunglasses or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Gender — (map)

            The predicted gender of a detected face.

            • Value — (String)

              The predicted gender of the face.

              Possible values include:
              • "Male"
              • "Female"
            • Confidence — (Float)

              Level of confidence in the prediction.

          • Beard — (map)

            Indicates whether or not the face has a beard, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face has beard or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Mustache — (map)

            Indicates whether or not the face has a mustache, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face has mustache or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • EyesOpen — (map)

            Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the eyes on the face are open.

            • Confidence — (Float)

              Level of confidence in the determination.

          • MouthOpen — (map)

            Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the mouth on the face is open or not.

            • Confidence — (Float)

              Level of confidence in the determination.

          • Emotions — (Array<map>)

            The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

            • Type — (String)

              Type of emotion detected.

              Possible values include:
              • "HAPPY"
              • "SAD"
              • "ANGRY"
              • "CONFUSED"
              • "DISGUSTED"
              • "SURPRISED"
              • "CALM"
              • "UNKNOWN"
              • "FEAR"
            • Confidence — (Float)

              Level of confidence in the determination.

          • Landmarks — (Array<map>)

            Indicates the location of landmarks on the face. Default attribute.

            • Type — (String)

              Type of landmark.

              Possible values include:
              • "eyeLeft"
              • "eyeRight"
              • "nose"
              • "mouthLeft"
              • "mouthRight"
              • "leftEyeBrowLeft"
              • "leftEyeBrowRight"
              • "leftEyeBrowUp"
              • "rightEyeBrowLeft"
              • "rightEyeBrowRight"
              • "rightEyeBrowUp"
              • "leftEyeLeft"
              • "leftEyeRight"
              • "leftEyeUp"
              • "leftEyeDown"
              • "rightEyeLeft"
              • "rightEyeRight"
              • "rightEyeUp"
              • "rightEyeDown"
              • "noseLeft"
              • "noseRight"
              • "mouthUp"
              • "mouthDown"
              • "leftPupil"
              • "rightPupil"
              • "upperJawlineLeft"
              • "midJawlineLeft"
              • "chinBottom"
              • "midJawlineRight"
              • "upperJawlineRight"
            • X — (Float)

              The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

            • Y — (Float)

              The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

          • Pose — (map)

            Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

            • Roll — (Float)

              Value representing the face rotation on the roll axis.

            • Yaw — (Float)

              Value representing the face rotation on the yaw axis.

            • Pitch — (Float)

              Value representing the face rotation on the pitch axis.

          • Quality — (map)

            Identifies image brightness and sharpness. Default attribute.

            • Brightness — (Float)

              Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

            • Sharpness — (Float)

              Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

          • Confidence — (Float)

            Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listCollections(params = {}, callback) ⇒ AWS.Request

Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

For an example, see Listing Collections in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:ListCollections action.

Service Reference:

Examples:

To list the collections


/* This operation returns a list of Rekognition collections. */

 var params = {
 };
 rekognition.listCollections(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CollectionIds: [
       "myphotos"
    ]
   }
   */
 });

Calling the listCollections operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
rekognition.listCollections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Pagination token from the previous response.

    • MaxResults — (Integer)

      Maximum number of collection IDs to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CollectionIds — (Array<String>)

        An array of collection IDs.

      • NextToken — (String)

        If the result is truncated, the response provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

      • FaceModelVersions — (Array<String>)

        Version numbers of the face detection models associated with the collections in the array CollectionIds. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2].

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDatasetEntries(params = {}, callback) ⇒ AWS.Request

Lists the entries (images) within a dataset. An entry is a JSON Line that contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Creating a manifest file.

JSON Lines in the response include information about non-terminal errors found in the dataset. Non terminal errors are reported in errors lists within each JSON Line. The same information is reported in the training and testing validation result manifests that Amazon Rekognition Custom Labels creates during model training.

You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.

This operation requires permissions to perform the rekognition:ListDatasetEntries action.

Service Reference:

Examples:

Calling the listDatasetEntries operation

var params = {
  DatasetArn: 'STRING_VALUE', /* required */
  ContainsLabels: [
    'STRING_VALUE',
    /* more items */
  ],
  HasErrors: true || false,
  Labeled: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SourceRefContains: 'STRING_VALUE'
};
rekognition.listDatasetEntries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetArn — (String)

      The Amazon Resource Name (ARN) for the dataset that you want to use.

    • ContainsLabels — (Array<String>)

      Specifies a label filter for the response. The response includes an entry only if one or more of the labels in ContainsLabels exist in the entry.

    • Labeled — (Boolean)

      Specify true to get only the JSON Lines where the image is labeled. Specify false to get only the JSON Lines where the image isn't labeled. If you don't specify Labeled, ListDatasetEntries returns JSON Lines for labeled and unlabeled images.

    • SourceRefContains — (String)

      If specified, ListDatasetEntries only returns JSON Lines where the value of SourceRefContains is part of the source-ref field. The source-ref field contains the Amazon S3 location of the image. You can use SouceRefContains for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.

    • HasErrors — (Boolean)

      Specifies an error filter for the response. Specify True to only include entries that have errors.

    • NextToken — (String)

      If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetEntries — (Array<String>)

        A list of entries (images) in the dataset.

      • NextToken — (String)

        If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDatasetLabels(params = {}, callback) ⇒ AWS.Request

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images.

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images in the Amazon Rekognition Custom Labels Developer Guide.

Service Reference:

Examples:

Calling the listDatasetLabels operation

var params = {
  DatasetArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
rekognition.listDatasetLabels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetArn — (String)

      The Amazon Resource Name (ARN) of the dataset that you want to use.

    • NextToken — (String)

      If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetLabelDescriptions — (Array<map>)

        A list of the labels in the dataset.

        • LabelName — (String)

          The name of the label.

        • LabelStats — (map)

          Statistics about the label.

          • EntryCount — (Integer)

            The total number of images that use the label.

          • BoundingBoxCount — (Integer)

            The total number of images that have the label assigned to a bounding box.

      • NextToken — (String)

        If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listFaces(params = {}, callback) ⇒ AWS.Request

Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:ListFaces action.

Service Reference:

Examples:

To list the faces in a collection


/* This operation lists the faces in a Rekognition collection. */

 var params = {
  CollectionId: "myphotos", 
  MaxResults: 20
 };
 rekognition.listFaces(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Faces: [
       {
      BoundingBox: {
       Height: 0.18000000715255737, 
       Left: 0.5555559992790222, 
       Top: 0.336667001247406, 
       Width: 0.23999999463558197
      }, 
      Confidence: 100, 
      FaceId: "1c62e8b5-69a7-5b7d-b3cd-db4338a8a7e7", 
      ImageId: "147fdf82-7a71-52cf-819b-e786c7b9746e"
     }, 
       {
      BoundingBox: {
       Height: 0.16555599868297577, 
       Left: 0.30963000655174255, 
       Top: 0.7066670060157776, 
       Width: 0.22074100375175476
      }, 
      Confidence: 100, 
      FaceId: "29a75abe-397b-5101-ba4f-706783b2246c", 
      ImageId: "147fdf82-7a71-52cf-819b-e786c7b9746e"
     }, 
       {
      BoundingBox: {
       Height: 0.3234420120716095, 
       Left: 0.3233329951763153, 
       Top: 0.5, 
       Width: 0.24222199618816376
      }, 
      Confidence: 99.99829864501953, 
      FaceId: "38271d79-7bc2-5efb-b752-398a8d575b85", 
      ImageId: "d5631190-d039-54e4-b267-abd22c8647c5"
     }, 
       {
      BoundingBox: {
       Height: 0.03555560111999512, 
       Left: 0.37388700246810913, 
       Top: 0.2477779984474182, 
       Width: 0.04747769981622696
      }, 
      Confidence: 99.99210357666016, 
      FaceId: "3b01bef0-c883-5654-ba42-d5ad28b720b3", 
      ImageId: "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
     }, 
       {
      BoundingBox: {
       Height: 0.05333330109715462, 
       Left: 0.2937690019607544, 
       Top: 0.35666701197624207, 
       Width: 0.07121659815311432
      }, 
      Confidence: 99.99919891357422, 
      FaceId: "4839a608-49d0-566c-8301-509d71b534d1", 
      ImageId: "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
     }, 
       {
      BoundingBox: {
       Height: 0.3249259889125824, 
       Left: 0.5155559778213501, 
       Top: 0.1513350009918213, 
       Width: 0.24333299696445465
      }, 
      Confidence: 99.99949645996094, 
      FaceId: "70008e50-75e4-55d0-8e80-363fb73b3a14", 
      ImageId: "d5631190-d039-54e4-b267-abd22c8647c5"
     }, 
       {
      BoundingBox: {
       Height: 0.03777780011296272, 
       Left: 0.7002969980239868, 
       Top: 0.18777799606323242, 
       Width: 0.05044509842991829
      }, 
      Confidence: 99.92639923095703, 
      FaceId: "7f5f88ed-d684-5a88-b0df-01e4a521552b", 
      ImageId: "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
     }, 
       {
      BoundingBox: {
       Height: 0.05555560067296028, 
       Left: 0.13946600258350372, 
       Top: 0.46333301067352295, 
       Width: 0.07270029932260513
      }, 
      Confidence: 99.99469757080078, 
      FaceId: "895b4e2c-81de-5902-a4bd-d1792bda00b2", 
      ImageId: "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
     }, 
       {
      BoundingBox: {
       Height: 0.3259260058403015, 
       Left: 0.5144439935684204, 
       Top: 0.15111100673675537, 
       Width: 0.24444399774074554
      }, 
      Confidence: 99.99949645996094, 
      FaceId: "8be04dba-4e58-520d-850e-9eae4af70eb2", 
      ImageId: "465f4e93-763e-51d0-b030-b9667a2d94b1"
     }, 
       {
      BoundingBox: {
       Height: 0.18888899683952332, 
       Left: 0.3783380091190338, 
       Top: 0.2355560064315796, 
       Width: 0.25222599506378174
      }, 
      Confidence: 99.9999008178711, 
      FaceId: "908544ad-edc3-59df-8faf-6a87cc256cf5", 
      ImageId: "3c731605-d772-541a-a5e7-0375dbc68a07"
     }, 
       {
      BoundingBox: {
       Height: 0.33481499552726746, 
       Left: 0.31888899207115173, 
       Top: 0.49333301186561584, 
       Width: 0.25
      }, 
      Confidence: 99.99909973144531, 
      FaceId: "ff43d742-0c13-5d16-a3e8-03d3f58e980b", 
      ImageId: "465f4e93-763e-51d0-b030-b9667a2d94b1"
     }
    ]
   }
   */
 });

Calling the listFaces operation

var params = {
  CollectionId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
rekognition.listFaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CollectionId — (String)

      ID of the collection from which to list the faces.

    • NextToken — (String)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

    • MaxResults — (Integer)

      Maximum number of faces to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Faces — (Array<map>)

        An array of Face objects.

        • FaceId — (String)

          Unique identifier that Amazon Rekognition assigns to the face.

        • BoundingBox — (map)

          Bounding box of the face.

          • Width — (Float)

            Width of the bounding box as a ratio of the overall image width.

          • Height — (Float)

            Height of the bounding box as a ratio of the overall image height.

          • Left — (Float)

            Left coordinate of the bounding box as a ratio of overall image width.

          • Top — (Float)

            Top coordinate of the bounding box as a ratio of overall image height.

        • ImageId — (String)

          Unique identifier that Amazon Rekognition assigns to the input image.

        • ExternalImageId — (String)

          Identifier that you assign to all the faces in the input image.

        • Confidence — (Float)

          Confidence level that the bounding box contains a face (and not a different object such as a tree).

      • NextToken — (String)

        If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

      • FaceModelVersion — (String)

        Version number of the face detection model associated with the input collection (CollectionId).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listStreamProcessors(params = {}, callback) ⇒ AWS.Request

Gets a list of stream processors that you have created with CreateStreamProcessor.

Service Reference:

Examples:

Calling the listStreamProcessors operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
rekognition.listStreamProcessors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors.

    • MaxResults — (Integer)

      Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of stream processors.

      • StreamProcessors — (Array<map>)

        List of stream processors that you have created.

        • Name — (String)

          Name of the Amazon Rekognition stream processor.

        • Status — (String)

          Current status of the Amazon Rekognition stream processor.

          Possible values include:
          • "STOPPED"
          • "STARTING"
          • "RUNNING"
          • "FAILED"
          • "STOPPING"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.

This operation requires permissions to perform the rekognition:ListTagsForResource action.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
rekognition.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      Amazon Resource Name (ARN) of the model, collection, or stream processor that contains the tags that you want a list of.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>)

        A list of key-value tags assigned to the resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

recognizeCelebrities(params = {}, callback) ⇒ AWS.Request

Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.

RecognizeCelebrities returns the 64 largest faces in the image. It lists the recognized celebrities in the CelebrityFaces array and any unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 64 faces in the image.

For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image.

Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the GetCelebrityInfo operation.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.

Service Reference:

Examples:

Calling the recognizeCelebrities operation

var params = {
  Image: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  }
};
rekognition.recognizeCelebrities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Image — (map)

      The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

      If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

      • Bytes — (Buffer, Typed Array, Blob, String)

        Blob of image bytes up to 5 MBs.

      • S3Object — (map)

        Identifies an S3 object as the image source.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CelebrityFaces — (Array<map>)

        Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64 celebrities in an image. Each celebrity object includes the following attributes: Face, Confidence, Emotions, Landmarks, Pose, Quality, Smile, Id, KnownGender, MatchConfidence, Name, Urls.

        • Urls — (Array<String>)

          An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.

        • Name — (String)

          The name of the celebrity.

        • Id — (String)

          A unique identifier for the celebrity.

        • Face — (map)

          Provides information about the celebrity's face, such as its location on the image.

          • BoundingBox — (map)

            Bounding box of the face.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • Confidence — (Float)

            Level of confidence that what the bounding box contains is a face.

          • Landmarks — (Array<map>)

            An array of facial landmarks.

            • Type — (String)

              Type of landmark.

              Possible values include:
              • "eyeLeft"
              • "eyeRight"
              • "nose"
              • "mouthLeft"
              • "mouthRight"
              • "leftEyeBrowLeft"
              • "leftEyeBrowRight"
              • "leftEyeBrowUp"
              • "rightEyeBrowLeft"
              • "rightEyeBrowRight"
              • "rightEyeBrowUp"
              • "leftEyeLeft"
              • "leftEyeRight"
              • "leftEyeUp"
              • "leftEyeDown"
              • "rightEyeLeft"
              • "rightEyeRight"
              • "rightEyeUp"
              • "rightEyeDown"
              • "noseLeft"
              • "noseRight"
              • "mouthUp"
              • "mouthDown"
              • "leftPupil"
              • "rightPupil"
              • "upperJawlineLeft"
              • "midJawlineLeft"
              • "chinBottom"
              • "midJawlineRight"
              • "upperJawlineRight"
            • X — (Float)

              The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

            • Y — (Float)

              The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

          • Pose — (map)

            Indicates the pose of the face as determined by its pitch, roll, and yaw.

            • Roll — (Float)

              Value representing the face rotation on the roll axis.

            • Yaw — (Float)

              Value representing the face rotation on the yaw axis.

            • Pitch — (Float)

              Value representing the face rotation on the pitch axis.

          • Quality — (map)

            Identifies face image brightness and sharpness.

            • Brightness — (Float)

              Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

            • Sharpness — (Float)

              Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

          • Emotions — (Array<map>)

            The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

            • Type — (String)

              Type of emotion detected.

              Possible values include:
              • "HAPPY"
              • "SAD"
              • "ANGRY"
              • "CONFUSED"
              • "DISGUSTED"
              • "SURPRISED"
              • "CALM"
              • "UNKNOWN"
              • "FEAR"
            • Confidence — (Float)

              Level of confidence in the determination.

          • Smile — (map)

            Indicates whether or not the face is smiling, and the confidence level in the determination.

            • Value — (Boolean)

              Boolean value that indicates whether the face is smiling or not.

            • Confidence — (Float)

              Level of confidence in the determination.

        • MatchConfidence — (Float)

          The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.

        • KnownGender — (map)

          The known gender identity for the celebrity that matches the provided ID.

          • Type — (String)

            A string value of the KnownGender info about the Celebrity.

            Possible values include:
            • "Male"
            • "Female"
      • UnrecognizedFaces — (Array<map>)

        Details about each unrecognized face in the image.

        • BoundingBox — (map)

          Bounding box of the face.

          • Width — (Float)

            Width of the bounding box as a ratio of the overall image width.

          • Height — (Float)

            Height of the bounding box as a ratio of the overall image height.

          • Left — (Float)

            Left coordinate of the bounding box as a ratio of overall image width.

          • Top — (Float)

            Top coordinate of the bounding box as a ratio of overall image height.

        • Confidence — (Float)

          Level of confidence that what the bounding box contains is a face.

        • Landmarks — (Array<map>)

          An array of facial landmarks.

          • Type — (String)

            Type of landmark.

            Possible values include:
            • "eyeLeft"
            • "eyeRight"
            • "nose"
            • "mouthLeft"
            • "mouthRight"
            • "leftEyeBrowLeft"
            • "leftEyeBrowRight"
            • "leftEyeBrowUp"
            • "rightEyeBrowLeft"
            • "rightEyeBrowRight"
            • "rightEyeBrowUp"
            • "leftEyeLeft"
            • "leftEyeRight"
            • "leftEyeUp"
            • "leftEyeDown"
            • "rightEyeLeft"
            • "rightEyeRight"
            • "rightEyeUp"
            • "rightEyeDown"
            • "noseLeft"
            • "noseRight"
            • "mouthUp"
            • "mouthDown"
            • "leftPupil"
            • "rightPupil"
            • "upperJawlineLeft"
            • "midJawlineLeft"
            • "chinBottom"
            • "midJawlineRight"
            • "upperJawlineRight"
          • X — (Float)

            The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

          • Y — (Float)

            The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

        • Pose — (map)

          Indicates the pose of the face as determined by its pitch, roll, and yaw.

          • Roll — (Float)

            Value representing the face rotation on the roll axis.

          • Yaw — (Float)

            Value representing the face rotation on the yaw axis.

          • Pitch — (Float)

            Value representing the face rotation on the pitch axis.

        • Quality — (map)

          Identifies face image brightness and sharpness.

          • Brightness — (Float)

            Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

          • Sharpness — (Float)

            Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

        • Emotions — (Array<map>)

          The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

          • Type — (String)

            Type of emotion detected.

            Possible values include:
            • "HAPPY"
            • "SAD"
            • "ANGRY"
            • "CONFUSED"
            • "DISGUSTED"
            • "SURPRISED"
            • "CALM"
            • "UNKNOWN"
            • "FEAR"
          • Confidence — (Float)

            Level of confidence in the determination.

        • Smile — (map)

          Indicates whether or not the face is smiling, and the confidence level in the determination.

          • Value — (Boolean)

            Boolean value that indicates whether the face is smiling or not.

          • Confidence — (Float)

            Level of confidence in the determination.

      • OrientationCorrection — (String)
        Note: Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. Any returned values for this field included in an API response will always be NULL.

        The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in CelebrityFaces and UnrecognizedFaces represent face locations before the image orientation is corrected.

        Note: If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection is null. The CelebrityFaces and UnrecognizedFaces bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
        Possible values include:
        • "ROTATE_0"
        • "ROTATE_90"
        • "ROTATE_180"
        • "ROTATE_270"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

searchFaces(params = {}, callback) ⇒ AWS.Request

For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.

Note: You can also search faces without indexing faces by using the SearchFacesByImage operation.

The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face.

For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:SearchFaces action.

Service Reference:

Examples:

To delete a face


/* This operation searches for matching faces in the collection the supplied face belongs to. */

 var params = {
  CollectionId: "myphotos", 
  FaceId: "70008e50-75e4-55d0-8e80-363fb73b3a14", 
  FaceMatchThreshold: 90, 
  MaxFaces: 10
 };
 rekognition.searchFaces(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    FaceMatches: [
       {
      Face: {
       BoundingBox: {
        Height: 0.3259260058403015, 
        Left: 0.5144439935684204, 
        Top: 0.15111100673675537, 
        Width: 0.24444399774074554
       }, 
       Confidence: 99.99949645996094, 
       FaceId: "8be04dba-4e58-520d-850e-9eae4af70eb2", 
       ImageId: "465f4e93-763e-51d0-b030-b9667a2d94b1"
      }, 
      Similarity: 99.97222137451172
     }, 
       {
      Face: {
       BoundingBox: {
        Height: 0.16555599868297577, 
        Left: 0.30963000655174255, 
        Top: 0.7066670060157776, 
        Width: 0.22074100375175476
       }, 
       Confidence: 100, 
       FaceId: "29a75abe-397b-5101-ba4f-706783b2246c", 
       ImageId: "147fdf82-7a71-52cf-819b-e786c7b9746e"
      }, 
      Similarity: 97.04154968261719
     }, 
       {
      Face: {
       BoundingBox: {
        Height: 0.18888899683952332, 
        Left: 0.3783380091190338, 
        Top: 0.2355560064315796, 
        Width: 0.25222599506378174
       }, 
       Confidence: 99.9999008178711, 
       FaceId: "908544ad-edc3-59df-8faf-6a87cc256cf5", 
       ImageId: "3c731605-d772-541a-a5e7-0375dbc68a07"
      }, 
      Similarity: 95.94520568847656
     }
    ], 
    SearchedFaceId: "70008e50-75e4-55d0-8e80-363fb73b3a14"
   }
   */
 });

Calling the searchFaces operation

var params = {
  CollectionId: 'STRING_VALUE', /* required */
  FaceId: 'STRING_VALUE', /* required */
  FaceMatchThreshold: 'NUMBER_VALUE',
  MaxFaces: 'NUMBER_VALUE'
};
rekognition.searchFaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CollectionId — (String)

      ID of the collection the face belongs to.

    • FaceId — (String)

      ID of a face to find matches for in the collection.

    • MaxFaces — (Integer)

      Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

    • FaceMatchThreshold — (Float)

      Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SearchedFaceId — (String)

        ID of the face that was searched for matches in a collection.

      • FaceMatches — (Array<map>)

        An array of faces that matched the input face, along with the confidence in the match.

        • Similarity — (Float)

          Confidence in the match of this face with the input face.

        • Face — (map)

          Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.

          • FaceId — (String)

            Unique identifier that Amazon Rekognition assigns to the face.

          • BoundingBox — (map)

            Bounding box of the face.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • ImageId — (String)

            Unique identifier that Amazon Rekognition assigns to the input image.

          • ExternalImageId — (String)

            Identifier that you assign to all the faces in the input image.

          • Confidence — (Float)

            Confidence level that the bounding box contains a face (and not a different object such as a tree).

      • FaceModelVersion — (String)

        Version number of the face detection model associated with the input collection (CollectionId).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

searchFacesByImage(params = {}, callback) ⇒ AWS.Request

For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.

Note: To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation. You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.

If no faces are detected in the input image, SearchFacesByImage returns an InvalidParameterException error.

For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar for filtering by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.

Note: To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

This operation requires permissions to perform the rekognition:SearchFacesByImage action.

Service Reference:

Examples:

To search for faces matching a supplied image


/* This operation searches for faces in a Rekognition collection that match the largest face in an S3 bucket stored image. */

 var params = {
  CollectionId: "myphotos", 
  FaceMatchThreshold: 95, 
  Image: {
   S3Object: {
    Bucket: "mybucket", 
    Name: "myphoto"
   }
  }, 
  MaxFaces: 5
 };
 rekognition.searchFacesByImage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    FaceMatches: [
       {
      Face: {
       BoundingBox: {
        Height: 0.3234420120716095, 
        Left: 0.3233329951763153, 
        Top: 0.5, 
        Width: 0.24222199618816376
       }, 
       Confidence: 99.99829864501953, 
       FaceId: "38271d79-7bc2-5efb-b752-398a8d575b85", 
       ImageId: "d5631190-d039-54e4-b267-abd22c8647c5"
      }, 
      Similarity: 99.97036743164062
     }
    ], 
    SearchedFaceBoundingBox: {
     Height: 0.33481481671333313, 
     Left: 0.31888890266418457, 
     Top: 0.4933333396911621, 
     Width: 0.25
    }, 
    SearchedFaceConfidence: 99.9991226196289
   }
   */
 });

Calling the searchFacesByImage operation

var params = {
  CollectionId: 'STRING_VALUE', /* required */
  Image: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  FaceMatchThreshold: 'NUMBER_VALUE',
  MaxFaces: 'NUMBER_VALUE',
  QualityFilter: NONE | AUTO | LOW | MEDIUM | HIGH
};
rekognition.searchFacesByImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CollectionId — (String)

      ID of the collection to search.

    • Image — (map)

      The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

      If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

      • Bytes — (Buffer, Typed Array, Blob, String)

        Blob of image bytes up to 5 MBs.

      • S3Object — (map)

        Identifies an S3 object as the image source.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • MaxFaces — (Integer)

      Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

    • FaceMatchThreshold — (Float)

      (Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

    • QualityFilter — (String)

      A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

      To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

      Possible values include:
      • "NONE"
      • "AUTO"
      • "LOW"
      • "MEDIUM"
      • "HIGH"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SearchedFaceBoundingBox — (map)

        The bounding box around the face in the input image that Amazon Rekognition used for the search.

        • Width — (Float)

          Width of the bounding box as a ratio of the overall image width.

        • Height — (Float)

          Height of the bounding box as a ratio of the overall image height.

        • Left — (Float)

          Left coordinate of the bounding box as a ratio of overall image width.

        • Top — (Float)

          Top coordinate of the bounding box as a ratio of overall image height.

      • SearchedFaceConfidence — (Float)

        The level of confidence that the searchedFaceBoundingBox, contains a face.

      • FaceMatches — (Array<map>)

        An array of faces that match the input face, along with the confidence in the match.

        • Similarity — (Float)

          Confidence in the match of this face with the input face.

        • Face — (map)

          Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.

          • FaceId — (String)

            Unique identifier that Amazon Rekognition assigns to the face.

          • BoundingBox — (map)

            Bounding box of the face.

            • Width — (Float)

              Width of the bounding box as a ratio of the overall image width.

            • Height — (Float)

              Height of the bounding box as a ratio of the overall image height.

            • Left — (Float)

              Left coordinate of the bounding box as a ratio of overall image width.

            • Top — (Float)

              Top coordinate of the bounding box as a ratio of overall image height.

          • ImageId — (String)

            Unique identifier that Amazon Rekognition assigns to the input image.

          • ExternalImageId — (String)

            Identifier that you assign to all the faces in the input image.

          • Confidence — (Float)

            Confidence level that the bounding box contains a face (and not a different object such as a tree).

      • FaceModelVersion — (String)

        Version number of the face detection model associated with the input collection (CollectionId).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startCelebrityRecognition(params = {}, callback) ⇒ AWS.Request

Starts asynchronous recognition of celebrities in a stored video.

Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier (JobId) from the initial call to StartCelebrityRecognition.

For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.

Service Reference:

Examples:

Calling the startCelebrityRecognition operation

var params = {
  Video: { /* required */
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  ClientRequestToken: 'STRING_VALUE',
  JobTag: 'STRING_VALUE',
  NotificationChannel: {
    RoleArn: 'STRING_VALUE', /* required */
    SNSTopicArn: 'STRING_VALUE' /* required */
  }
};
rekognition.startCelebrityRecognition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Video — (map)

      The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

      • S3Object — (map)

        The Amazon S3 bucket name and file name for the video.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • ClientRequestToken — (String)

      Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    • NotificationChannel — (map)

      The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

      • SNSTopicArn — required — (String)

        The Amazon SNS topic to which Amazon Rekognition to posts the completion status.

      • RoleArn — required — (String)

        The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.

    • JobTag — (String)

      An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a subsequent call to GetCelebrityRecognition.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startContentModeration(params = {}, callback) ⇒ AWS.Request

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.

Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration returns a job identifier (JobId) which you use to get the results of the analysis. When content analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

For more information, see Content moderation in the Amazon Rekognition Developer Guide.

Service Reference:

Examples:

Calling the startContentModeration operation

var params = {
  Video: { /* required */
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  ClientRequestToken: 'STRING_VALUE',
  JobTag: 'STRING_VALUE',
  MinConfidence: 'NUMBER_VALUE',
  NotificationChannel: {
    RoleArn: 'STRING_VALUE', /* required */
    SNSTopicArn: 'STRING_VALUE' /* required */
  }
};
rekognition.startContentModeration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Video — (map)

      The video in which you want to detect inappropriate, unwanted, or offensive content. The video must be stored in an Amazon S3 bucket.

      • S3Object — (map)

        The Amazon S3 bucket name and file name for the video.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • MinConfidence — (Float)

      Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't return any moderated content labels with a confidence level lower than this specified value. If you don't specify MinConfidence, GetContentModeration returns labels with confidence values greater than or equal to 50 percent.

    • ClientRequestToken — (String)

      Idempotent token used to identify the start request. If you use the same token with multiple StartContentModeration requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    • NotificationChannel — (map)

      The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the content analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

      • SNSTopicArn — required — (String)

        The Amazon SNS topic to which Amazon Rekognition to posts the completion status.

      • RoleArn — required — (String)

        The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.

    • JobTag — (String)

      An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier for the content analysis job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startFaceDetection(params = {}, callback) ⇒ AWS.Request

Starts asynchronous detection of faces in a stored video.

Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection.

For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.

Service Reference:

Examples:

Calling the startFaceDetection operation

var params = {
  Video: { /* required */
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  ClientRequestToken: 'STRING_VALUE',
  FaceAttributes: DEFAULT | ALL,
  JobTag: 'STRING_VALUE',
  NotificationChannel: {
    RoleArn: 'STRING_VALUE', /* required */
    SNSTopicArn: 'STRING_VALUE' /* required */
  }
};
rekognition.startFaceDetection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Video — (map)

      The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

      • S3Object — (map)

        The Amazon S3 bucket name and file name for the video.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • ClientRequestToken — (String)

      Idempotent token used to identify the start request. If you use the same token with multiple StartFaceDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    • NotificationChannel — (map)

      The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

      • SNSTopicArn — required — (String)

        The Amazon SNS topic to which Amazon Rekognition to posts the completion status.

      • RoleArn — required — (String)

        The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.

    • FaceAttributes — (String)

      The face attributes you want returned.

      DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

      ALL - All facial attributes are returned.

      Possible values include:
      • "DEFAULT"
      • "ALL"
    • JobTag — (String)

      An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier for the face detection job. Use JobId to identify the job in a subsequent call to GetFaceDetection.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startFaceSearch(params = {}, callback) ⇒ AWS.Request

Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see procedure-person-search-videos.

Service Reference:

Examples:

Calling the startFaceSearch operation

var params = {
  CollectionId: 'STRING_VALUE', /* required */
  Video: { /* required */
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  ClientRequestToken: 'STRING_VALUE',
  FaceMatchThreshold: 'NUMBER_VALUE',
  JobTag: 'STRING_VALUE',
  NotificationChannel: {
    RoleArn: 'STRING_VALUE', /* required */
    SNSTopicArn: 'STRING_VALUE' /* required */
  }
};
rekognition.startFaceSearch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Video — (map)

      The video you want to search. The video must be stored in an Amazon S3 bucket.

      • S3Object — (map)

        The Amazon S3 bucket name and file name for the video.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • ClientRequestToken — (String)

      Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    • FaceMatchThreshold — (Float)

      The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

    • CollectionId — (String)

      ID of the collection that contains the faces you want to search for.

    • NotificationChannel — (map)

      The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

      • SNSTopicArn — required — (String)

        The Amazon SNS topic to which Amazon Rekognition to posts the completion status.

      • RoleArn — required — (String)

        The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.

    • JobTag — (String)

      An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier for the search job. Use JobId to identify the job in a subsequent call to GetFaceSearch.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startLabelDetection(params = {}, callback) ⇒ AWS.Request

Starts asynchronous detection of labels in a stored video.

Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection.

Service Reference:

Examples:

Calling the startLabelDetection operation

var params = {
  Video: { /* required */
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  ClientRequestToken: 'STRING_VALUE',
  JobTag: 'STRING_VALUE',
  MinConfidence: 'NUMBER_VALUE',
  NotificationChannel: {
    RoleArn: 'STRING_VALUE', /* required */
    SNSTopicArn: 'STRING_VALUE' /* required */
  }
};
rekognition.startLabelDetection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Video — (map)

      The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.

      • S3Object — (map)

        The Amazon S3 bucket name and file name for the video.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • ClientRequestToken — (String)

      Idempotent token used to identify the start request. If you use the same token with multiple StartLabelDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    • MinConfidence — (Float)

      Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

      If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

    • NotificationChannel — (map)

      The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

      • SNSTopicArn — required — (String)

        The Amazon SNS topic to which Amazon Rekognition to posts the completion status.

      • RoleArn — required — (String)

        The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.

    • JobTag — (String)

      An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier for the label detection job. Use JobId to identify the job in a subsequent call to GetLabelDetection.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startPersonTracking(params = {}, callback) ⇒ AWS.Request

Starts the asynchronous tracking of a person's path in a stored video.

Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.

Service Reference:

Examples:

Calling the startPersonTracking operation

var params = {
  Video: { /* required */
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  ClientRequestToken: 'STRING_VALUE',
  JobTag: 'STRING_VALUE',
  NotificationChannel: {
    RoleArn: 'STRING_VALUE', /* required */
    SNSTopicArn: 'STRING_VALUE' /* required */
  }
};
rekognition.startPersonTracking(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Video — (map)

      The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.

      • S3Object — (map)

        The Amazon S3 bucket name and file name for the video.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • ClientRequestToken — (String)

      Idempotent token used to identify the start request. If you use the same token with multiple StartPersonTracking requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    • NotificationChannel — (map)

      The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

      • SNSTopicArn — required — (String)

        The Amazon SNS topic to which Amazon Rekognition to posts the completion status.

      • RoleArn — required — (String)

        The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.

    • JobTag — (String)

      An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The identifier for the person detection job. Use JobId to identify the job in a subsequent call to GetPersonTracking.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startProjectVersion(params = {}, callback) ⇒ AWS.Request

Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions.

Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels.

Note: You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion.

This operation requires permissions to perform the rekognition:StartProjectVersion action.

Service Reference:

Examples:

Calling the startProjectVersion operation

var params = {
  MinInferenceUnits: 'NUMBER_VALUE', /* required */
  ProjectVersionArn: 'STRING_VALUE' /* required */
};
rekognition.startProjectVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProjectVersionArn — (String)

      The Amazon Resource Name(ARN) of the model version that you want to start.

    • MinInferenceUnits — (Integer)

      The minimum number of inference units to use. A single inference unit represents 1 hour of processing and can support up to 5 Transaction Pers Second (TPS). Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (String)

        The current running status of the model.

        Possible values include:
        • "TRAINING_IN_PROGRESS"
        • "TRAINING_COMPLETED"
        • "TRAINING_FAILED"
        • "STARTING"
        • "RUNNING"
        • "FAILED"
        • "STOPPING"
        • "STOPPED"
        • "DELETING"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startSegmentDetection(params = {}, callback) ⇒ AWS.Request

Starts asynchronous detection of segment detection in a stored video.

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues.

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call to StartSegmentDetection.

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

Service Reference:

Examples:

Calling the startSegmentDetection operation

var params = {
  SegmentTypes: [ /* required */
    TECHNICAL_CUE | SHOT,
    /* more items */
  ],
  Video: { /* required */
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  ClientRequestToken: 'STRING_VALUE',
  Filters: {
    ShotFilter: {
      MinSegmentConfidence: 'NUMBER_VALUE'
    },
    TechnicalCueFilter: {
      BlackFrame: {
        MaxPixelThreshold: 'NUMBER_VALUE',
        MinCoveragePercentage: 'NUMBER_VALUE'
      },
      MinSegmentConfidence: 'NUMBER_VALUE'
    }
  },
  JobTag: 'STRING_VALUE',
  NotificationChannel: {
    RoleArn: 'STRING_VALUE', /* required */
    SNSTopicArn: 'STRING_VALUE' /* required */
  }
};
rekognition.startSegmentDetection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Video — (map)

      Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

      • S3Object — (map)

        The Amazon S3 bucket name and file name for the video.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • ClientRequestToken — (String)

      Idempotent token used to identify the start request. If you use the same token with multiple StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    • NotificationChannel — (map)

      The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

      • SNSTopicArn — required — (String)

        The Amazon SNS topic to which Amazon Rekognition to posts the completion status.

      • RoleArn — required — (String)

        The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.

    • JobTag — (String)

      An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

    • Filters — (map)

      Filters for technical cue or shot detection.

      • TechnicalCueFilter — (map)

        Filters that are specific to technical cues.

        • MinSegmentConfidence — (Float)

          Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level lower than this specified value.

          If you don't specify MinSegmentConfidence, GetSegmentDetection returns segments with confidence values greater than or equal to 50 percent.

        • BlackFrame — (map)

          A filter that allows you to control the black frame detection by specifying the black levels and pixel coverage of black pixels in a frame. Videos can come from multiple sources, formats, and time periods, with different standards and varying noise levels for black frames that need to be accounted for.

          • MaxPixelThreshold — (Float)

            A threshold used to determine the maximum luminance value for a pixel to be considered black. In a full color range video, luminance values range from 0-255. A pixel value of 0 is pure black, and the most strict filter. The maximum black pixel value is computed as follows: max_black_pixel_value = minimum_luminance + MaxPixelThreshold *luminance_range.

            For example, for a full range video with BlackPixelThreshold = 0.1, max_black_pixel_value is 0 + 0.1 * (255-0) = 25.5.

            The default value of MaxPixelThreshold is 0.2, which maps to a max_black_pixel_value of 51 for a full range video. You can lower this threshold to be more strict on black levels.

          • MinCoveragePercentage — (Float)

            The minimum percentage of pixels in a frame that need to have a luminance below the max_black_pixel_value for a frame to be considered a black frame. Luminance is calculated using the BT.709 matrix.

            The default value is 99, which means at least 99% of all pixels in the frame are black pixels as per the MaxPixelThreshold set. You can reduce this value to allow more noise on the black frame.

      • ShotFilter — (map)

        Filters that are specific to shot detections.

        • MinSegmentConfidence — (Float)

          Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level lower than this specified value.

          If you don't specify MinSegmentConfidence, the GetSegmentDetection returns segments with confidence values greater than or equal to 50 percent.

    • SegmentTypes — (Array<String>)

      An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        Unique identifier for the segment detection job. The JobId is returned from StartSegmentDetection.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startStreamProcessor(params = {}, callback) ⇒ AWS.Request

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.

Service Reference:

Examples:

Calling the startStreamProcessor operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
rekognition.startStreamProcessor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      The name of the stream processor to start processing.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startTextDetection(params = {}, callback) ⇒ AWS.Request

Starts asynchronous detection of text in a stored video.

Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartTextDetection returns a job identifier (JobId) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call to StartTextDetection.

Service Reference:

Examples:

Calling the startTextDetection operation

var params = {
  Video: { /* required */
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  ClientRequestToken: 'STRING_VALUE',
  Filters: {
    RegionsOfInterest: [
      {
        BoundingBox: {
          Height: 'NUMBER_VALUE',
          Left: 'NUMBER_VALUE',
          Top: 'NUMBER_VALUE',
          Width: 'NUMBER_VALUE'
        }
      },
      /* more items */
    ],
    WordFilter: {
      MinBoundingBoxHeight: 'NUMBER_VALUE',
      MinBoundingBoxWidth: 'NUMBER_VALUE',
      MinConfidence: 'NUMBER_VALUE'
    }
  },
  JobTag: 'STRING_VALUE',
  NotificationChannel: {
    RoleArn: 'STRING_VALUE', /* required */
    SNSTopicArn: 'STRING_VALUE' /* required */
  }
};
rekognition.startTextDetection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Video — (map)

      Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

      • S3Object — (map)

        The Amazon S3 bucket name and file name for the video.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

          If the bucket is versioning enabled, you can specify the object version.

    • ClientRequestToken — (String)

      Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

    • NotificationChannel — (map)

      The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic. For more information, see Giving access to multiple Amazon SNS topics.

      • SNSTopicArn — required — (String)

        The Amazon SNS topic to which Amazon Rekognition to posts the completion status.

      • RoleArn — required — (String)

        The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.

    • JobTag — (String)

      An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

    • Filters — (map)

      Optional parameters that let you set criteria the text must meet to be included in your response.

      • WordFilter — (map)

        Filters focusing on qualities of the text, such as confidence or size.

        • MinConfidence — (Float)

          Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 50 and 100 as Text in Video will not return any result below 50.

        • MinBoundingBoxHeight — (Float)

          Sets the minimum height of the word bounding box. Words with bounding box heights lesser than this value will be excluded from the result. Value is relative to the video frame height.

        • MinBoundingBoxWidth — (Float)

          Sets the minimum width of the word bounding box. Words with bounding boxes widths lesser than this value will be excluded from the result. Value is relative to the video frame width.

      • RegionsOfInterest — (Array<map>)

        Filter focusing on a certain area of the frame. Uses a BoundingBox object to set the region of the screen.

        • BoundingBox — (map)

          The box representing a region of interest on screen.

          • Width — (Float)

            Width of the bounding box as a ratio of the overall image width.

          • Height — (Float)

            Height of the bounding box as a ratio of the overall image height.

          • Left — (Float)

            Left coordinate of the bounding box as a ratio of overall image width.

          • Top — (Float)

            Top coordinate of the bounding box as a ratio of overall image height.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        Identifier for the text detection job. Use JobId to identify the job in a subsequent call to GetTextDetection.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopProjectVersion(params = {}, callback) ⇒ AWS.Request

Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions.

Service Reference:

Examples:

Calling the stopProjectVersion operation

var params = {
  ProjectVersionArn: 'STRING_VALUE' /* required */
};
rekognition.stopProjectVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProjectVersionArn — (String)

      The Amazon Resource Name (ARN) of the model version that you want to delete.

      This operation requires permissions to perform the rekognition:StopProjectVersion action.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (String)

        The current status of the stop operation.

        Possible values include:
        • "TRAINING_IN_PROGRESS"
        • "TRAINING_COMPLETED"
        • "TRAINING_FAILED"
        • "STARTING"
        • "RUNNING"
        • "FAILED"
        • "STOPPING"
        • "STOPPED"
        • "DELETING"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopStreamProcessor(params = {}, callback) ⇒ AWS.Request

Stops a running stream processor that was created by CreateStreamProcessor.

Service Reference:

Examples:

Calling the stopStreamProcessor operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
rekognition.stopStreamProcessor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model. For more information, see Tagging AWS Resources.

This operation requires permissions to perform the rekognition:TagResource action.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
rekognition.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to assign the tags to.

    • Tags — (map<String>)

      The key-value tags to assign to the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.

This operation requires permissions to perform the rekognition:UntagResource action.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
rekognition.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to remove the tags from.

    • TagKeys — (Array<String>)

      A list of the tags that you want to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateDatasetEntries(params = {}, callback) ⇒ AWS.Request

Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.

If the source-ref field in the JSON line references an existing image, the existing image in the dataset is updated. If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

You specify the changes that you want to make in the Changes input parameter. There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less than 5MB.

UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete. Use DescribeDataset to check the current status. The dataset updated successfully if the value of Status is UPDATE_COMPLETE.

To check if any non-terminal errors occured, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.

Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.

This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.

Service Reference:

Examples:

Calling the updateDatasetEntries operation

var params = {
  Changes: { /* required */
    GroundTruth: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */ /* required */
  },
  DatasetArn: 'STRING_VALUE' /* required */
};
rekognition.updateDatasetEntries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetArn — (String)

      The Amazon Resource Name (ARN) of the dataset that you want to update.

    • Changes — (map)

      The changes that you want to make to the dataset.

      • GroundTruth — required — (Buffer, Typed Array, Blob, String)

        A Base64-encoded binary data object containing one or JSON lines that either update the dataset or are additions to the dataset. You change a dataset by calling UpdateDatasetEntries. If you are using an AWS SDK to call UpdateDatasetEntries, you don't need to encode Changes as the SDK encodes the data for you.

        For example JSON lines, see Image-Level labels in manifest files and and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Rekognition resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the projectVersionTrainingCompleted state

var params = {
  ProjectArn: 'STRING_VALUE', /* required */
};
rekognition.waitFor('projectVersionTrainingCompleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

rekognition.waitFor('projectVersionTrainingCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the projectVersionTrainingCompleted state by periodically calling the underlying Rekognition.describeProjectVersions() operation every 120 seconds (at most 360 times).

Examples:

Waiting for the projectVersionTrainingCompleted state

var params = {
  ProjectArn: 'STRING_VALUE', /* required */
};
rekognition.waitFor('projectVersionTrainingCompleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • ProjectArn — (String)

      The Amazon Resource Name (ARN) of the project that contains the models you want to describe.

    • VersionNames — (Array<String>)

      A list of model version names that you want to describe. You can add up to 10 model version names to the list. If you don't specify a value, all model descriptions are returned. A version name is part of a model (ProjectVersion) ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the following ARN. arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.

    • NextToken — (String)

      If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProjectVersionDescriptions — (Array<map>)

        A list of model descriptions. The list is sorted by the creation date and time of the model versions, latest to earliest.

        • ProjectVersionArn — (String)

          The Amazon Resource Name (ARN) of the model version.

        • CreationTimestamp — (Date)

          The Unix datetime for the date and time that training started.

        • MinInferenceUnits — (Integer)

          The minimum number of inference units used by the model. For more information, see StartProjectVersion.

        • Status — (String)

          The current status of the model version.

          Possible values include:
          • "TRAINING_IN_PROGRESS"
          • "TRAINING_COMPLETED"
          • "TRAINING_FAILED"
          • "STARTING"
          • "RUNNING"
          • "FAILED"
          • "STOPPING"
          • "STOPPED"
          • "DELETING"
        • StatusMessage — (String)

          A descriptive message for an error or warning that occurred.

        • BillableTrainingTimeInSeconds — (Integer)

          The duration, in seconds, that you were billed for a successful training of the model version. This value is only returned if the model version has been successfully trained.

        • TrainingEndTimestamp — (Date)

          The Unix date and time that training of the model ended.

        • OutputConfig — (map)

          The location where training results are saved.

          • S3Bucket — (String)

            The S3 bucket where training output is placed.

          • S3KeyPrefix — (String)

            The prefix applied to the training output files.

        • TrainingDataResult — (map)

          Contains information about the training results.

          • Input — (map)

            The training assets that you supplied for training.

            • Assets — (Array<map>)

              A Sagemaker GroundTruth manifest file that contains the training images (assets).

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

          • Output — (map)

            The images (assets) that were actually trained by Amazon Rekognition Custom Labels.

            • Assets — (Array<map>)

              A Sagemaker GroundTruth manifest file that contains the training images (assets).

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

          • Validation — (map)

            The location of the data validation manifest. The data validation manifest is created for the training dataset during model training.

            • Assets — (Array<map>)

              The assets that comprise the validation data.

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

        • TestingDataResult — (map)

          Contains information about the testing results.

          • Input — (map)

            The testing dataset that was supplied for training.

            • Assets — (Array<map>)

              The assets used for testing.

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

            • AutoCreate — (Boolean)

              If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job. After training completes, the test dataset is not stored and the training dataset reverts to its previous size.

          • Output — (map)

            The subset of the dataset that was actually tested. Some images (assets) might not be tested due to file formatting and other issues.

            • Assets — (Array<map>)

              The assets used for testing.

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

            • AutoCreate — (Boolean)

              If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job. After training completes, the test dataset is not stored and the training dataset reverts to its previous size.

          • Validation — (map)

            The location of the data validation manifest. The data validation manifest is created for the test dataset during model training.

            • Assets — (Array<map>)

              The assets that comprise the validation data.

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

        • EvaluationResult — (map)

          The training results. EvaluationResult is only returned if training is successful.

          • F1Score — (Float)

            The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision and recall performance of the model as a single value. A higher value indicates better precision and recall performance. A lower score indicates that precision, recall, or both are performing poorly.

          • Summary — (map)

            The S3 bucket that contains the training summary.

            • S3Object — (map)

              Provides the S3 bucket name and object name.

              The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

              For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

              • Bucket — (String)

                Name of the S3 bucket.

              • Name — (String)

                S3 object key name.

              • Version — (String)

                If the bucket is versioning enabled, you can specify the object version.

        • ManifestSummary — (map)

          The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.

          • S3Object — (map)

            Provides the S3 bucket name and object name.

            The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

            For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

            • Bucket — (String)

              Name of the S3 bucket.

            • Name — (String)

              S3 object key name.

            • Version — (String)

              If the bucket is versioning enabled, you can specify the object version.

        • KmsKeyId — (String)

          The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.

      • NextToken — (String)

        If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

rekognition.waitFor('projectVersionRunning', params = {}, [callback]) ⇒ AWS.Request

Waits for the projectVersionRunning state by periodically calling the underlying Rekognition.describeProjectVersions() operation every 30 seconds (at most 40 times).

Examples:

Waiting for the projectVersionRunning state

var params = {
  ProjectArn: 'STRING_VALUE', /* required */
};
rekognition.waitFor('projectVersionRunning', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • ProjectArn — (String)

      The Amazon Resource Name (ARN) of the project that contains the models you want to describe.

    • VersionNames — (Array<String>)

      A list of model version names that you want to describe. You can add up to 10 model version names to the list. If you don't specify a value, all model descriptions are returned. A version name is part of a model (ProjectVersion) ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the following ARN. arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.

    • NextToken — (String)

      If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProjectVersionDescriptions — (Array<map>)

        A list of model descriptions. The list is sorted by the creation date and time of the model versions, latest to earliest.

        • ProjectVersionArn — (String)

          The Amazon Resource Name (ARN) of the model version.

        • CreationTimestamp — (Date)

          The Unix datetime for the date and time that training started.

        • MinInferenceUnits — (Integer)

          The minimum number of inference units used by the model. For more information, see StartProjectVersion.

        • Status — (String)

          The current status of the model version.

          Possible values include:
          • "TRAINING_IN_PROGRESS"
          • "TRAINING_COMPLETED"
          • "TRAINING_FAILED"
          • "STARTING"
          • "RUNNING"
          • "FAILED"
          • "STOPPING"
          • "STOPPED"
          • "DELETING"
        • StatusMessage — (String)

          A descriptive message for an error or warning that occurred.

        • BillableTrainingTimeInSeconds — (Integer)

          The duration, in seconds, that you were billed for a successful training of the model version. This value is only returned if the model version has been successfully trained.

        • TrainingEndTimestamp — (Date)

          The Unix date and time that training of the model ended.

        • OutputConfig — (map)

          The location where training results are saved.

          • S3Bucket — (String)

            The S3 bucket where training output is placed.

          • S3KeyPrefix — (String)

            The prefix applied to the training output files.

        • TrainingDataResult — (map)

          Contains information about the training results.

          • Input — (map)

            The training assets that you supplied for training.

            • Assets — (Array<map>)

              A Sagemaker GroundTruth manifest file that contains the training images (assets).

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

          • Output — (map)

            The images (assets) that were actually trained by Amazon Rekognition Custom Labels.

            • Assets — (Array<map>)

              A Sagemaker GroundTruth manifest file that contains the training images (assets).

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

          • Validation — (map)

            The location of the data validation manifest. The data validation manifest is created for the training dataset during model training.

            • Assets — (Array<map>)

              The assets that comprise the validation data.

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

        • TestingDataResult — (map)

          Contains information about the testing results.

          • Input — (map)

            The testing dataset that was supplied for training.

            • Assets — (Array<map>)

              The assets used for testing.

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

            • AutoCreate — (Boolean)

              If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job. After training completes, the test dataset is not stored and the training dataset reverts to its previous size.

          • Output — (map)

            The subset of the dataset that was actually tested. Some images (assets) might not be tested due to file formatting and other issues.

            • Assets — (Array<map>)

              The assets used for testing.

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

            • AutoCreate — (Boolean)

              If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job. After training completes, the test dataset is not stored and the training dataset reverts to its previous size.

          • Validation — (map)

            The location of the data validation manifest. The data validation manifest is created for the test dataset during model training.

            • Assets — (Array<map>)

              The assets that comprise the validation data.

              • GroundTruthManifest — (map)

                The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

                • S3Object — (map)

                  Provides the S3 bucket name and object name.

                  The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

                  For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

                  • Bucket — (String)

                    Name of the S3 bucket.

                  • Name — (String)

                    S3 object key name.

                  • Version — (String)

                    If the bucket is versioning enabled, you can specify the object version.

        • EvaluationResult — (map)

          The training results. EvaluationResult is only returned if training is successful.

          • F1Score — (Float)

            The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision and recall performance of the model as a single value. A higher value indicates better precision and recall performance. A lower score indicates that precision, recall, or both are performing poorly.

          • Summary — (map)

            The S3 bucket that contains the training summary.

            • S3Object — (map)

              Provides the S3 bucket name and object name.

              The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

              For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

              • Bucket — (String)

                Name of the S3 bucket.

              • Name — (String)

                S3 object key name.

              • Version — (String)

                If the bucket is versioning enabled, you can specify the object version.

        • ManifestSummary — (map)

          The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.

          • S3Object — (map)

            Provides the S3 bucket name and object name.

            The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

            For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

            • Bucket — (String)

              Name of the S3 bucket.

            • Name — (String)

              S3 object key name.

            • Version — (String)

              If the bucket is versioning enabled, you can specify the object version.

        • KmsKeyId — (String)

          The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.

      • NextToken — (String)

        If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also: