Class: AWS.Rekognition

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

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

Parameters:

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

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

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

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

      Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to DetectCustomLabels is 4MB.

    • 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. Note that the maximum image size you can pass to DetectCustomLabels is 4MB.

    • S3Object — (map)

      Identifies an S3 object as the image source.

      • Bucket — (String)

        Name of the S3 bucket.

      • Name — (String)

        S3 object key name.

      • Version — (String)

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

  • SimilarityThreshold — (Float)

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

  • QualityFilter — (String)

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

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SourceImageFace — (map)

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

      • BoundingBox — (map)

        Bounding box of the face.

        • Width — (Float)

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

        • Height — (Float)

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

        • Left — (Float)

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

        • Top — (Float)

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

      • Confidence — (Float)

        Confidence level that the selected bounding box contains a face.

    • FaceMatches — (Array<map>)

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

      • Similarity — (Float)

        Level of confidence that the faces match.

      • Face — (map)

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

        • BoundingBox — (map)

          Bounding box of the face.

          • Width — (Float)

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

          • Height — (Float)

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

          • Left — (Float)

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

          • Top — (Float)

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

        • Confidence — (Float)

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

        • Landmarks — (Array<map>)

          An array of facial landmarks.

          • Type — (String)

            Type of landmark.

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

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

          • Y — (Float)

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

        • Pose — (map)

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

          • Roll — (Float)

            Value representing the face rotation on the roll axis.

          • Yaw — (Float)

            Value representing the face rotation on the yaw axis.

          • Pitch — (Float)

            Value representing the face rotation on the pitch axis.

        • Quality — (map)

          Identifies face image brightness and sharpness.

          • Brightness — (Float)

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

          • Sharpness — (Float)

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

        • Emotions — (Array<map>)

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

          • Type — (String)

            Type of emotion detected.

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

            Level of confidence in the determination.

        • Smile — (map)

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

          • Value — (Boolean)

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

          • Confidence — (Float)

            Level of confidence in the determination.

    • UnmatchedFaces — (Array<map>)

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

      • BoundingBox — (map)

        Bounding box of the face.

        • Width — (Float)

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

        • Height — (Float)

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

        • Left — (Float)

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

        • Top — (Float)

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

      • Confidence — (Float)

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

      • Landmarks — (Array<map>)

        An array of facial landmarks.

        • Type — (String)

          Type of landmark.

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

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

        • Y — (Float)

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

      • Pose — (map)

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

        • Roll — (Float)

          Value representing the face rotation on the roll axis.

        • Yaw — (Float)

          Value representing the face rotation on the yaw axis.

        • Pitch — (Float)

          Value representing the face rotation on the pitch axis.

      • Quality — (map)

        Identifies face image brightness and sharpness.

        • Brightness — (Float)

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

        • Sharpness — (Float)

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

      • Emotions — (Array<map>)

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

        • Type — (String)

          Type of emotion detected.

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

          Level of confidence in the determination.

      • Smile — (map)

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

        • Value — (Boolean)

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

        • Confidence — (Float)

          Level of confidence in the determination.

    • SourceImageOrientationCorrection — (String)

      The value of SourceImageOrientationCorrection is always null.

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

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

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

      The value of TargetImageOrientationCorrection is always null.

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

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

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

Returns:

• (AWS.Request) —

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

/* Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. */

 var params = {
  DestinationProjectArn: "arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/1656705098765", 
  KmsKeyId: "arn:1234abcd-12ab-34cd-56ef-1234567890ab", 
  OutputConfig: {
   S3Bucket: "bucket-name", 
   S3KeyPrefix: "path_to_folder"
  }, 
  SourceProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/16565123456", 
  SourceProjectVersionArn: "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/version/model_1/1656611123456", 
  Tags: {
   "key1": "val1"
  }, 
  VersionName: "DestinationVersionName_cross_account"
 };
 rekognition.copyProjectVersion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ProjectVersionArn: "arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/version/DestinationVersionName_cross_account/16567050987651"
   }
   */
 });

var params = {
  DestinationProjectArn: 'STRING_VALUE', /* required */
  OutputConfig: { /* required */
    S3Bucket: 'STRING_VALUE',
    S3KeyPrefix: 'STRING_VALUE'
  },
  SourceProjectArn: 'STRING_VALUE', /* required */
  SourceProjectVersionArn: 'STRING_VALUE', /* required */
  VersionName: 'STRING_VALUE', /* required */
  KmsKeyId: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
rekognition.copyProjectVersion(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: {}) —
  • SourceProjectArn — (String)

    The ARN of the source project in the trusting AWS account.

  • SourceProjectVersionArn — (String)

    The ARN of the model version in the source project that you want to copy to a destination project.

  • DestinationProjectArn — (String)

    The ARN of the project in the trusted AWS account that you want to copy the model version to.

  • VersionName — (String)

    A name for the version of the model that's copied to the destination project.

  • OutputConfig — (map)

    The S3 bucket and folder location where the training output for the source model version is placed.

    • S3Bucket — (String)

      The S3 bucket where training output is placed.

    • S3KeyPrefix — (String)

      The prefix applied to the training output files.

  • Tags — (map<String>)

    The key-value tags to assign to the model version.

  • KmsKeyId — (String)

    The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig).

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

    • kms:CreateGrant

    • kms:DescribeKey

    • kms:GenerateDataKey

    • kms:Decrypt

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProjectVersionArn — (String)

      The ARN of the copied model version in the destination project.

Returns:

• (AWS.Request) —

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

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

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

Parameters:

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

    ID for the collection that you are creating.

  • Tags — (map<String>)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • StatusCode — (Integer)

      HTTP status code indicating the result of the operation.

    • CollectionArn — (String)

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

    • FaceModelVersion — (String)

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

Returns:

• (AWS.Request) —

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

/* Creates an Amazon Rekognition Custom Labels dataset with a manifest file stored in an Amazon S3 bucket. */

 var params = {
  DatasetSource: {
   GroundTruthManifest: {
    S3Object: {
     Bucket: "my-bucket", 
     Name: "datasets/flowers_training/manifests/output/output.manifest"
    }
   }
  }, 
  DatasetType: "TRAIN", 
  ProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815"
 };
 rekognition.createDataset(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DatasetArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1690476084535"
   }
   */
 });

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

