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

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, 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) —

    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'.

  • 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.

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • 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.

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.

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

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.

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: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  TargetImage: { /* required */
    Bytes: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  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.

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 from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

            • Y — (Float)

              The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

          • 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.

      • 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 from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

          • Y — (Float)

            The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

        • 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.

      • 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.

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 */
};
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.

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.

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.

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'
    }
  }
};
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. Default is 70. 0 is the lowest confidence. 100 is the highest confidence.

    • RoleArn — (String)

      ARN of the IAM role that allows access 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.

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.

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.

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. Default is 70. 0 is the lowest confidence. 100 is the highest confidence.

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), gender, 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 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: new Buffer('...') || '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)

          Gender of the face and the confidence level in the determination.

          • Value — (String)

            Gender of the face.

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

            Level of confidence in the determination.

        • 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 detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

          • Type — (String)

            Type of emotion detected.

            Possible values include:
            • "HAPPY"
            • "SAD"
            • "ANGRY"
            • "CONFUSED"
            • "DISGUSTED"
            • "SURPRISED"
            • "CALM"
            • "UNKNOWN"
          • 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 from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

          • Y — (Float)

            The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

        • 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: new Buffer('...') || '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 explicit or suggestive adult 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: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  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.

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 millseconds 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 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.

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 50 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: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_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.

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 text'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 text.

            • 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.

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

Gets the name and additional information about a celebrity based on his or her 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.

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.

Note: GetCelebrityRecognition 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 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.

      • 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)

              Gender of the face and the confidence level in the determination.

              • Value — (String)

                Gender of the face.

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

                Level of confidence in the determination.

            • 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 detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

              • Type — (String)

                Type of emotion detected.

                Possible values include:
                • "HAPPY"
                • "SAD"
                • "ANGRY"
                • "CONFUSED"
                • "DISGUSTED"
                • "SURPRISED"
                • "CALM"
                • "UNKNOWN"
              • 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 from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

              • Y — (Float)

                The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

            • 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.

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

Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by StartContentModeration.

Content moderation analysis of a 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 moderation 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 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 Detecting Unsafe Content 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 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 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.

      • ModerationLabels — (Array<map>)

        The detected moderation labels and the time(s) they were detected.

        • Timestamp — (Integer)

          Time, in milliseconds from the beginning of the video, that the moderation label was detected.

        • ModerationLabel — (map)

          The 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 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 moderation labels.

      • ModerationModelVersion — (String)

        Version number of the moderation detection model that was used to detect unsafe 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.

      • 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)

            Gender of the face and the confidence level in the determination.

            • Value — (String)

              Gender of the face.

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

              Level of confidence in the determination.

          • 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 detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

            • Type — (String)

              Type of emotion detected.

              Possible values include:
              • "HAPPY"
              • "SAD"
              • "ANGRY"
              • "CONFUSED"
              • "DISGUSTED"
              • "SURPRISED"
              • "CALM"
              • "UNKNOWN"
            • 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 from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

            • Y — (Float)

              The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

          • 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.

      • 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)

              Gender of the face and the confidence level in the determination.

              • Value — (String)

                Gender of the face.

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

                Level of confidence in the determination.

            • 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 detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

              • Type — (String)

                Type of emotion detected.

                Possible values include:
                • "HAPPY"
                • "SAD"
                • "ANGRY"
                • "CONFUSED"
                • "DISGUSTED"
                • "SURPRISED"
                • "CALM"
                • "UNKNOWN"
              • 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 from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

              • Y — (Float)

                The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

            • 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.

      • 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.

      • 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)

              Gender of the face and the confidence level in the determination.

              • Value — (String)

                Gender of the face.

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

                Level of confidence in the determination.

            • 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 detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

              • Type — (String)

                Type of emotion detected.

                Possible values include:
                • "HAPPY"
                • "SAD"
                • "ANGRY"
                • "CONFUSED"
                • "DISGUSTED"
                • "SURPRISED"
                • "CALM"
                • "UNKNOWN"
              • 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 from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

              • Y — (Float)

                The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

            • 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.

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 the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By default, IndexFaces filters detected faces. You can also explicitly filter detected faces by specifying AUTO for the value of QualityFilter. 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. 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.

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 like gender. 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: new Buffer('...') || '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
};
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 how much filtering is done to identify faces that are detected with low quality. Filtered faces aren't indexed. If you specify AUTO, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. 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 AUTO.

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

      Possible values include:
      • "NONE"
      • "AUTO"

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)

            Gender of the face and the confidence level in the determination.

            • Value — (String)

              Gender of the face.

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

              Level of confidence in the determination.

          • 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 detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

            • Type — (String)

              Type of emotion detected.

              Possible values include:
              • "HAPPY"
              • "SAD"
              • "ANGRY"
              • "CONFUSED"
              • "DISGUSTED"
              • "SURPRISED"
              • "CALM"
              • "UNKNOWN"
            • 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 from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

            • Y — (Float)

              The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

          • 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)

            Gender of the face and the confidence level in the determination.

            • Value — (String)

              Gender of the face.

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

              Level of confidence in the determination.

          • 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 detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

            • Type — (String)

              Type of emotion detected.

              Possible values include:
              • "HAPPY"
              • "SAD"
              • "ANGRY"
              • "CONFUSED"
              • "DISGUSTED"
              • "SURPRISED"
              • "CALM"
              • "UNKNOWN"
            • 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 from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

            • Y — (Float)

              The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

          • 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.

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.

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 100 largest faces in the image. It lists recognized celebrities in the CelebrityFaces array and unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 100 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: new Buffer('...') || '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 15 celebrities in an image.

        • 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 from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

            • Y — (Float)

              The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

          • 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.

        • MatchConfidence — (Float)

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

      • 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 from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

          • Y — (Float)

            The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

        • 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.

      • OrientationCorrection — (String)

        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%.

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.

For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.

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: new Buffer('...') || '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'
};
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%.

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.

      • 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)

      Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

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 explicit or suggestive adult content in a stored video.

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 moderation 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 moderation 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 Detecting Unsafe Content 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 moderate 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 moderation analysis to.

      • 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)

      Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

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 moderation 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.

      • 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)

      Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

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%.

    • 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.

      • 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)

      Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

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.

      • 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)

      Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

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.

      • 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)

      Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

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.

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.

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.