{"id":26064825,"url":"https://github.com/syncano/syncano-socket-aws-rekognition","last_synced_at":"2025-08-03T06:06:41.234Z","repository":{"id":77440719,"uuid":"112344738","full_name":"Syncano/syncano-socket-aws-rekognition","owner":"Syncano","description":null,"archived":false,"fork":false,"pushed_at":"2018-04-16T14:32:02.000Z","size":292,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-08T18:51:12.988Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Syncano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-28T14:20:15.000Z","updated_at":"2018-04-16T14:32:04.000Z","dependencies_parsed_at":"2023-02-26T10:45:10.522Z","dependency_job_id":null,"html_url":"https://github.com/Syncano/syncano-socket-aws-rekognition","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Syncano/syncano-socket-aws-rekognition","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-rekognition","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-rekognition/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-rekognition/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-rekognition/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Syncano","download_url":"https://codeload.github.com/Syncano/syncano-socket-aws-rekognition/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-rekognition/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268500608,"owners_count":24260163,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-03T02:00:12.545Z","response_time":2577,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-08T18:49:28.345Z","updated_at":"2025-08-03T06:06:41.226Z","avatar_url":"https://github.com/Syncano.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aws-photo-rekognition\n\n[![CircleCI](https://circleci.com/gh/Syncano/syncano-socket-aws-rekognition.svg?style=svg)](https://circleci.com/gh/Syncano/syncano-socket-aws-rekognition)\n\n`version:` **0.0.2**\n\nAmazon Rekognition Integration\n\nTo install, run:\n\n```\nsyncano-cli add aws-photo-rekognition1\n```\n\n## Config\n\n| Name | Required | Description | Info\n| ---- | -------- | ----------- | ----\n| AWS_ACCESS_KEY_ID | true | AWS Access Key | To find the key, log into your AWS account to get it \n| AWS_SECRET_ACCESS_KEY | true | AWS Access Secret Key | To find the key, log into your AWS account to get it \n| region | true | Region | On your AWS Console, search for Rekognition to check supported regions and select one (e.g, us-east-1 ) \n\n## Endpoints\n\n### compare-faces\n\nCompares a face in the source image with each face detected in the target input image\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| sourceBucketName | string | Name of the source S3 bucket (Optional) | callen-images\n| sourceImage | string | a path to the image | an image in S3 bucket image | abc.jpg\n| targetBucketName | string | Name of the target S3 bucket (Optional) | callen-images\n| targetImage | string | a path to the image | an image in S3 bucket image | abc.jpg\n| similarityThreshold | string | The minimum level of confidence in the face matches that a match must meet. (Optional) | 20\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n\"message\": \"Comparison result.\"\n\"data\": {}\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"InvalidParameterType\",\n  \"message\": \"Expected params.SimilarityThreshold to be a number\"\n}\n```\n\n### create-collection\n\nCreate AWS Rekognition collection\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| collectionId | string | ID for the collection that you are creating. | callen-images\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n  \"statusCode\": 200,\n  \"message\": \"Collection Created.\"\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"ResourceAlreadyExistsException\",\n  \"message\": \"The collection id: callen-images already exists\"\n}\n```\n\n### delete-collection\n\nDelete AWS Rekognition collection using the collectionId.\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| collectionId | string | ID of the collection to delete. | callen-images\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n  \"statusCode\": 200,\n  \"message\": \"Collection Deleted.\"\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"ResourceNotFoundException\",\n  \"message\": \"The collection id: calle does not exist\"\n}\n```\n\n### delete-faces\n\nDetect Labels in uploaded images.\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| collectionId | string | Collection from which to remove the specific faces. | callen-images\n| faceId | string | Face IDs to delete. | 629e696f-0456-5bd5-aa49-50847570a653\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n  \"message\": \"Faces Detected\",\n  \"DeletedFaces\":[ \"11111111-2222-3333-4444-555555555555\"]\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"ValidationException\",\n  \"message\": \"1 validation error detected: Value '[]' at 'faceIds' failed to satisfy constraint\"\n}\n```\n\n### detect-faces\n\nDetect faces in uploaded images.\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| bucketName | string | Name of the S3 bucket (Optional). | callen-images\n| image | string | a path to the image | an image in S3 bucket image | abc.jpg\n| attr | string |  The facial attributes you want to be returned (Optional) | DEFAULT || ALL \n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n\"message\": \"Faces Detected\"\n\"data\": {\n          \"FaceDetails\": []\n        }\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"InvalidParameterException\",\n  \"message\": \"Request has Invalid Parameters\"\n}      \n```\n\n### detect-labels\n\nDetect Labels in uploaded images.\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| bucketName | string | Name of the S3 bucket (Optional). | callen-images\n| image | string | a path to the image | an image in S3 bucket image | abc.jpg\n| maxsLabels | string | Maximum number of labels you want the service to return in the response (Optional) | 4\n| minConfidence | string | Specify the minimum confidence level for the labels to return (Optional) | 23.6\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n  \"message\": \"Labels Detected\",\n  \"data\": {\n            \"Labels\": []\n          }\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"InvalidParameterException\",\n  \"message\": \"Requested image should either contain bytes or s3 object.\"\n}\n```\n\n### detect-moderation-labels\n\nDetects explicit or suggestive adult content in a specified JPEG or PNG format image.\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| bucketName | string | Name of the S3 bucket (Optional). | callen-images\n| image | string | a path to the image | an image in S3 bucket image | abc.jpg\n| minConfidence | string | Specify the minimum confidence level for the labels to return (Optional) | 23.6\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n\"message\": \"Moderation Labels Detected.\"\n\"data\": {\n          \"ModerationLabels\": []\n        }\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"InvalidParameterException\",\n  \"message\": \"Requested image should either contain bytes or s3 object.\"\n}\n```\n\n### get-celebrity-info\n\nGets the name and additional information about a celebrity based on his or her Rekognition ID.\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| celebrityId | string | ID for the celebrity. You can get the celebrity ID from a call to the RecognizeCelebrities operation | 3Ir0du6\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n\"message\": \"Celebrity Information\"\n\"data\": {}\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"code\": \"MissingRequiredParameter\",\n  \"message\": \"Missing required key 'Id' in params\"\n}\n```\n\n### index-faces\n\nDetects faces in the input image and adds them to the specified collection.\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| collectionId | string | The ID of an existing collection to which you want to add the faces that are detected in the input images. | callen-images\n| bucketName | string | Name of the S3 bucket (Optional). | callen-images\n| image | string | a path to the image | name of an image in S3 bucket image | abc.jpg\n| detectionAttributes | string |  The facial attributes you want to be returned (Optional) | DEFAULT || ALL \n| externalImageId | string | ID you want to assign to all the faces detected in the image. | indexed images\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n\"message\": \"Faces detected for indexing.\"\n\"data\": {\n          \"FaceRecords\": []\n        }\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"InvalidParameterException\",\n  \"message\": \"Requested image should either contain bytes or s3 object.\"\n}\n```\n\n### list-collections\n\nReturns list of collection IDs in your account.\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| maxResults | string | Maximum number of collection IDs to return. (Optional) | 5\n| nextTokens | string | Pagination token from the previous response. (Optional) | token\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n\"message\": \"Faces Detected\"\n\"data\": {\n          \"CollectionIds\": []\n        }\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"InvalidPaginationTokenException\",\n  \"message\": null\n}\n```\n\n### list-faces\n\nReturns metadata for faces in the specified collection.\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| collectionId | string | ID of the collection from which to list the faces. | callen-images\n| maxResults | string | Maximum number of collection IDs to return.(Optional) | 5\n| nextTokens | string | Pagination token from the previous response. (Optional) | token\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n\"message\": \"Faces Detected\",\n\"data\": {\n          \"Faces\": []\n        }\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"MissingRequiredParameter\",\n  \"message\": \"Missing required key 'CollectionId' in params\"\n}\n```\n\n### recognize-celebrities\n\nReturns an array of celebrities recognized in the input image.\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| bucketName | string | Name of the S3 bucket (Optional). | callen-images\n| image | string | a path to the image | name of an image in S3 bucket image | abc.jpg\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n\"message\": \"Recognized Celebrity Information\"\n\"data\": {\n          \"CelebrityFaces\": []\n        }\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"InvalidParameterException\",\n  \"message\": \"Requested image should either contain bytes or s3 object.\" \n}\n```\n\n### search-faces\n\nSearches for matching faces in the collection the face belongs to.\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| collectionId | string | ID of the collection the face belongs to. | callen-images\n| faceId | string | ID of a face to find matches for in the collection. | 629e696f-0456-5bd5-aa49-50847570a653\n| faceMatchThreshold | string | Specify the minimum confidence in the face match to return. (Optional) | 1.50\n| MaxFaces | string | Maximum number of faces to return. (Optional) | 10\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n\"message\": \"Faces Found.\"\n\"data\": {}\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"MissingRequiredParameter\",\n  \"message\": \"Missing required key 'FaceId' in params\"\n}\n```\n\n### search-faces-by-image\n\nDetects the largest face in the image, and then searches the specified collection for matching faces.\n\n#### Parameters\n\n| name | type | description | example\n| ---- | ---- | ----------- | -------\n| bucketName | string | Name of the S3 bucket (Optional). | callen-images\n| image | string | a path to the image | name of an image in S3 bucket image | abc.jpg\n| collectionId | string | ID of the collection to search. | callen-images\n| faceMatchThreshold | string | Specify the minimum confidence in the face match to return. (Optional) | 1.50\n| MaxFaces | string | Maximum number of faces to return. (Optional) | 10\n\n\n\n#### Response\n\nmimetype: `application/json`\n\n##### Success `200`\n\n```\n{\n\"message\": \"Faces Detected\"\n\"data\": {}\n}\n```\n\n##### Failed `400`\n\n```\n{\n  \"statusCode\": 400,\n  \"code\": \"InvalidParameterException\",\n  \"message\": \"Requested image should either contain bytes or s3 object.\"\n}\n```\n\n### Contributing\n\n#### How to Contribute\n\n* Fork this repository\n* Clone from your fork\n* Make your contributions (Make sure your work is well tested)\n* Create Pull request from the fork to this repo\n\n#### Setting up environment variables\n\n* Create a `.envrc` on parent folder\n* Copy contents of `.envrc.default` file to newly created `.envrc` file and assign appropriate values to the listed variables.\n\n#### Testing\n\n* Test are written in the `test` directory\n* Use the command `npm test` to run test\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyncano%2Fsyncano-socket-aws-rekognition","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsyncano%2Fsyncano-socket-aws-rekognition","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyncano%2Fsyncano-socket-aws-rekognition/lists"}