Parameters:

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

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

    • GroundTruthManifest — (map)

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

      • S3Object — (map)

        Provides the S3 bucket name and object name.

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

        For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

        • Bucket — (String)

          Name of the S3 bucket.

        • Name — (String)

          S3 object key name.

        • Version — (String)

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

    • DatasetArn — (String)

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

  • DatasetType — (String)

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

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

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

  • Tags — (map<String>)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • DatasetArn — (String)

      The ARN of the created Amazon Rekognition Custom Labels dataset.

Returns:

• (AWS.Request) —

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

var params = {
  ClientRequestToken: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  Settings: {
    AuditImagesLimit: 'NUMBER_VALUE',
    OutputConfig: {
      S3Bucket: 'STRING_VALUE', /* required */
      S3KeyPrefix: 'STRING_VALUE'
    }
  }
};
rekognition.createFaceLivenessSession(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: {}) —
  • KmsKeyId — (String)

    The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.

  • Settings — (map)

    A session settings object. It contains settings for the operation to be performed. For Face Liveness, it accepts OutputConfig and AuditImagesLimit.

    • OutputConfig — (map)

      Can specify the location of an Amazon S3 bucket, where reference and audit images will be stored. Note that the Amazon S3 bucket must be located in the caller's AWS account and in the same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are auto-generated by the Face Liveness system. Requires that the caller has the s3:PutObject permission on the Amazon S3 bucket.

      • S3Bucket — required — (String)

        The path to an AWS Amazon S3 bucket used to store Face Liveness session results.

      • S3KeyPrefix — (String)

        The prefix prepended to the output files for the Face Liveness session results.

    • AuditImagesLimit — (Integer)

      Number of audit images to be returned back. Takes an integer between 0-4. Any integer less than 0 will return 0, any integer above 4 will return 4 images in the response. By default, it is set to 0. The limit is best effort and is based on the actual duration of the selfie-video.

  • ClientRequestToken — (String)

    Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple CreateFaceLivenessSession requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

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:

    • SessionId — (String)

      A unique 128-bit UUID identifying a Face Liveness session. A new sessionID must be used for every Face Liveness check. If a given sessionID is used for subsequent Face Liveness checks, the checks will fail. Additionally, a SessionId expires 3 minutes after it's sent, making all Liveness data associated with the session (e.g., sessionID, reference image, audit images, etc.) unavailable.

Returns:

• (AWS.Request) —

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

/* Creates an Amazon Rekognition Custom Labels project. */

 var params = {
  ProjectName: "my-project"
 };
 rekognition.createProject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285"
   }
   */
 });

var params = {
  ProjectName: 'STRING_VALUE', /* required */
  AutoUpdate: ENABLED | DISABLED,
  Feature: CONTENT_MODERATION | CUSTOM_LABELS,
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
rekognition.createProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The name of the project to create.

  • Feature — (String)

    Specifies feature that is being customized. If no value is provided CUSTOM_LABELS is used as a default.

    Possible values include:
    • "CONTENT_MODERATION"
    • "CUSTOM_LABELS"
  • AutoUpdate — (String)

    Specifies whether automatic retraining should be attempted for the versions of the project. Automatic retraining is done as a best effort. Required argument for Content Moderation. Applicable only to adapters.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • Tags — (map<String>)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProjectArn — (String)

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

Returns:

• (AWS.Request) —

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

/* Trains a version of an Amazon Rekognition Custom Labels model. */

 var params = {
  OutputConfig: {
   S3Bucket: "output_bucket", 
   S3KeyPrefix: "output_folder"
  }, 
  ProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815", 
  VersionName: "1"
 };
 rekognition.createProjectVersion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ProjectVersionArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958"
   }
   */
 });

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

