1{
2  "version": "1.0",
3  "examples": {
4    "CompareFaces": [
5      {
6        "input": {
7          "SimilarityThreshold": 90,
8          "SourceImage": {
9            "S3Object": {
10              "Bucket": "mybucket",
11              "Name": "mysourceimage"
12            }
13          },
14          "TargetImage": {
15            "S3Object": {
16              "Bucket": "mybucket",
17              "Name": "mytargetimage"
18            }
19          }
20        },
21        "output": {
22          "FaceMatches": [
23            {
24              "Face": {
25                "BoundingBox": {
26                  "Height": 0.33481481671333313,
27                  "Left": 0.31888890266418457,
28                  "Top": 0.4933333396911621,
29                  "Width": 0.25
30                },
31                "Confidence": 99.9991226196289
32              },
33              "Similarity": 100
34            }
35          ],
36          "SourceImageFace": {
37            "BoundingBox": {
38              "Height": 0.33481481671333313,
39              "Left": 0.31888890266418457,
40              "Top": 0.4933333396911621,
41              "Width": 0.25
42            },
43            "Confidence": 99.9991226196289
44          }
45        },
46        "comments": {
47          "input": {
48          },
49          "output": {
50          }
51        },
52        "description": "This operation compares the largest face detected in the source image with each face detected in the target image.",
53        "id": "to-compare-two-images-1482181985581",
54        "title": "To compare two images"
55      }
56    ],
57    "CreateCollection": [
58      {
59        "input": {
60          "CollectionId": "myphotos"
61        },
62        "output": {
63          "CollectionArn": "aws:rekognition:us-west-2:123456789012:collection/myphotos",
64          "StatusCode": 200
65        },
66        "comments": {
67          "input": {
68          },
69          "output": {
70          }
71        },
72        "description": "This operation creates a Rekognition collection for storing image data.",
73        "id": "to-create-a-collection-1481833313674",
74        "title": "To create a collection"
75      }
76    ],
77    "DeleteCollection": [
78      {
79        "input": {
80          "CollectionId": "myphotos"
81        },
82        "output": {
83          "StatusCode": 200
84        },
85        "comments": {
86          "input": {
87          },
88          "output": {
89          }
90        },
91        "description": "This operation deletes a Rekognition collection.",
92        "id": "to-delete-a-collection-1481838179973",
93        "title": "To delete a collection"
94      }
95    ],
96    "DeleteFaces": [
97      {
98        "input": {
99          "CollectionId": "myphotos",
100          "FaceIds": [
101            "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
102          ]
103        },
104        "output": {
105          "DeletedFaces": [
106            "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
107          ]
108        },
109        "comments": {
110          "input": {
111          },
112          "output": {
113          }
114        },
115        "description": "This operation deletes one or more faces from a Rekognition collection.",
116        "id": "to-delete-a-face-1482182799377",
117        "title": "To delete a face"
118      }
119    ],
120    "DetectFaces": [
121      {
122        "input": {
123          "Image": {
124            "S3Object": {
125              "Bucket": "mybucket",
126              "Name": "myphoto"
127            }
128          }
129        },
130        "output": {
131          "FaceDetails": [
132            {
133              "BoundingBox": {
134                "Height": 0.18000000715255737,
135                "Left": 0.5555555820465088,
136                "Top": 0.33666667342185974,
137                "Width": 0.23999999463558197
138              },
139              "Confidence": 100,
140              "Landmarks": [
141                {
142                  "Type": "eyeLeft",
143                  "X": 0.6394737362861633,
144                  "Y": 0.40819624066352844
145                },
146                {
147                  "Type": "eyeRight",
148                  "X": 0.7266660928726196,
149                  "Y": 0.41039225459098816
150                },
151                {
152                  "Type": "eyeRight",
153                  "X": 0.6912462115287781,
154                  "Y": 0.44240960478782654
155                },
156                {
157                  "Type": "mouthDown",
158                  "X": 0.6306198239326477,
159                  "Y": 0.46700039505958557
160                },
161                {
162                  "Type": "mouthUp",
163                  "X": 0.7215608954429626,
164                  "Y": 0.47114261984825134
165                }
166              ],
167              "Pose": {
168                "Pitch": 4.050806522369385,
169                "Roll": 0.9950747489929199,
170                "Yaw": 13.693790435791016
171              },
172              "Quality": {
173                "Brightness": 37.60169982910156,
174                "Sharpness": 80
175              }
176            }
177          ],
178          "OrientationCorrection": "ROTATE_0"
179        },
180        "comments": {
181          "input": {
182          },
183          "output": {
184          }
185        },
186        "description": "This operation detects faces in an image stored in an AWS S3 bucket.",
187        "id": "to-detect-faces-in-an-image-1481841782793",
188        "title": "To detect faces in an image"
189      }
190    ],
191    "DetectLabels": [
192      {
193        "input": {
194          "Image": {
195            "S3Object": {
196              "Bucket": "mybucket",
197              "Name": "myphoto"
198            }
199          },
200          "MaxLabels": 123,
201          "MinConfidence": 70
202        },
203        "output": {
204          "Labels": [
205            {
206              "Confidence": 99.25072479248047,
207              "Name": "People"
208            },
209            {
210              "Confidence": 99.25074005126953,
211              "Name": "Person"
212            }
213          ]
214        },
215        "comments": {
216          "input": {
217          },
218          "output": {
219          }
220        },
221        "description": "This operation detects labels in the supplied image",
222        "id": "to-detect-labels-1481834255770",
223        "title": "To detect labels"
224      }
225    ],
226    "IndexFaces": [
227      {
228        "input": {
229          "CollectionId": "myphotos",
230          "DetectionAttributes": [
231
232          ],
233          "ExternalImageId": "myphotoid",
234          "Image": {
235            "S3Object": {
236              "Bucket": "mybucket",
237              "Name": "myphoto"
238            }
239          }
240        },
241        "output": {
242          "FaceRecords": [
243            {
244              "Face": {
245                "BoundingBox": {
246                  "Height": 0.33481481671333313,
247                  "Left": 0.31888890266418457,
248                  "Top": 0.4933333396911621,
249                  "Width": 0.25
250                },
251                "Confidence": 99.9991226196289,
252                "FaceId": "ff43d742-0c13-5d16-a3e8-03d3f58e980b",
253                "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
254              },
255              "FaceDetail": {
256                "BoundingBox": {
257                  "Height": 0.33481481671333313,
258                  "Left": 0.31888890266418457,
259                  "Top": 0.4933333396911621,
260                  "Width": 0.25
261                },
262                "Confidence": 99.9991226196289,
263                "Landmarks": [
264                  {
265                    "Type": "eyeLeft",
266                    "X": 0.3976764678955078,
267                    "Y": 0.6248345971107483
268                  },
269                  {
270                    "Type": "eyeRight",
271                    "X": 0.4810936450958252,
272                    "Y": 0.6317117214202881
273                  },
274                  {
275                    "Type": "noseLeft",
276                    "X": 0.41986238956451416,
277                    "Y": 0.7111940383911133
278                  },
279                  {
280                    "Type": "mouthDown",
281                    "X": 0.40525302290916443,
282                    "Y": 0.7497701048851013
283                  },
284                  {
285                    "Type": "mouthUp",
286                    "X": 0.4753248989582062,
287                    "Y": 0.7558549642562866
288                  }
289                ],
290                "Pose": {
291                  "Pitch": -9.713645935058594,
292                  "Roll": 4.707281112670898,
293                  "Yaw": -24.438663482666016
294                },
295                "Quality": {
296                  "Brightness": 29.23358917236328,
297                  "Sharpness": 80
298                }
299              }
300            },
301            {
302              "Face": {
303                "BoundingBox": {
304                  "Height": 0.32592591643333435,
305                  "Left": 0.5144444704055786,
306                  "Top": 0.15111111104488373,
307                  "Width": 0.24444444477558136
308                },
309                "Confidence": 99.99950408935547,
310                "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2",
311                "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
312              },
313              "FaceDetail": {
314                "BoundingBox": {
315                  "Height": 0.32592591643333435,
316                  "Left": 0.5144444704055786,
317                  "Top": 0.15111111104488373,
318                  "Width": 0.24444444477558136
319                },
320                "Confidence": 99.99950408935547,
321                "Landmarks": [
322                  {
323                    "Type": "eyeLeft",
324                    "X": 0.6006892323493958,
325                    "Y": 0.290842205286026
326                  },
327                  {
328                    "Type": "eyeRight",
329                    "X": 0.6808141469955444,
330                    "Y": 0.29609042406082153
331                  },
332                  {
333                    "Type": "noseLeft",
334                    "X": 0.6395332217216492,
335                    "Y": 0.3522595763206482
336                  },
337                  {
338                    "Type": "mouthDown",
339                    "X": 0.5892083048820496,
340                    "Y": 0.38689887523651123
341                  },
342                  {
343                    "Type": "mouthUp",
344                    "X": 0.674560010433197,
345                    "Y": 0.394125759601593
346                  }
347                ],
348                "Pose": {
349                  "Pitch": -4.683138370513916,
350                  "Roll": 2.1029529571533203,
351                  "Yaw": 6.716655254364014
352                },
353                "Quality": {
354                  "Brightness": 34.951698303222656,
355                  "Sharpness": 160
356                }
357              }
358            }
359          ],
360          "OrientationCorrection": "ROTATE_0"
361        },
362        "comments": {
363          "input": {
364          },
365          "output": {
366          }
367        },
368        "description": "This operation detects faces in an image and adds them to the specified Rekognition collection.",
369        "id": "to-add-a-face-to-a-collection-1482179542923",
370        "title": "To add a face to a collection"
371      }
372    ],
373    "ListCollections": [
374      {
375        "input": {
376        },
377        "output": {
378          "CollectionIds": [
379            "myphotos"
380          ]
381        },
382        "comments": {
383          "input": {
384          },
385          "output": {
386          }
387        },
388        "description": "This operation returns a list of Rekognition collections.",
389        "id": "to-list-the-collections-1482179199088",
390        "title": "To list the collections"
391      }
392    ],
393    "ListFaces": [
394      {
395        "input": {
396          "CollectionId": "myphotos",
397          "MaxResults": 20
398        },
399        "output": {
400          "Faces": [
401            {
402              "BoundingBox": {
403                "Height": 0.18000000715255737,
404                "Left": 0.5555559992790222,
405                "Top": 0.336667001247406,
406                "Width": 0.23999999463558197
407              },
408              "Confidence": 100,
409              "FaceId": "1c62e8b5-69a7-5b7d-b3cd-db4338a8a7e7",
410              "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e"
411            },
412            {
413              "BoundingBox": {
414                "Height": 0.16555599868297577,
415                "Left": 0.30963000655174255,
416                "Top": 0.7066670060157776,
417                "Width": 0.22074100375175476
418              },
419              "Confidence": 100,
420              "FaceId": "29a75abe-397b-5101-ba4f-706783b2246c",
421              "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e"
422            },
423            {
424              "BoundingBox": {
425                "Height": 0.3234420120716095,
426                "Left": 0.3233329951763153,
427                "Top": 0.5,
428                "Width": 0.24222199618816376
429              },
430              "Confidence": 99.99829864501953,
431              "FaceId": "38271d79-7bc2-5efb-b752-398a8d575b85",
432              "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5"
433            },
434            {
435              "BoundingBox": {
436                "Height": 0.03555560111999512,
437                "Left": 0.37388700246810913,
438                "Top": 0.2477779984474182,
439                "Width": 0.04747769981622696
440              },
441              "Confidence": 99.99210357666016,
442              "FaceId": "3b01bef0-c883-5654-ba42-d5ad28b720b3",
443              "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
444            },
445            {
446              "BoundingBox": {
447                "Height": 0.05333330109715462,
448                "Left": 0.2937690019607544,
449                "Top": 0.35666701197624207,
450                "Width": 0.07121659815311432
451              },
452              "Confidence": 99.99919891357422,
453              "FaceId": "4839a608-49d0-566c-8301-509d71b534d1",
454              "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
455            },
456            {
457              "BoundingBox": {
458                "Height": 0.3249259889125824,
459                "Left": 0.5155559778213501,
460                "Top": 0.1513350009918213,
461                "Width": 0.24333299696445465
462              },
463              "Confidence": 99.99949645996094,
464              "FaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14",
465              "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5"
466            },
467            {
468              "BoundingBox": {
469                "Height": 0.03777780011296272,
470                "Left": 0.7002969980239868,
471                "Top": 0.18777799606323242,
472                "Width": 0.05044509842991829
473              },
474              "Confidence": 99.92639923095703,
475              "FaceId": "7f5f88ed-d684-5a88-b0df-01e4a521552b",
476              "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
477            },
478            {
479              "BoundingBox": {
480                "Height": 0.05555560067296028,
481                "Left": 0.13946600258350372,
482                "Top": 0.46333301067352295,
483                "Width": 0.07270029932260513
484              },
485              "Confidence": 99.99469757080078,
486              "FaceId": "895b4e2c-81de-5902-a4bd-d1792bda00b2",
487              "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
488            },
489            {
490              "BoundingBox": {
491                "Height": 0.3259260058403015,
492                "Left": 0.5144439935684204,
493                "Top": 0.15111100673675537,
494                "Width": 0.24444399774074554
495              },
496              "Confidence": 99.99949645996094,
497              "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2",
498              "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
499            },
500            {
501              "BoundingBox": {
502                "Height": 0.18888899683952332,
503                "Left": 0.3783380091190338,
504                "Top": 0.2355560064315796,
505                "Width": 0.25222599506378174
506              },
507              "Confidence": 99.9999008178711,
508              "FaceId": "908544ad-edc3-59df-8faf-6a87cc256cf5",
509              "ImageId": "3c731605-d772-541a-a5e7-0375dbc68a07"
510            },
511            {
512              "BoundingBox": {
513                "Height": 0.33481499552726746,
514                "Left": 0.31888899207115173,
515                "Top": 0.49333301186561584,
516                "Width": 0.25
517              },
518              "Confidence": 99.99909973144531,
519              "FaceId": "ff43d742-0c13-5d16-a3e8-03d3f58e980b",
520              "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
521            }
522          ]
523        },
524        "comments": {
525          "input": {
526          },
527          "output": {
528          }
529        },
530        "description": "This operation lists the faces in a Rekognition collection.",
531        "id": "to-list-the-faces-in-a-collection-1482181416530",
532        "title": "To list the faces in a collection"
533      }
534    ],
535    "SearchFaces": [
536      {
537        "input": {
538          "CollectionId": "myphotos",
539          "FaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14",
540          "FaceMatchThreshold": 90,
541          "MaxFaces": 10
542        },
543        "output": {
544          "FaceMatches": [
545            {
546              "Face": {
547                "BoundingBox": {
548                  "Height": 0.3259260058403015,
549                  "Left": 0.5144439935684204,
550                  "Top": 0.15111100673675537,
551                  "Width": 0.24444399774074554
552                },
553                "Confidence": 99.99949645996094,
554                "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2",
555                "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
556              },
557              "Similarity": 99.97222137451172
558            },
559            {
560              "Face": {
561                "BoundingBox": {
562                  "Height": 0.16555599868297577,
563                  "Left": 0.30963000655174255,
564                  "Top": 0.7066670060157776,
565                  "Width": 0.22074100375175476
566                },
567                "Confidence": 100,
568                "FaceId": "29a75abe-397b-5101-ba4f-706783b2246c",
569                "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e"
570              },
571              "Similarity": 97.04154968261719
572            },
573            {
574              "Face": {
575                "BoundingBox": {
576                  "Height": 0.18888899683952332,
577                  "Left": 0.3783380091190338,
578                  "Top": 0.2355560064315796,
579                  "Width": 0.25222599506378174
580                },
581                "Confidence": 99.9999008178711,
582                "FaceId": "908544ad-edc3-59df-8faf-6a87cc256cf5",
583                "ImageId": "3c731605-d772-541a-a5e7-0375dbc68a07"
584              },
585              "Similarity": 95.94520568847656
586            }
587          ],
588          "SearchedFaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14"
589        },
590        "comments": {
591          "input": {
592          },
593          "output": {
594          }
595        },
596        "description": "This operation searches for matching faces in the collection the supplied face belongs to.",
597        "id": "to-delete-a-face-1482182799377",
598        "title": "To delete a face"
599      }
600    ],
601    "SearchFacesByImage": [
602      {
603        "input": {
604          "CollectionId": "myphotos",
605          "FaceMatchThreshold": 95,
606          "Image": {
607            "S3Object": {
608              "Bucket": "mybucket",
609              "Name": "myphoto"
610            }
611          },
612          "MaxFaces": 5
613        },
614        "output": {
615          "FaceMatches": [
616            {
617              "Face": {
618                "BoundingBox": {
619                  "Height": 0.3234420120716095,
620                  "Left": 0.3233329951763153,
621                  "Top": 0.5,
622                  "Width": 0.24222199618816376
623                },
624                "Confidence": 99.99829864501953,
625                "FaceId": "38271d79-7bc2-5efb-b752-398a8d575b85",
626                "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5"
627              },
628              "Similarity": 99.97036743164062
629            }
630          ],
631          "SearchedFaceBoundingBox": {
632            "Height": 0.33481481671333313,
633            "Left": 0.31888890266418457,
634            "Top": 0.4933333396911621,
635            "Width": 0.25
636          },
637          "SearchedFaceConfidence": 99.9991226196289
638        },
639        "comments": {
640          "input": {
641          },
642          "output": {
643          }
644        },
645        "description": "This operation searches for faces in a Rekognition collection that match the largest face in an S3 bucket stored image.",
646        "id": "to-search-for-faces-matching-a-supplied-image-1482175994491",
647        "title": "To search for faces matching a supplied image"
648      }
649    ]
650  }
651}
652