Amazon Rekognition

App · 20 actions

Find objects, text, faces, celebrities, unsafe content and protective equipment in images stored in Amazon S3, and keep face collections for matching people across photos.

Actions

ActionWhat it does
Compare facesCompare the largest face in one image with the faces in another and say how similar each is.
Create collectionCreate a collection to store faces in, so they can be searched later.
Create userCreate a user in a collection, to group several faces of the same person.
Delete collectionDelete a face collection and every face stored in it.
Delete facesDelete faces from a collection by their face IDs.
Delete userDelete a user from a collection.
Describe collectionGet a face collection's details, such as how many faces and users it holds.
Detect facesFind the faces in an image stored in S3, with each face's position and, if asked, attributes such as age range and emotions.
Detect labelsFind the objects, scenes and concepts in an image stored in S3, each with a confidence score.
Detect moderation labelsCheck an image stored in S3 for unsafe or inappropriate content, such as nudity or violence.
Detect protective equipmentFind people in an image stored in S3 and whether they wear face covers, hand covers or head covers.
Detect textRead the words and lines of text in an image stored in S3.
Get celebrity infoGet a celebrity's name and links to more about them, by the ID Recognize celebrities returned.
Index facesAdd the faces found in an image stored in S3 to a collection, so they can be searched later.
List collectionsList the face collections in your account.
List facesList the faces stored in a collection.
List usersList the users in a collection.
Recognize celebritiesName the celebrities whose faces appear in an image stored in S3.
Search facesFind the faces in a collection that match a face already stored in it.
Search faces by imageFind the faces in a collection that match the largest face in an image stored in S3.

Compare faces

Compare the largest face in one image with the faces in another and say how similar each is.

Inputs

Source image bucketsource_image_buckettextRequired
S3 bucket containing the image, in the selected AWS region.
Source image keysource_image_keytextRequired
Object key of the image in that S3 bucket.
Target image buckettarget_image_buckettextRequired
S3 bucket containing the image, in the selected AWS region.
Target image keytarget_image_keytextRequired
Object key of the image in that S3 bucket.
Similarity thresholdsimilarity_thresholdnumber
Similarity threshold.From 0 to 100.
Quality filterquality_filtertext
Quality filter.One of: NONE, AUTO, LOW, MEDIUM, HIGH.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "FaceMatches": [],
    "SourceImageFace": {
      "BoundingBox": {
        "Height": 1.0,
        "Left": 1.0,
        "Top": 1.0,
        "Width": 1.0
      },
      "Confidence": 1.0
    },
    "SourceImageOrientationCorrection": "ROTATE_0",
    "TargetImageOrientationCorrection": "ROTATE_0",
    "UnmatchedFaces": []
  },
  "next_cursor": ""
}

Create collection

Create a collection to store faces in, so they can be searched later.

Inputs

Collectioncollection_idtextRequired
Collection id.
Tagstagsobject
Tags.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "CollectionArn": "example",
    "FaceModelVersion": "example",
    "StatusCode": 1
  },
  "next_cursor": ""
}

Create user

Create a user in a collection, to group several faces of the same person.

Inputs

Collectioncollection_idtextRequired
Collection id.
User idrekognition_user_idtextRequired
User id.
Client request tokenclient_request_tokentext
Client request token.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {},
  "next_cursor": ""
}

Delete collection

Delete a face collection and every face stored in it.

Inputs

Collectioncollection_idtextRequired
Collection id.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "StatusCode": 1
  },
  "next_cursor": ""
}

Delete faces

Delete faces from a collection by their face IDs.

Inputs

Collectioncollection_idtextRequired
Collection id.
Face idsface_idslistRequired
Face ids.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "DeletedFaces": [],
    "UnsuccessfulFaceDeletions": []
  },
  "next_cursor": ""
}

Delete user

Delete a user from a collection.

Inputs

Collectioncollection_idtextRequired
Collection id.
Userrekognition_user_idtextRequired
User id.
Client request tokenclient_request_tokentext
Client request token.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {},
  "next_cursor": ""
}

Describe collection

Get a face collection's details, such as how many faces and users it holds.

Inputs

