Amazon Web Services, Inc.

Amazon Rekognition

This is the API Reference for Amazon Rekognition Image , Amazon Rekognition Bulk Image Analysis , Amazon Rekognition Custom Labels , Amazon Rekognition Stored…

AI & machine learning#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the API Reference for
Amazon Rekognition Image ,
Amazon Rekognition Bulk Image Analysis ,
Amazon Rekognition Custom Labels ,
Amazon Rekognition Stored Video ,
Amazon Rekognition Face Liveness ,
Amazon Rekognition Streaming Video .
It provides descriptions of actions, data types, common parameters, and common errors.

Amazon Rekognition Image

AssociateFaces

CompareFaces

CreateCollection

CreateUser

DeleteCollection

DeleteFaces

DeleteUser

DescribeCollection

DetectFaces

DetectLabels

DetectModerationLabels

DetectProtectiveEquipment

DetectText

DisassociateFaces

GetCelebrityInfo

IndexFaces

ListCollections

ListFaces

ListUsers

RecognizeCelebrities

SearchFaces

SearchFacesByImage

SearchUsers

SearchUsersByImage

Amazon Rekognition Bulk Image Analysis

GetMediaAnalysisJob

ListMediaAnalysisJob

StartMediaAnalysisJob

Amazon Rekognition Custom Labels

CopyProjectVersion

CreateDataset

CreateProject

CreateProjectVersion

DeleteDataset

DeleteProject

DeleteProjectPolicy

DeleteProjectVersion

DescribeDataset

DescribeProjects

DescribeProjectVersions

DetectCustomLabels

DistributeDatasetEntries

ListDatasetEntries

ListDatasetLabels

ListProjectPolicies

PutProjectPolicy

StartProjectVersion

StopProjectVersion

UpdateDatasetEntries

Amazon Rekognition Stored Video

GetCelebrityRecognition

GetContentModeration

GetFaceDetection

GetFaceSearch

GetLabelDetection

GetPersonTracking

GetSegmentDetection

GetTextDetection

StartCelebrityRecognition

StartContentModeration

StartFaceDetection

StartFaceSearch

StartLabelDetection

StartPersonTracking

StartSegmentDetection

StartTextDetection

Amazon Rekognition Face Liveness

CreateFaceLivenessSession

GetFaceLivenessSessionResults

StartFaceLivenessSession

Amazon Rekognition Streaming Video

CreateStreamProcessor

DeleteStreamProcessor

DescribeStreamProcessor

ListStreamProcessors

StartStreamProcessor

StopStreamProcessor

UpdateStreamProcessor