Parameters:

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

    The ARN of the Amazon Rekognition project that will manage the project version you want to train.

  • VersionName — (String)

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

  • OutputConfig — (map)

    The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need s3:PutObject permission on the bucket.

    • S3Bucket — (String)

      The S3 bucket where training output is placed.

    • S3KeyPrefix — (String)

      The prefix applied to the training output files.

  • TrainingData — (map)

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

    • Assets — (Array<map>)

      A manifest file that contains references to the training images and ground-truth annotations.

      • GroundTruthManifest — (map)

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

        • S3Object — (map)

          Provides the S3 bucket name and object name.

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

          For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

          • Bucket — (String)

            Name of the S3 bucket.

          • Name — (String)

            S3 object key name.

          • Version — (String)

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

  • TestingData — (map)

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

    • Assets — (Array<map>)

      The assets used for testing.

      • GroundTruthManifest — (map)

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

        • S3Object — (map)

          Provides the S3 bucket name and object name.

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

          For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

          • Bucket — (String)

            Name of the S3 bucket.

          • Name — (String)

            S3 object key name.

          • Version — (String)

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

    • AutoCreate — (Boolean)

      If specified, Rekognition splits training dataset to create a test dataset for the training job.

  • Tags — (map<String>)

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

  • KmsKeyId — (String)

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

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

    • kms:CreateGrant

    • kms:DescribeKey

    • kms:GenerateDataKey

    • kms:Decrypt

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

  • VersionDescription — (String)

    A description applied to the project version being created.

  • FeatureConfig — (map)

    Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.

    • ContentModeration — (map)

      Configuration options for Custom Moderation training.

      • ConfidenceThreshold — (Float)

        The confidence level you plan to use to identify if unsafe content is present during inference.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProjectVersionArn — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  Input: { /* required */
    KinesisVideoStream: {
      Arn: 'STRING_VALUE'
    }
  },
  Name: 'STRING_VALUE', /* required */
  Output: { /* required */
    KinesisDataStream: {
      Arn: 'STRING_VALUE'
    },
    S3Destination: {
      Bucket: 'STRING_VALUE',
      KeyPrefix: 'STRING_VALUE'
    }
  },
  RoleArn: 'STRING_VALUE', /* required */
  Settings: { /* required */
    ConnectedHome: {
      Labels: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      MinConfidence: 'NUMBER_VALUE'
    },
    FaceSearch: {
      CollectionId: 'STRING_VALUE',
      FaceMatchThreshold: 'NUMBER_VALUE'
    }
  },
  DataSharingPreference: {
    OptIn: true || false /* required */
  },
  KmsKeyId: 'STRING_VALUE',
  NotificationChannel: {
    SNSTopicArn: 'STRING_VALUE' /* required */
  },
  RegionsOfInterest: [
    {
      BoundingBox: {
        Height: 'NUMBER_VALUE',
        Left: 'NUMBER_VALUE',
        Top: 'NUMBER_VALUE',
        Width: 'NUMBER_VALUE'
      },
      Polygon: [
        {
          X: 'NUMBER_VALUE',
          Y: 'NUMBER_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
rekognition.createStreamProcessor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput. This is required for both face search and label detection stream processors.

    • 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 or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. This must be a S3Destination of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.

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

    • S3Destination — (map)

      The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.

      • Bucket — (String)

        The name of the Amazon S3 bucket you want to associate with the streaming video project. You must be the owner of the Amazon S3 bucket.

      • KeyPrefix — (String)

        The prefix value of the location within the bucket that you want the information to be published to. For more information, see Using prefixes.

  • 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. This is required for both face search and label detection stream processors.

  • Settings — (map)

    Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

    • FaceSearch — (map)

      Face search settings to use on a streaming video.

      • CollectionId — (String)

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

      • FaceMatchThreshold — (Float)

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

    • ConnectedHome — (map)

      Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for CreateStreamProcessor. Including this setting in the CreateStreamProcessor request enables you to use the stream processor for label detection. You can then select what you want the stream processor to detect, such as people or pets. When the stream processor has started, one notification is sent for each object class specified. For example, if packages and pets are selected, one SNS notification is published the first time a package is detected and one SNS notification is published the first time a pet is detected, as well as an end-of-session summary.

      • Labels — required — (Array<String>)

        Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".

      • MinConfidence — (Float)

        The minimum confidence required to label an object in the video.

  • RoleArn — (String)

    The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.

  • Tags — (map<String>)

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

  • NotificationChannel — (map)

    The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.

    Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications, one for a person at second 2 and one for a pet at second 4.

    Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.

    • SNSTopicArn — required — (String)

      The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification Service topic to which Amazon Rekognition posts the completion status.

  • KmsKeyId — (String)

    The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.

  • RegionsOfInterest — (Array<map>)

    Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.

    • BoundingBox — (map)

      The box representing a region of interest on screen.

      • Width — (Float)

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

      • Height — (Float)

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

      • Left — (Float)

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

      • Top — (Float)

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

    • Polygon — (Array<map>)

      Specifies a shape made up of up to 10 Point objects to define a region of interest.

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

  • DataSharingPreference — (map)

    Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.

    • OptIn — required — (Boolean)

      If this option is set to true, you choose to share data with Rekognition to improve model performance.

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)

      Amazon Resource Number for the newly created stream processor.

Returns:

• (AWS.Request) —

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

/* Creates a new User within a collection specified by CollectionId. */

 var params = {
  CollectionId: "MyCollection", 
  UserId: "DemoUser"
 };
 rekognition.createUser(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  CollectionId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE'
};
rekognition.createUser(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 the new UserID needs to be created.

  • UserId — (String)

    ID for the UserID to be created. This ID needs to be unique within the collection.

  • ClientRequestToken — (String)

    Idempotent token used to identify the request to CreateUser. If you use the same token with multiple CreateUser requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

    If a token is not provided, the SDK will use a version 4 UUID.

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.

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

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.

/* Deletes an Amazon Rekognition Custom Labels dataset. */

 var params = {
  DatasetArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/test/1690556733321"
 };
 rekognition.deleteDataset(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

/* 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"
    ]
   }
   */
 });

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.

    • UnsuccessfulFaceDeletions — (Array<map>)

      An array of any faces that weren't deleted.

      • FaceId — (String)

        A unique identifier assigned to the face.

      • UserId — (String)

        A provided ID for the UserID. Unique within the collection.

      • Reasons — (Array<String>)

        The reason why the deletion was unsuccessful.

Returns:

• (AWS.Request) —

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

/* Deletes an Amazon Rekognition Custom Labels projects. */

 var params = {
  ProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285"
 };
 rekognition.deleteProject(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Status: "DELETING"
   }
   */
 });

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Status — (String)

      The current status of the delete project operation.

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

Returns:

• (AWS.Request) —

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

/* This operation deletes a revision of an existing project policy from an Amazon Rekognition Custom Labels project. */

 var params = {
  PolicyName: "testPolicy1", 
  PolicyRevisionId: "3b274c25e9203a56a99e00e3ff205fbc", 
  ProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/1656557123456"
 };
 rekognition.deleteProjectPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

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

Parameters:

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

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

  • PolicyName — (String)

    The name of the policy that you want to delete.

  • PolicyRevisionId — (String)

    The ID of the project policy revision that you want to delete.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

/* Deletes a version of an Amazon Rekognition Custom Labels model. */

 var params = {
  ProjectVersionArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958"
 };
 rekognition.deleteProjectVersion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Status: "DELETING"
   }
   */
 });

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Status — (String)

      The status of the deletion operation.

      Possible values include:
      • "TRAINING_IN_PROGRESS"
      • "TRAINING_COMPLETED"
      • "TRAINING_FAILED"
      • "STARTING"
      • "RUNNING"
      • "FAILED"
      • "STOPPING"
      • "STOPPED"
      • "DELETING"
      • "COPYING_IN_PROGRESS"
      • "COPYING_COMPLETED"
      • "COPYING_FAILED"
      • "DEPRECATED"
      • "EXPIRED"

Returns:

• (AWS.Request) —

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

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.

/* Deletes the specified UserID within the collection. */

 var params = {
  ClientRequestToken: "550e8400-e29b-41d4-a716-446655440001", 
  CollectionId: "MyCollection", 
  UserId: "DemoUser"
 };
 rekognition.deleteUser(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  CollectionId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE'
};
rekognition.deleteUser(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 from which the UserID needs to be deleted.

  • UserId — (String)

    ID for the UserID to be deleted.

  • ClientRequestToken — (String)

    Idempotent token used to identify the request to DeleteUser. If you use the same token with multiple DeleteUser requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

    If a token is not provided, the SDK will use a version 4 UUID.

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.

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.

    • UserCount — (Integer)

      The number of UserIDs assigned to the specified colleciton.

Returns:

• (AWS.Request) —

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

/* Describes an Amazon Rekognition Custom Labels dataset. */

 var params = {
  DatasetArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1690476084535"
 };
 rekognition.describeDataset(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DatasetDescription: {
     CreationTimestamp: <Date Representation>, 
     DatasetStats: {
      ErrorEntries: 0, 
      LabeledEntries: 15, 
      TotalEntries: 15, 
      TotalLabels: 9
     }, 
     LastUpdatedTimestamp: <Date Representation>, 
     Status: "UPDATE_FAILED", 
     StatusMessage: "The manifest file contains images from multiple S3 buckets.", 
     StatusMessageCode: "CLIENT_ERROR"
    }
   }
   */
 });

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • DatasetDescription — (map)

      The description for the dataset.

      • CreationTimestamp — (Date)

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

      • LastUpdatedTimestamp — (Date)

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

      • Status — (String)

        The status of the dataset.

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

        The status message for the dataset.

      • StatusMessageCode — (String)

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

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

        The status message code for the dataset.

        • LabeledEntries — (Integer)

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

        • TotalEntries — (Integer)

          The total number of images in the dataset.

        • TotalLabels — (Integer)

          The total number of labels declared in the dataset.

        • ErrorEntries — (Integer)

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

