Amazon Rekognition Index Faces Request Structure

IndexFacesRequest schema from Amazon Rekognition

Type: object Properties: 6 Required: 2

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

IndexFacesRequest is a JSON Structure definition published by Amazon Rekognition, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

CollectionId Image ExternalImageId DetectionAttributes MaxFaces QualityFilter

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-rekognition/refs/heads/main/json-structure/amazon-rekognition-index-faces-request-structure.json",
  "name": "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": "int32",
      "description": "Maximum number of faces to index."
    },
    "QualityFilter": {
      "type": "string",
      "enum": [
        "NONE",
        "AUTO",
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    }
  },
  "required": [
    "CollectionId",
    "Image"
  ]
}