Endpoints 75

  • POSTAssociate faces/#X-Amz-Target=RekognitionService.AssociateFacesAssociates one or more faces with an existing UserID. Takes an array of FaceIds . Each FaceId that are present in the FaceIds list is associated with the…
  • POSTCompare faces/#X-Amz-Target=RekognitionService.CompareFacesCompares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces,…
  • POSTCopy project version/#X-Amz-Target=RekognitionService.CopyProjectVersionThis operation applies only to Amazon Rekognition Custom Labels. Copies a version of an Amazon Rekognition Custom Labels model from a source project to a…
  • POSTCreate collection/#X-Amz-Target=RekognitionService.CreateCollectionCreates a collection in an AWS Region. You can add faces to the collection using the IndexFaces operation. For example, you might create collections, one for…
  • POSTCreate dataset/#X-Amz-Target=RekognitionService.CreateDatasetThis operation applies only to Amazon Rekognition Custom Labels. Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an…
  • POSTCreate face liveness session/#X-Amz-Target=RekognitionService.CreateFaceLivenessSessionThis API operation initiates a Face Liveness session. It returns a SessionId , which you can use to start streaming Face Liveness video and get the results…
  • POSTCreate project/#X-Amz-Target=RekognitionService.CreateProjectCreates a new Amazon Rekognition project. A project is a group of resources (datasets, model versions) that you use to create and manage a Amazon Rekognition…
  • POSTCreate project version/#X-Amz-Target=RekognitionService.CreateProjectVersionCreates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training. Models and adapters are managed as…
  • POSTCreate stream processor/#X-Amz-Target=RekognitionService.CreateStreamProcessorService availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature…
  • POSTCreate user/#X-Amz-Target=RekognitionService.CreateUserCreates a new User within a collection specified by CollectionId . Takes UserId as a parameter, which is a user provided ID which should be unique within the…
  • POSTDelete collection/#X-Amz-Target=RekognitionService.DeleteCollectionDeletes the specified collection. Note that this operation removes all faces in the collection. For an example, see Deleting a collection . This operation…
  • POSTDelete dataset/#X-Amz-Target=RekognitionService.DeleteDatasetThis operation applies only to Amazon Rekognition Custom Labels. Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset might take…
  • POSTDelete faces/#X-Amz-Target=RekognitionService.DeleteFacesDeletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection. This operation requires permissions to…
  • POSTDelete project/#X-Amz-Target=RekognitionService.DeleteProjectDeletes a Amazon Rekognition project. To delete a project you must first delete all models or adapters associated with the project. To delete a model or…
  • POSTDelete project policy/#X-Amz-Target=RekognitionService.DeleteProjectPolicyThis operation applies only to Amazon Rekognition Custom Labels. Deletes an existing project policy. To get a list of project policies attached to a project,…
  • POSTDelete project version/#X-Amz-Target=RekognitionService.DeleteProjectVersionDeletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom adapter. You can't delete a project version…
  • POSTDelete stream processor/#X-Amz-Target=RekognitionService.DeleteStreamProcessorService availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature…
  • POSTDelete user/#X-Amz-Target=RekognitionService.DeleteUserDeletes the specified UserID within the collection. Faces that are associated with the UserID are disassociated from the UserID before deleting the specified…
  • POSTDescribe collection/#X-Amz-Target=RekognitionService.DescribeCollectionDescribes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version…
  • POSTDescribe dataset/#X-Amz-Target=RekognitionService.DescribeDatasetThis operation applies only to Amazon Rekognition Custom Labels. Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the…
  • POSTDescribe project versions/#X-Amz-Target=RekognitionService.DescribeProjectVersionsLists and describes the versions of an Amazon Rekognition project. You can specify up to 10 model or adapter versions in ProjectVersionArns . If you don't…
  • POSTDescribe projects/#X-Amz-Target=RekognitionService.DescribeProjectsGets information about your Rekognition projects. This operation requires permissions to perform the rekognition:DescribeProjects action.
  • POSTDescribe stream processor/#X-Amz-Target=RekognitionService.DescribeStreamProcessorService availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature…
  • POSTDetect custom labels/#X-Amz-Target=RekognitionService.DetectCustomLabelsThis operation applies only to Amazon Rekognition Custom Labels. Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.…
  • POSTDetect faces/#X-Amz-Target=RekognitionService.DetectFacesDetects faces within an image that is provided as input. DetectFaces detects the 100 largest faces in the image. For each face detected, the operation returns…
  • POSTDetect labels/#X-Amz-Target=RekognitionService.DetectLabelsDetects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like…
  • POSTDetect moderation labels/#X-Amz-Target=RekognitionService.DetectModerationLabelsDetects unsafe content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you…
  • POSTDetect protective equipment/#X-Amz-Target=RekognitionService.DetectProtectiveEquipmentDetects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the following types of PPE. Face cover Hand…
  • POSTDetect text/#X-Amz-Target=RekognitionService.DetectTextDetects text in the input image and converts it into machine-readable text. Pass the input image as base64-encoded image bytes or as a reference to an image…
  • POSTDisassociate faces/#X-Amz-Target=RekognitionService.DisassociateFacesRemoves the association between a Face supplied in an array of FaceIds and the User. If the User is not present already, then a ResourceNotFound exception is…
  • POSTDistribute dataset entries/#X-Amz-Target=RekognitionService.DistributeDatasetEntriesThis operation applies only to Amazon Rekognition Custom Labels. Distributes the entries (images) in a training dataset across the training dataset and the…
  • POSTGet celebrity info/#X-Amz-Target=RekognitionService.GetCelebrityInfoGets the name and additional information about a celebrity based on their Amazon Rekognition ID. The additional information is returned as an array of URLs.…
  • POSTGet celebrity recognition/#X-Amz-Target=RekognitionService.GetCelebrityRecognitionGets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition . Celebrity recognition in a video is an…
  • POSTGet content moderation/#X-Amz-Target=RekognitionService.GetContentModerationGets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration . For a list…
  • POSTGet face detection/#X-Amz-Target=RekognitionService.GetFaceDetectionGets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection . Face detection with Amazon Rekognition Video is an…
  • POSTGet face liveness session results/#X-Amz-Target=RekognitionService.GetFaceLivenessSessionResultsRetrieves the results of a specific Face Liveness session. It requires the sessionId as input, which was created using CreateFaceLivenessSession . Returns the…
  • POSTGet face search/#X-Amz-Target=RekognitionService.GetFaceSearchGets the face search results for Amazon Rekognition Video face search started by StartFaceSearch . The search returns faces in a collection that match the…
  • POSTGet label detection/#X-Amz-Target=RekognitionService.GetLabelDetectionGets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection . The label detection operation is started by a call to…
  • POSTGet media analysis job/#X-Amz-Target=RekognitionService.GetMediaAnalysisJobService availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature…
  • POSTGet person tracking/#X-Amz-Target=RekognitionService.GetPersonTrackingEnd of support notice: On October 31, 2025, AWS will discontinue support for Amazon Rekognition People Pathing. After October 31, 2025, you will no longer be…
  • POSTGet segment detection/#X-Amz-Target=RekognitionService.GetSegmentDetectionGets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection . Segment detection with Amazon Rekognition Video…
  • POSTGet text detection/#X-Amz-Target=RekognitionService.GetTextDetectionGets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection . Text detection with Amazon Rekognition Video is an…
  • POSTIndex faces/#X-Amz-Target=RekognitionService.IndexFacesDetects faces in the input image and adds them to the specified collection. Amazon Rekognition doesn't save the actual faces that are detected. Instead, the…
  • POSTList collections/#X-Amz-Target=RekognitionService.ListCollectionsReturns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request…
  • POSTList dataset entries/#X-Amz-Target=RekognitionService.ListDatasetEntriesThis operation applies only to Amazon Rekognition Custom Labels. Lists the entries (images) within a dataset. An entry is a JSON Line that contains the…
  • POSTList dataset labels/#X-Amz-Target=RekognitionService.ListDatasetLabelsThis operation applies only to Amazon Rekognition Custom Labels. Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe…
  • POSTList faces/#X-Amz-Target=RekognitionService.ListFacesReturns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the…
  • POSTList media analysis jobs/#X-Amz-Target=RekognitionService.ListMediaAnalysisJobsService availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature…
  • POSTList project policies/#X-Amz-Target=RekognitionService.ListProjectPoliciesThis operation applies only to Amazon Rekognition Custom Labels. Gets a list of the project policies attached to a project. To attach a project policy to a…
  • POSTList stream processors/#X-Amz-Target=RekognitionService.ListStreamProcessorsService availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature…
  • POSTList tags for resource/#X-Amz-Target=RekognitionService.ListTagsForResourceReturns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model. This operation requires permissions to perform the…
  • POSTList users/#X-Amz-Target=RekognitionService.ListUsersReturns metadata of the User such as UserID in the specified collection. Anonymous User (to reserve faces without any identity) is not returned as part of…
  • POSTPut project policy/#X-Amz-Target=RekognitionService.PutProjectPolicyThis operation applies only to Amazon Rekognition Custom Labels. Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS…
  • POSTRecognize celebrities/#X-Amz-Target=RekognitionService.RecognizeCelebritiesReturns an array of celebrities recognized in the input image. For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.…
  • POSTSearch faces/#X-Amz-Target=RekognitionService.SearchFacesFor a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using…
  • POSTSearch faces by image/#X-Amz-Target=RekognitionService.SearchFacesByImageFor a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares…
  • POSTSearch users/#X-Amz-Target=RekognitionService.SearchUsersSearches for UserIDs within a collection based on a FaceId or UserId . This API can be used to find the closest UserID (with a highest similarity) to…
  • POSTSearch users by image/#X-Amz-Target=RekognitionService.SearchUsersByImageSearches for UserIDs using a supplied image. It first detects the largest face in the image, and then searches a specified collection for matching UserIDs.…
  • POSTStart celebrity recognition/#X-Amz-Target=RekognitionService.StartCelebrityRecognitionStarts asynchronous recognition of celebrities in a stored video. Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3…
  • POSTStart content moderation/#X-Amz-Target=RekognitionService.StartContentModerationStarts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see…
  • POSTStart face detection/#X-Amz-Target=RekognitionService.StartFaceDetectionStarts asynchronous detection of faces in a stored video. Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to…
  • POSTStart face search/#X-Amz-Target=RekognitionService.StartFaceSearchStarts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video. The video must be stored in an Amazon S3…
  • POSTStart label detection/#X-Amz-Target=RekognitionService.StartLabelDetectionStarts asynchronous detection of labels in a stored video. Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities.…
  • POSTStart media analysis job/#X-Amz-Target=RekognitionService.StartMediaAnalysisJobService availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature…
  • POSTStart person tracking/#X-Amz-Target=RekognitionService.StartPersonTrackingEnd of support notice: On October 31, 2025, AWS will discontinue support for Amazon Rekognition People Pathing. After October 31, 2025, you will no longer be…
  • POSTStart project version/#X-Amz-Target=RekognitionService.StartProjectVersionThis operation applies only to Amazon Rekognition Custom Labels. Starts the running of the version of a model. Starting a model takes a while to complete. To…
  • POSTStart segment detection/#X-Amz-Target=RekognitionService.StartSegmentDetectionStarts asynchronous detection of segment detection in a stored video. Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket.…
  • POSTStart stream processor/#X-Amz-Target=RekognitionService.StartStreamProcessorService availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature…
  • POSTStart text detection/#X-Amz-Target=RekognitionService.StartTextDetectionStarts asynchronous detection of text in a stored video. Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to…
  • POSTStop project version/#X-Amz-Target=RekognitionService.StopProjectVersionThis operation applies only to Amazon Rekognition Custom Labels. Stops a running model. The operation might take a while to complete. To check the current…
  • POSTStop stream processor/#X-Amz-Target=RekognitionService.StopStreamProcessorService availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature…
  • POSTTag resource/#X-Amz-Target=RekognitionService.TagResourceAdds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model. For more information, see Tagging AWS Resources…
  • POSTUntag resource/#X-Amz-Target=RekognitionService.UntagResourceRemoves one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model. This operation requires permissions to perform the…
  • POSTUpdate dataset entries/#X-Amz-Target=RekognitionService.UpdateDatasetEntriesThis operation applies only to Amazon Rekognition Custom Labels. Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which…
  • POSTUpdate stream processor/#X-Amz-Target=RekognitionService.UpdateStreamProcessorService availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature…

API details

Base URL
https://rekognition.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
75 operations on 75 pathsPOST 75
Description format
AWS Smithy model, API version 2016-06-27

How to test the Amazon Rekognition in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Rekognition collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate faces” (POST /#X-Amz-Target=RekognitionService.AssociateFaces), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Rekognition?

This is the API Reference for Amazon Rekognition Image , Amazon Rekognition Bulk Image Analysis , Amazon Rekognition Custom Labels , Amazon Rekognition Stored… It is listed under AI & machine learning and has 75 endpoints.

Who publishes the Amazon Rekognition?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Rekognition?

Requests go to https://rekognition.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Rekognition?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Rekognition have?

75 operations on 75 paths (75 POST).

Is forking the Amazon Rekognition free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.