Returns:

• (AWS.Request) —

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

/* Describes an Amazon Rekognition Custom Labels projects. */

 var params = {
  ProjectNames: [
     "my-project"
  ]
 };
 rekognition.describeProjects(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ProjectDescriptions: [
       {
      CreationTimestamp: <Date Representation>, 
      Datasets: [
         {
        CreationTimestamp: <Date Representation>, 
        DatasetArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/test/1655158654491", 
        DatasetType: "TEST", 
        Status: "CREATE_COMPLETE", 
        StatusMessage: "The dataset was successfully created from the manifest file.", 
        StatusMessageCode: "SUCCESS"
       }, 
         {
        CreationTimestamp: <Date Representation>, 
        DatasetArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1655158669954", 
        DatasetType: "TRAIN", 
        Status: "CREATE_COMPLETE", 
        StatusMessage: "The dataset was successfully created from the manifest file.", 
        StatusMessageCode: "SUCCESS"
       }
      ], 
      ProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1655158560634", 
      Status: "CREATED"
     }
    ]
   }
   */
 });

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

Parameters:

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

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

  • MaxResults — (Integer)

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

  • ProjectNames — (Array<String>)

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

  • Features — (Array<String>)

    Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProjectDescriptions — (Array<map>)

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

      • ProjectArn — (String)

        The Amazon Resource Name (ARN) of the project.

      • CreationTimestamp — (Date)

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

      • Status — (String)

        The current status of the project.

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

        Information about the training and test datasets in the project.

        • CreationTimestamp — (Date)

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

        • DatasetType — (String)

          The type of the dataset.

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

          The Amazon Resource Name (ARN) for the dataset.

        • Status — (String)

          The status for the dataset.

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

          The status message for the dataset.

        • StatusMessageCode — (String)

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

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

        Specifies the project that is being customized.

        Possible values include:
        • "CONTENT_MODERATION"
        • "CUSTOM_LABELS"
      • AutoUpdate — (String)

        Indicates whether automatic retraining will be attempted for the versions of the project. Applies only to adapters.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

/* Describes a version of an Amazon Rekognition Custom Labels model. */

 var params = {
  ProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815", 
  VersionNames: [
     "1"
  ]
 };
 rekognition.describeProjectVersions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NextToken: "", 
    ProjectVersionDescriptions: [
       {
      BillableTrainingTimeInSeconds: 1899, 
      CreationTimestamp: <Date Representation>, 
      EvaluationResult: {
       F1Score: 1, 
       Summary: {
        S3Object: {
         Bucket: "custom-labels-console-us-east-1-111111111", 
         Name: "my-model-output/EvaluationResultSummary-my-project-1.json"
        }
       }
      }, 
      ManifestSummary: {
       S3Object: {
        Bucket: "custom-labels-console-us-east-1-111111111", 
        Name: "my-model-output/ManifestSummary-my-project-1.json"
       }
      }, 
      OutputConfig: {
       S3Bucket: "custom-labels-console-us-east-1-111111111", 
       S3KeyPrefix: "my-model-output"
      }, 
      ProjectVersionArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958", 
      Status: "TRAINING_COMPLETED", 
      StatusMessage: "The model is ready to run.", 
      TestingDataResult: {
       Input: {
        AutoCreate: false
       }, 
       Output: {
        Assets: [
           {
          GroundTruthManifest: {
           S3Object: {
            Bucket: "custom-labels-console-us-east-1-111111111", 
            Name: "my-model-output/TestingGroundTruth-my-project-1.json"
           }
          }
         }
        ], 
        AutoCreate: false
       }, 
       Validation: {
        Assets: [
           {
          GroundTruthManifest: {
           S3Object: {
            Bucket: "custom-labels-console-us-east-1-111111111", 
            Name: "my-model-output/TestingManifestWithValidation-my-project-1.json"
           }
          }
         }
        ]
       }
      }, 
      TrainingDataResult: {
       Input: {
       }, 
       Output: {
        Assets: [
           {
          GroundTruthManifest: {
           S3Object: {
            Bucket: "custom-labels-console-us-east-1-111111111", 
            Name: "my-model-output/TrainingGroundTruth-my-project-1.json"
           }
          }
         }
        ]
       }, 
       Validation: {
        Assets: [
           {
          GroundTruthManifest: {
           S3Object: {
            Bucket: "custom-labels-console-us-east-1-111111111", 
            Name: "my-model-output/TrainingManifestWithValidation-my-project-1.json"
           }
          }
         }
        ]
       }
      }, 
      TrainingEndTimestamp: <Date Representation>
     }
    ]
   }
   */
 });

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