Collectioncollection_idtextRequired
Collection id.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "CollectionARN": "example",
    "CreationTimestamp": "example",
    "FaceCount": 1,
    "FaceModelVersion": "example",
    "UserCount": 1
  },
  "next_cursor": ""
}

Detect faces

Find the faces in an image stored in S3, with each face's position and, if asked, attributes such as age range and emotions.

Inputs

Image bucketimage_buckettextRequired
S3 bucket containing the image, in the selected AWS region.
Image keyimage_keytextRequired
Object key of the image in that S3 bucket.
Attributesattributeslist
Attributes.One or more of: DEFAULT, ALL, AGE_RANGE (Age range), BEARD, EMOTIONS, EYE_DIRECTION (Eye direction), EYEGLASSES, EYES_OPEN (Eyes open), GENDER, MOUTH_OPEN (Mouth open), and 4 more.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "FaceDetails": [],
    "OrientationCorrection": "ROTATE_0"
  },
  "next_cursor": ""
}

Detect labels

Find the objects, scenes and concepts in an image stored in S3, each with a confidence score.

Inputs

Image bucketimage_buckettextRequired
S3 bucket containing the image, in the selected AWS region.
Image keyimage_keytextRequired
Object key of the image in that S3 bucket.
Max labelsmax_labelsnumber
Max labels.At least 0.
Min confidencemin_confidencenumber
Min confidence.From 0 to 100.
Featuresfeatureslist
Features.One or more of: GENERAL_LABELS (General labels), IMAGE_PROPERTIES (Image properties).
Settingssettingsobject
Settings.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "ImageProperties": {
      "Background": {
        "DominantColors": [],
        "Quality": {}
      },
      "DominantColors": [],
      "Foreground": {
        "DominantColors": [],
        "Quality": {}
      },
      "Quality": {
        "Brightness": 1.0,
        "Contrast": 1.0,
        "Sharpness": 1.0
      }
    },
    "LabelModelVersion": "example",
    "Labels": [],
    "OrientationCorrection": "ROTATE_0"
  },
  "next_cursor": ""
}

Detect moderation labels

Check an image stored in S3 for unsafe or inappropriate content, such as nudity or violence.

Inputs

Image bucketimage_buckettextRequired
S3 bucket containing the image, in the selected AWS region.
Image keyimage_keytextRequired
Object key of the image in that S3 bucket.
Min confidencemin_confidencenumber
Min confidence.From 0 to 100.
Human loop confighuman_loop_configobject
Human loop config.
Project versionproject_versiontext
Project version.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "ContentTypes": [],
    "HumanLoopActivationOutput": {
      "HumanLoopActivationConditionsEvaluationResults": "example",
      "HumanLoopActivationReasons": [],
      "HumanLoopArn": "example"
    },
    "ModerationLabels": [],
    "ModerationModelVersion": "example",
    "ProjectVersion": "example"
  },
  "next_cursor": ""
}

Detect protective equipment

Find people in an image stored in S3 and whether they wear face covers, hand covers or head covers.

Inputs

Image bucketimage_buckettextRequired
S3 bucket containing the image, in the selected AWS region.
Image keyimage_keytextRequired
Object key of the image in that S3 bucket.
Summarization attributessummarization_attributesobject
Summarization attributes.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "Persons": [],
    "ProtectiveEquipmentModelVersion": "example",
    "Summary": {
      "PersonsIndeterminate": [],
      "PersonsWithRequiredEquipment": [],
      "PersonsWithoutRequiredEquipment": []
    }
  },
  "next_cursor": ""
}

Detect text

Read the words and lines of text in an image stored in S3.

Inputs

Image bucketimage_buckettextRequired
S3 bucket containing the image, in the selected AWS region.
Image keyimage_keytextRequired
Object key of the image in that S3 bucket.
Filtersfiltersobject
Filters.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "TextDetections": [],
    "TextModelVersion": "example"
  },
  "next_cursor": ""
}

Get celebrity info

Get a celebrity's name and links to more about them, by the ID Recognize celebrities returned.

Inputs

