IndexFacesRequest

IndexFacesRequest schema from Amazon Rekognition

Celebrity RecognitionComputer VisionContent ModerationCustom LabelsDeep LearningFace LivenessFacial RecognitionImage AnalysisMachine LearningObject DetectionText DetectionVideo Analysis

Properties

Name	Type	Description
CollectionId	string
Image	object
ExternalImageId	string	ID you want to assign to all faces detected in the image.
DetectionAttributes	array
MaxFaces	integer	Maximum number of faces to index.
QualityFilter	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-rekognition/refs/heads/main/json-schema/amazon-rekognition-index-faces-request-schema.json",
  "title": "IndexFacesRequest",
  "description": "IndexFacesRequest schema from Amazon Rekognition",
  "type": "object",
  "properties": {
    "CollectionId": {
      "type": "string",
      "example": "my-face-collection"
    },
    "Image": {
      "$ref": "#/components/schemas/Image"
    },
    "ExternalImageId": {
      "type": "string",
      "description": "ID you want to assign to all faces detected in the image.",
      "example": "user-123"
    },
    "DetectionAttributes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "DEFAULT",
          "ALL"
        ]
      }
    },
    "MaxFaces": {
      "type": "integer",
      "description": "Maximum number of faces to index."
    },
    "QualityFilter": {
      "type": "string",
      "enum": [
        "NONE",
        "AUTO",
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    }
  },
  "required": [
    "CollectionId",
    "Image"
  ]
}