Parameters:

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

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

  • VersionNames — (Array<String>)

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

  • NextToken — (String)

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

  • MaxResults — (Integer)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProjectVersionDescriptions — (Array<map>)

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

      • ProjectVersionArn — (String)

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

      • CreationTimestamp — (Date)

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

      • MinInferenceUnits — (Integer)

        The minimum number of inference units used by the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion.

      • Status — (String)

        The current status of the model version.

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

        A descriptive message for an error or warning that occurred.

      • BillableTrainingTimeInSeconds — (Integer)

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

      • TrainingEndTimestamp — (Date)

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

      • OutputConfig — (map)

        The location where training results are saved.

        • S3Bucket — (String)

          The S3 bucket where training output is placed.

        • S3KeyPrefix — (String)

          The prefix applied to the training output files.

      • TrainingDataResult — (map)

        Contains information about the training results.

        • Input — (map)

          The training data that you supplied.

          • Assets — (Array<map>)

            A manifest file that contains references to the training images and ground-truth annotations.

            • GroundTruthManifest — (map)

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

              • S3Object — (map)

                Provides the S3 bucket name and object name.

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

                For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

                • Bucket — (String)

                  Name of the S3 bucket.

                • Name — (String)

                  S3 object key name.

                • Version — (String)

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

        • Output — (map)

          Reference to images (assets) that were actually used during training with trained model predictions.

          • Assets — (Array<map>)

            A manifest file that contains references to the training images and ground-truth annotations.

            • GroundTruthManifest — (map)

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

              • S3Object — (map)

                Provides the S3 bucket name and object name.

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

                For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

                • Bucket — (String)

                  Name of the S3 bucket.

                • Name — (String)

                  S3 object key name.

                • Version — (String)

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

        • Validation — (map)

          A manifest that you supplied for training, with validation results for each line.

          • Assets — (Array<map>)

            The assets that comprise the validation data.

            • GroundTruthManifest — (map)

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

              • S3Object — (map)

                Provides the S3 bucket name and object name.

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

                For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

                • Bucket — (String)

                  Name of the S3 bucket.

                • Name — (String)

                  S3 object key name.

                • Version — (String)

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

      • TestingDataResult — (map)

        Contains information about the testing results.

        • Input — (map)

          The testing dataset that was supplied for training.

          • Assets — (Array<map>)

            The assets used for testing.

            • GroundTruthManifest — (map)

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

              • S3Object — (map)

                Provides the S3 bucket name and object name.

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

                For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

                • Bucket — (String)

                  Name of the S3 bucket.

                • Name — (String)

                  S3 object key name.

                • Version — (String)

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

          • AutoCreate — (Boolean)

            If specified, Rekognition splits training dataset to create a test dataset for the training job.

        • Output — (map)

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

          • Assets — (Array<map>)

            The assets used for testing.

            • GroundTruthManifest — (map)

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

              • S3Object — (map)

                Provides the S3 bucket name and object name.

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

                For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

                • Bucket — (String)

                  Name of the S3 bucket.

                • Name — (String)

                  S3 object key name.

                • Version — (String)

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

          • AutoCreate — (Boolean)

            If specified, Rekognition splits training dataset to create a test dataset for the training job.

        • Validation — (map)

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

          • Assets — (Array<map>)

            The assets that comprise the validation data.

            • GroundTruthManifest — (map)

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

              • S3Object — (map)

                Provides the S3 bucket name and object name.

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

                For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

                • Bucket — (String)

                  Name of the S3 bucket.

                • Name — (String)

                  S3 object key name.

                • Version — (String)

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

      • EvaluationResult — (map)

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

        • F1Score — (Float)

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

        • Summary — (map)

          The S3 bucket that contains the training summary.

          • S3Object — (map)

            Provides the S3 bucket name and object name.

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

            For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

            • Bucket — (String)

              Name of the S3 bucket.

            • Name — (String)

              S3 object key name.

            • Version — (String)

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

      • ManifestSummary — (map)

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

        • S3Object — (map)

          Provides the S3 bucket name and object name.

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

          For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

          • Bucket — (String)

            Name of the S3 bucket.

          • Name — (String)

            S3 object key name.

          • Version — (String)

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

      • KmsKeyId — (String)

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

      • MaxInferenceUnits — (Integer)

        The maximum number of inference units Amazon Rekognition uses to auto-scale the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion.

      • SourceProjectVersionArn — (String)

        If the model version was copied from a different project, SourceProjectVersionArn contains the ARN of the source model version.

      • VersionDescription — (String)

        A user-provided description of the project version.

      • Feature — (String)

        The feature that was customized.

        Possible values include:
        • "CONTENT_MODERATION"
        • "CUSTOM_LABELS"
      • BaseModelVersion — (String)

        The base detection model version used to create the project version.

      • FeatureConfig — (map)

        Feature specific configuration that was applied during training.

        • ContentModeration — (map)

          Configuration options for Custom Moderation training.

          • ConfidenceThreshold — (Float)

            The confidence level you plan to use to identify if unsafe content is present during inference.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• projectVersionTrainingCompleted

• projectVersionRunning

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

      • S3Destination — (map)

        The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.

        • Bucket — (String)

          The name of the Amazon S3 bucket you want to associate with the streaming video project. You must be the owner of the Amazon S3 bucket.

        • KeyPrefix — (String)

          The prefix value of the location within the bucket that you want the information to be published to. For more information, see Using prefixes.

    • RoleArn — (String)

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

    • Settings — (map)

      Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

      • FaceSearch — (map)

        Face search settings to use on a streaming video.

        • CollectionId — (String)

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

        • FaceMatchThreshold — (Float)

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

      • ConnectedHome — (map)

        Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for CreateStreamProcessor. Including this setting in the CreateStreamProcessor request enables you to use the stream processor for label detection. You can then select what you want the stream processor to detect, such as people or pets. When the stream processor has started, one notification is sent for each object class specified. For example, if packages and pets are selected, one SNS notification is published the first time a package is detected and one SNS notification is published the first time a pet is detected, as well as an end-of-session summary.

        • Labels — required — (Array<String>)

          Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".

        • MinConfidence — (Float)

          The minimum confidence required to label an object in the video.

    • NotificationChannel — (map)

      The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.

      Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications, one for a person at second 2 and one for a pet at second 4.

      Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.

      • SNSTopicArn — required — (String)

        The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification Service topic to which Amazon Rekognition posts the completion status.

    • KmsKeyId — (String)

      The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors.

    • RegionsOfInterest — (Array<map>)

      Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.

      • BoundingBox — (map)

        The box representing a region of interest on screen.

        • Width — (Float)

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

        • Height — (Float)

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

        • Left — (Float)

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

        • Top — (Float)

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

      • Polygon — (Array<map>)

        Specifies a shape made up of up to 10 Point objects to define a region of interest.

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

    • DataSharingPreference — (map)

      Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.

      • OptIn — required — (Boolean)

        If this option is set to true, you choose to share data with Rekognition to improve model performance.

Returns:

• (AWS.Request) —

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

/* Detects custom labels in an image with an Amazon Rekognition Custom Labels model */

 var params = {
  Image: {
   S3Object: {
    Bucket: "custom-labels-console-us-east-1-1111111111", 
    Name: "assets/flowers_1_test_dataset/camellia4.jpg"
   }
  }, 
  MaxResults: 100, 
  MinConfidence: 50, 
  ProjectVersionArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/my-project.2023-07-31T11.49.37/1690829378219"
 };
 rekognition.detectCustomLabels(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CustomLabels: [
       {
      Confidence: 67.56399536132812, 
      Name: "with_leaves"
     }, 
       {
      Confidence: 50.65699768066406, 
      Name: "without_leaves"
     }
    ]
   }
   */
 });

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