IdidtextRequired
Id.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "KnownGender": {
      "Type": "Male"
    },
    "Name": "example",
    "Urls": []
  },
  "next_cursor": ""
}

Index faces

Add the faces found in an image stored in S3 to a collection, so they can be searched later.

Inputs

Collectioncollection_idtextRequired
Collection id.
Image bucketimage_buckettextRequired
S3 bucket containing the image, in the selected AWS region.
Image keyimage_keytextRequired
Object key of the image in that S3 bucket.
External image idexternal_image_idtext
External image id.
Detection attributesdetection_attributeslist
Detection attributes.One or more of: DEFAULT, ALL, AGE_RANGE (Age range), BEARD, EMOTIONS, EYE_DIRECTION (Eye direction), EYEGLASSES, EYES_OPEN (Eyes open), GENDER, MOUTH_OPEN (Mouth open), and 4 more.
Max facesmax_facesnumber
Max faces.At least 1.
Quality filterquality_filtertext
Quality filter.One of: NONE, AUTO, LOW, MEDIUM, HIGH.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "FaceModelVersion": "example",
    "FaceRecords": [],
    "OrientationCorrection": "ROTATE_0",
    "UnindexedFaces": []
  },
  "next_cursor": ""
}

List collections

List the face collections in your account.

Inputs

Next tokennext_tokentext
Next token.
Max resultsmax_resultsnumber
Max results.From 0 to 4096.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "CollectionIds": [],
    "FaceModelVersions": [],
    "NextToken": "example"
  },
  "next_cursor": ""
}

List faces

List the faces stored in a collection.

Inputs

Collectioncollection_idtextRequired
Collection id.
Next tokennext_tokentext
Next token.
Max resultsmax_resultsnumber
Max results.From 0 to 4096.
Userrekognition_user_idtext
User id.
Face idsface_idslist
Face ids.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "FaceModelVersion": "example",
    "Faces": [],
    "NextToken": "example"
  },
  "next_cursor": ""
}

List users

List the users in a collection.

Inputs

Collectioncollection_idtextRequired
Collection id.
Max resultsmax_resultsnumber
Max results.From 1 to 500.
Next tokennext_tokentext
Next token.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "NextToken": "example",
    "Users": []
  },
  "next_cursor": ""
}

Recognize celebrities

Name the celebrities whose faces appear in an image stored in S3.

Inputs

Image bucketimage_buckettextRequired
S3 bucket containing the image, in the selected AWS region.
Image keyimage_keytextRequired
Object key of the image in that S3 bucket.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "CelebrityFaces": [],
    "OrientationCorrection": "ROTATE_0",
    "UnrecognizedFaces": []
  },
  "next_cursor": ""
}

Search faces

Find the faces in a collection that match a face already stored in it.

Inputs

Collectioncollection_idtextRequired
Collection id.
Faceface_idtextRequired
Face id.
Max facesmax_facesnumber
Max faces.From 1 to 4096.
Face match thresholdface_match_thresholdnumber
Face match threshold.From 0 to 100.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "FaceMatches": [],
    "FaceModelVersion": "example",
    "SearchedFaceId": "example"
  },
  "next_cursor": ""
}

Search faces by image

Find the faces in a collection that match the largest face in an image stored in S3.

Inputs

Collectioncollection_idtextRequired
Collection id.
Image bucketimage_buckettextRequired
S3 bucket containing the image, in the selected AWS region.
Image keyimage_keytextRequired
Object key of the image in that S3 bucket.
Max facesmax_facesnumber
Max faces.From 1 to 4096.
Face match thresholdface_match_thresholdnumber
Face match threshold.From 0 to 100.
Quality filterquality_filtertext
Quality filter.One of: NONE, AUTO, LOW, MEDIUM, HIGH.

Outputs

dataobject
Response.
next_cursortext
Continuation token, when returned by the service.
Example output
{
  "data": {
    "FaceMatches": [],
    "FaceModelVersion": "example",
    "SearchedFaceBoundingBox": {
      "Height": 1.0,
      "Left": 1.0,
      "Top": 1.0,
      "Width": 1.0
    },
    "SearchedFaceConfidence": 1.0
  },
  "next_cursor": ""
}

On this page