Parameters:

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

    The ARN of the model version that you want to use. Only models associated with Custom Labels projects accepted by the operation. If a provided ARN refers to a model version associated with a project for a different feature type, then an InvalidParameterException is returned.

  • Image — (map)

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

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

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

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

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

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

    For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

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

      Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to DetectCustomLabels is 4MB.

    • S3Object — (map)

      Identifies an S3 object as the image source.

      • Bucket — (String)

        Name of the S3 bucket.

      • Name — (String)

        S3 object key name.

      • Version — (String)

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

  • MaxResults — (Integer)

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

  • MinConfidence — (Float)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • CustomLabels — (Array<map>)

      An array of custom labels detected in the input image.

      • Name — (String)

        The name of the custom label.

      • Confidence — (Float)

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

      • Geometry — (map)

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

        • BoundingBox — (map)

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

          • Width — (Float)

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

          • Height — (Float)

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

          • Left — (Float)

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

          • Top — (Float)

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

        • Polygon — (Array<map>)

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

          • X — (Float)

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

          • Y — (Float)

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

Returns:

• (AWS.Request) —

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

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

var params = {
  Image: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  Attributes: [
    DEFAULT | ALL | AGE_RANGE | BEARD | EMOTIONS | EYE_DIRECTION | EYEGLASSES | EYES_OPEN | GENDER | MOUTH_OPEN | MUSTACHE | FACE_OCCLUDED | SMILE | SUNGLASSES,
    /* 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. Note that the maximum image size you can pass to DetectCustomLabels is 4MB.

    • 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. A DEFAULT subset of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or just ["FACE_OCCLUDED"]. You can request for all facial attributes by using ["ALL"]. Requesting more attributes may increase response time.

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

    Note that while the FaceOccluded and EyeDirection attributes are supported when using DetectFaces, they aren't supported when analyzing videos with StartFaceDetection and GetFaceDetection.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • FaceDetails — (Array<map>)

      Details of each face found in the image.

      • BoundingBox — (map)

        Bounding box of the face. Default attribute.

        • Width — (Float)

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

        • Height — (Float)

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

        • Left — (Float)

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

        • Top — (Float)

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

      • AgeRange — (map)

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

        • Low — (Integer)

          The lowest estimated age.

        • High — (Integer)

          The highest estimated age.

      • Smile — (map)

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

        • Value — (Boolean)

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

        • Confidence — (Float)

          Level of confidence in the determination.

      • Eyeglasses — (map)

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

        • Value — (Boolean)

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

        • Confidence — (Float)

          Level of confidence in the determination.

      • Sunglasses — (map)

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

        • Value — (Boolean)

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

        • Confidence — (Float)

          Level of confidence in the determination.

      • Gender — (map)

        The predicted gender of a detected face.

        • Value — (String)

          The predicted gender of the face.

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

          Level of confidence in the prediction.

      • Beard — (map)

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

        • Value — (Boolean)

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

        • Confidence — (Float)

          Level of confidence in the determination.

      • Mustache — (map)

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

        • Value — (Boolean)

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

        • Confidence — (Float)

          Level of confidence in the determination.

      • EyesOpen — (map)

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

        • Value — (Boolean)

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

        • Confidence — (Float)

          Level of confidence in the determination.

      • MouthOpen — (map)

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

        • Value — (Boolean)

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

        • Confidence — (Float)

          Level of confidence in the determination.

      • Emotions — (Array<map>)

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

        • Type — (String)

          Type of emotion detected.

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

          Level of confidence in the determination.

      • Landmarks — (Array<map>)

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

        • Type — (String)

          Type of landmark.

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

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

        • Y — (Float)

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

      • Pose — (map)

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

        • Roll — (Float)

          Value representing the face rotation on the roll axis.

        • Yaw — (Float)

          Value representing the face rotation on the yaw axis.

        • Pitch — (Float)

          Value representing the face rotation on the pitch axis.

      • Quality — (map)

        Identifies image brightness and sharpness. Default attribute.

        • Brightness — (Float)

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

        • Sharpness — (Float)

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

      • Confidence — (Float)

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

      • FaceOccluded — (map)

        FaceOccluded should return "true" with a high confidence score if a detected face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other objects. FaceOccluded should return "false" with a high confidence score if common occurrences that do not impact face verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair, and others.

        • Value — (Boolean)

          True if a detected face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other objects. False if common occurrences that do not impact face verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair, and others.

        • Confidence — (Float)

          The confidence that the service has detected the presence of a face occlusion.

      • EyeDirection — (map)

        Indicates the direction the eyes are gazing in, as defined by pitch and yaw.

        • Yaw — (Float)

          Value representing eye direction on the yaw axis.

        • Pitch — (Float)

          Value representing eye direction on the pitch axis.

        • Confidence — (Float)

          The confidence that the service has in its predicted eye direction.

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

/* 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"
     }
    ]
   }
   */
 });

var params = {
  Image: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  Features: [
    GENERAL_LABELS | IMAGE_PROPERTIES,
    /* more items */
  ],
  MaxLabels: 'NUMBER_VALUE',
  MinConfidence: 'NUMBER_VALUE',
  Settings: {
    GeneralLabels: {
      LabelCategoryExclusionFilters: [
        'STRING_VALUE',
        /* more items */
      ],
      LabelCategoryInclusionFilters: [
        'STRING_VALUE',
        /* more items */
      ],
      LabelExclusionFilters: [
        'STRING_VALUE',
        /* more items */
      ],
      LabelInclusionFilters: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    ImageProperties: {
      MaxDominantColors: '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. Note that the maximum image size you can pass to DetectCustomLabels is 4MB.

    • 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. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input parameter.

  • 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. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input parameter.

  • Features — (Array<String>)

    A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality. If no option is specified GENERAL_LABELS is used by default.

  • Settings — (map)

    A list of the filters to be applied to returned detected labels and image properties. Specified filters can be inclusive, exclusive, or a combination of both. Filters can be used for individual labels or label categories. The exact label names or label categories must be supplied. For a full list of labels and label categories, see Detecting labels.

    • GeneralLabels — (map)

      Contains the specified filters for GENERAL_LABELS.

      • LabelInclusionFilters — (Array<String>)

        The labels that should be included in the return from DetectLabels.

      • LabelExclusionFilters — (Array<String>)

        The labels that should be excluded from the return from DetectLabels.

      • LabelCategoryInclusionFilters — (Array<String>)

        The label categories that should be included in the return from DetectLabels.

      • LabelCategoryExclusionFilters — (Array<String>)

        The label categories that should be excluded from the return from DetectLabels.

    • ImageProperties — (map)

      Contains the chosen number of maximum dominant colors in an image.

      • MaxDominantColors — (Integer)

        The maximum number of dominant colors to return when detecting labels in an image. The default value is 10.

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.

        • DominantColors — (Array<map>)

          The dominant colors found in an individual instance of a label.

          • Red — (Integer)

            The Red RGB value for a dominant color.

          • Blue — (Integer)

            The Blue RGB value for a dominant color.

          • Green — (Integer)

            The Green RGB value for a dominant color.

          • HexCode — (String)

            The Hex code equivalent of the RGB values for a dominant color.

          • CSSColor — (String)

            The CSS color name of a dominant color.

          • SimplifiedColor — (String)

            One of 12 simplified color names applied to a dominant color.

          • PixelPercent — (Float)

            The percentage of image pixels that have a given dominant color.

      • Parents — (Array<map>)

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

        • Name — (String)

          The name of the parent label.

      • Aliases — (Array<map>)

        A list of potential aliases for a given label.

        • Name — (String)

          The name of an alias for a given label.

      • Categories — (Array<map>)

        A list of the categories associated with a given label.

        • Name — (String)

          The name of a category that applies to a given 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.

    • ImageProperties — (map)

      Information about the properties of the input image, such as brightness, sharpness, contrast, and dominant colors.

      • Quality — (map)

        Information about the quality of the image foreground as defined by brightness, sharpness, and contrast. The higher the value the greater the brightness, sharpness, and contrast respectively.

        • Brightness — (Float)

          The brightness of an image provided for label detection.

        • Sharpness — (Float)

          The sharpness of an image provided for label detection.

        • Contrast — (Float)

          The contrast of an image provided for label detection.

      • DominantColors — (Array<map>)

        Information about the dominant colors found in an image, described with RGB values, CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels that have a particular color).

        • Red — (Integer)

          The Red RGB value for a dominant color.

        • Blue — (Integer)

          The Blue RGB value for a dominant color.

        • Green — (Integer)

          The Green RGB value for a dominant color.

        • HexCode — (String)

          The Hex code equivalent of the RGB values for a dominant color.

        • CSSColor — (String)

          The CSS color name of a dominant color.

        • SimplifiedColor — (String)

          One of 12 simplified color names applied to a dominant color.

        • PixelPercent — (Float)

          The percentage of image pixels that have a given dominant color.

      • Foreground — (map)

        Information about the properties of an image’s foreground, including the foreground’s quality and dominant colors, including the quality and dominant colors of the image.

        • Quality — (map)

          The quality of the image foreground as defined by brightness and sharpness.

          • Brightness — (Float)

            The brightness of an image provided for label detection.

          • Sharpness — (Float)

            The sharpness of an image provided for label detection.

          • Contrast — (Float)

            The contrast of an image provided for label detection.

        • DominantColors — (Array<map>)

          The dominant colors found in the foreground of an image, defined with RGB values, CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels that have a particular color).

          • Red — (Integer)

            The Red RGB value for a dominant color.

          • Blue — (Integer)

            The Blue RGB value for a dominant color.

          • Green — (Integer)

            The Green RGB value for a dominant color.

          • HexCode — (String)

            The Hex code equivalent of the RGB values for a dominant color.

          • CSSColor — (String)

            The CSS color name of a dominant color.

          • SimplifiedColor — (String)

            One of 12 simplified color names applied to a dominant color.

          • PixelPercent — (Float)

            The percentage of image pixels that have a given dominant color.

      • Background — (map)

        Information about the properties of an image’s background, including the background’s quality and dominant colors, including the quality and dominant colors of the image.

        • Quality — (map)

          The quality of the image background as defined by brightness and sharpness.

          • Brightness — (Float)

            The brightness of an image provided for label detection.

          • Sharpness — (Float)

            The sharpness of an image provided for label detection.

          • Contrast — (Float)

            The contrast of an image provided for label detection.

        • DominantColors — (Array<map>)

          The dominant colors found in the background of an image, defined with RGB values, CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels that have a particular color).

          • Red — (Integer)

            The Red RGB value for a dominant color.

          • Blue — (Integer)

            The Blue RGB value for a dominant color.

          • Green — (Integer)

            The Green RGB value for a dominant color.

          • HexCode — (String)

            The Hex code equivalent of the RGB values for a dominant color.

          • CSSColor — (String)

            The CSS color name of a dominant color.

          • SimplifiedColor — (String)

            One of 12 simplified color names applied to a dominant color.

          • PixelPercent — (Float)

            The percentage of image pixels that have a given dominant color.

Returns:

• (AWS.Request) —

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

var params = {
  Image: { /* required */
    Bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    S3Object: {
      Bucket: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      Version: 'STRING_VALUE'
    }
  },
  HumanLoopConfig: {
    FlowDefinitionArn: 'STRING_VALUE', /* required */
    HumanLoopName: 'STRING_VALUE', /* required */
    DataAttributes: {
      ContentClassifiers: [
        FreeOfPersonallyIdentifiableInformation | FreeOfAdultContent,
        /* more items */
      ]
    }
  },
  MinConfidence: 'NUMBER_VALUE',
  ProjectVersion: 'STRING_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. Note that the maximum image size you can pass to DetectCustomLabels is 4MB.

    • S3Object — (map)

      Identifies an S3 object as the image source.

      • Bucket — (String)

        Name of the S3 bucket.

      • Name — (String)

        S3 object key name.

      • Version — (String)

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

  • MinConfidence — (Float)

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

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

  • HumanLoopConfig — (map)

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

    • HumanLoopName — required — (String)

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

    • FlowDefinitionArn — required — (String)

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

    • DataAttributes — (map)

      Sets attributes of the input data.

      • ContentClassifiers — (Array<String>)

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

  • ProjectVersion — (String)

    Identifier for the custom adapter. Expects the ProjectVersionArn as a value. Use the CreateProject or CreateProjectVersion APIs to create a custom adapter.

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. For video operations, this includes the time, in milliseconds from the start of the video, they were detected.

      • Confidence — (Float)

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

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

      • Name — (String)

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

      • ParentName — (String)

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

      • TaxonomyLevel — (Integer)

        The level of the moderation label with regard to its taxonomy, from 1 to 3.

    • ModerationModelVersion — (String)

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

    • HumanLoopActivationOutput — (map)

      Shows the results of the human in the loop evaluation.

      • HumanLoopArn — (String)

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

      • HumanLoopActivationReasons — (Array<String>)

        Shows if and why human review was needed.

      • HumanLoopActivationConditionsEvaluationResults — (String)

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

    • ProjectVersion — (String)

      Identifier of the custom adapter that was used during inference. If during inference the adapter was EXPIRED, then the parameter will not be returned, indicating that a base moderation detection project version was used.

    • ContentTypes — (Array<map>)

      A list of predicted results for the type of content an image contains. For example, the image content might be from animation, sports, or a video game.

      • Confidence — (Float)

        The confidence level of the label given

      • Name — (String)

        The name of the label

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

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

      Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to DetectCustomLabels is 4MB.

    • S3Object — (map)

      Identifies an S3 object as the image source.

      • Bucket — (String)

        Name of the S3 bucket.

      • Name — (String)

        S3 object key name.

      • Version — (String)

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

  • SummarizationAttributes — (map)

    An array of PPE types that you want to summarize.

    • MinConfidence — required — (Float)

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

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

    • RequiredEquipmentTypes — required — (Array<String>)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProtectiveEquipmentModelVersion — (String)

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

    • Persons — (Array<map>)

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

      • BodyParts — (Array<map>)

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

        • Name — (String)

          The detected body part.

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

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

        • EquipmentDetections — (Array<map>)

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

          • BoundingBox — (map)

            A bounding box surrounding the item of detected PPE.

            • Width — (Float)

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

            • Height — (Float)

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

            • Left — (Float)

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

            • Top — (Float)

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

          • Confidence — (Float)

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

          • Type — (String)

            The type of detected PPE.

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

            Information about the body part covered by the detected PPE.

            • Confidence — (Float)

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

            • Value — (Boolean)

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

      • BoundingBox — (map)

        A bounding box around the detected person.

        • Width — (Float)

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

        • Height — (Float)

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

        • Left — (Float)

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

        • Top — (Float)

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

      • Confidence — (Float)

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

      • Id — (Integer)

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

    • Summary — (map)

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

      • PersonsWithRequiredEquipment — (Array<Integer>)

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

      • PersonsWithoutRequiredEquipment — (Array<Integer>)

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

      • PersonsIndeterminate — (Array<Integer>)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

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

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

      Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to DetectCustomLabels is 4MB.

    • S3Object — (map)

      Identifies an S3 object as the image source.

      • Bucket — (String)

        Name of the S3 bucket.

      • Name — (String)

        S3 object key name.

      • Version — (String)

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

  • Filters — (map)

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

    • WordFilter — (map)

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

      • MinConfidence — (Float)

        Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 0 and 100. The default MinConfidence is 80.

      • MinBoundingBoxHeight — (Float)

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

      • MinBoundingBoxWidth — (Float)

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

    • RegionsOfInterest — (Array<map>)

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

      • BoundingBox — (map)

        The box representing a region of interest on screen.

        • Width — (Float)

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

        • Height — (Float)

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

        • Left — (Float)

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

        • Top — (Float)

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

      • Polygon — (Array<map>)

        Specifies a shape made up of up to 10 Point objects to define a region of interest.

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • TextDetections — (Array<map>)

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

      • DetectedText — (String)

        The word or line of text recognized by Amazon Rekognition.

      • Type — (String)

        The type of text that was detected.

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

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

      • ParentId — (Integer)

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

      • Confidence — (Float)

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

      • Geometry — (map)

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

        • BoundingBox — (map)

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

          • Width — (Float)

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

          • Height — (Float)

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

          • Left — (Float)

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

          • Top — (Float)

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

        • Polygon — (Array<map>)

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

          • X — (Float)

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

          • Y — (Float)

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

    • TextModelVersion — (String)

      The model version used to detect text.

Returns:

• (AWS.Request) —

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

/* Removes the association between a Face supplied in an array of FaceIds and the User. */

 var params = {
  ClientRequestToken: "550e8400-e29b-41d4-a716-446655440003", 
  CollectionId: "MyCollection", 
  FaceIds: [
     "f5817d37-94f6-4335-bfee-6cf79a3d806e", 
     "c92265d4-5f9c-43af-a58e-12be0ce02bc3"
  ], 
  UserId: "DemoUser"
 };
 rekognition.disassociateFaces(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DisassociatedFaces: [
       {
      FaceId: "c92265d4-5f9c-43af-a58e-12be0ce02bc3"
     }
    ], 
    UnsuccessfulFaceDisassociations: [
       {
      FaceId: "f5817d37-94f6-4335-bfee-6cf79a3d806e", 
      Reasons: [
         "ASSOCIATED_TO_A_DIFFERENT_USER"
      ], 
      UserId: "demoUser1"
     }
    ], 
    UserStatus: "UPDATING"
   }
   */
 });

var params = {
  CollectionId: 'STRING_VALUE', /* required */
  FaceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  UserId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE'
};
rekognition.disassociateFaces(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 containing the UserID.

  • UserId — (String)

    ID for the existing UserID.

  • ClientRequestToken — (String)

    Idempotent token used to identify the request to DisassociateFaces. If you use the same token with multiple DisassociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

    If a token is not provided, the SDK will use a version 4 UUID.
  • FaceIds — (Array<String>)

    An array of face IDs to disassociate from the UserID.

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:

    • DisassociatedFaces — (Array<map>)

      An array of DissociatedFace objects containing FaceIds that are successfully disassociated with the UserID is returned. Returned if the DisassociatedFaces action is successful.

      • FaceId — (String)

        Unique identifier assigned to the face.

    • UnsuccessfulFaceDisassociations — (Array<map>)

      An array of UnsuccessfulDisassociation objects containing FaceIds that are not successfully associated, along with the reasons for the failure to associate. Returned if the DisassociateFaces action is successful.

      • FaceId — (String)

        A unique identifier assigned to the face.

      • UserId — (String)

        A provided ID for the UserID. Unique within the collection.

      • Reasons — (Array<String>)

        The reason why the deletion was unsuccessful.

    • UserStatus — (String)

      The status of an update made to a User. Reflects if the User has been updated for every requested change.

      Possible values include:
      • "ACTIVE"
      • "UPDATING"
      • "CREATING"
      • "CREATED"