

***********
Rekognition
***********

.. contents:: Table of Contents
   :depth: 2


======
Client
======



.. py:class:: Rekognition.Client

  A low-level client representing Amazon Rekognition::

    
    import boto3
    
    client = boto3.client('rekognition')

  
  These are the available methods:
  
  *   :py:meth:`~Rekognition.Client.can_paginate`

  
  *   :py:meth:`~Rekognition.Client.compare_faces`

  
  *   :py:meth:`~Rekognition.Client.create_collection`

  
  *   :py:meth:`~Rekognition.Client.delete_collection`

  
  *   :py:meth:`~Rekognition.Client.delete_faces`

  
  *   :py:meth:`~Rekognition.Client.detect_faces`

  
  *   :py:meth:`~Rekognition.Client.detect_labels`

  
  *   :py:meth:`~Rekognition.Client.detect_moderation_labels`

  
  *   :py:meth:`~Rekognition.Client.generate_presigned_url`

  
  *   :py:meth:`~Rekognition.Client.get_celebrity_info`

  
  *   :py:meth:`~Rekognition.Client.get_paginator`

  
  *   :py:meth:`~Rekognition.Client.get_waiter`

  
  *   :py:meth:`~Rekognition.Client.index_faces`

  
  *   :py:meth:`~Rekognition.Client.list_collections`

  
  *   :py:meth:`~Rekognition.Client.list_faces`

  
  *   :py:meth:`~Rekognition.Client.recognize_celebrities`

  
  *   :py:meth:`~Rekognition.Client.search_faces`

  
  *   :py:meth:`~Rekognition.Client.search_faces_by_image`

  

  .. py:method:: can_paginate(operation_name)

        
    Check if an operation can be paginated.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :return: ``True`` if the operation can be paginated,
        ``False`` otherwise.


  .. py:method:: compare_faces(**kwargs)

    

    Compares a face in the *source* input image with each face detected in the *target* input image. 

     

    .. note::

       

      If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. 

       

     

    In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. 

     

    .. note::

       

      By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the ``SimilarityThreshold`` parameter.

       

     

     ``CompareFaces`` also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value.

     

    If the image doesn't contain Exif metadata, ``CompareFaces`` returns orientation information for the source and target images. Use these values to display the images with the correct image orientation.

     

    .. note::

       

      This is a stateless API operation. That is, data returned by this operation doesn't persist.

       

     

    For an example, see  get-started-exercise-compare-faces .

     

    This operation requires permissions to perform the ``rekognition:CompareFaces`` action.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CompareFaces>`_    


    **Request Syntax** 
    ::

      response = client.compare_faces(
          SourceImage={
              'Bytes': b'bytes',
              'S3Object': {
                  'Bucket': 'string',
                  'Name': 'string',
                  'Version': 'string'
              }
          },
          TargetImage={
              'Bytes': b'bytes',
              'S3Object': {
                  'Bucket': 'string',
                  'Name': 'string',
                  'Version': 'string'
              }
          },
          SimilarityThreshold=...
      )
    :type SourceImage: dict
    :param SourceImage: **[REQUIRED]** 

      The source image, either as bytes or as an S3 object.

      

    
      - **Bytes** *(bytes) --* 

        Blob of image bytes up to 5 MBs.

        

      
      - **S3Object** *(dict) --* 

        Identifies an S3 object as the image source.

        

      
        - **Bucket** *(string) --* 

          Name of the S3 bucket.

          

        
        - **Name** *(string) --* 

          S3 object key name.

          

        
        - **Version** *(string) --* 

          If the bucket is versioning enabled, you can specify the object version. 

          

        
      
    
    :type TargetImage: dict
    :param TargetImage: **[REQUIRED]** 

      The target image, either as bytes or as an S3 object.

      

    
      - **Bytes** *(bytes) --* 

        Blob of image bytes up to 5 MBs.

        

      
      - **S3Object** *(dict) --* 

        Identifies an S3 object as the image source.

        

      
        - **Bucket** *(string) --* 

          Name of the S3 bucket.

          

        
        - **Name** *(string) --* 

          S3 object key name.

          

        
        - **Version** *(string) --* 

          If the bucket is versioning enabled, you can specify the object version. 

          

        
      
    
    :type SimilarityThreshold: float
    :param SimilarityThreshold: 

      The minimum level of confidence in the face matches that a match must meet to be included in the ``FaceMatches`` array.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'SourceImageFace': {
                'BoundingBox': {
                    'Width': ...,
                    'Height': ...,
                    'Left': ...,
                    'Top': ...
                },
                'Confidence': ...
            },
            'FaceMatches': [
                {
                    'Similarity': ...,
                    'Face': {
                        'BoundingBox': {
                            'Width': ...,
                            'Height': ...,
                            'Left': ...,
                            'Top': ...
                        },
                        'Confidence': ...,
                        'Landmarks': [
                            {
                                'Type': 'EYE_LEFT'|'EYE_RIGHT'|'NOSE'|'MOUTH_LEFT'|'MOUTH_RIGHT'|'LEFT_EYEBROW_LEFT'|'LEFT_EYEBROW_RIGHT'|'LEFT_EYEBROW_UP'|'RIGHT_EYEBROW_LEFT'|'RIGHT_EYEBROW_RIGHT'|'RIGHT_EYEBROW_UP'|'LEFT_EYE_LEFT'|'LEFT_EYE_RIGHT'|'LEFT_EYE_UP'|'LEFT_EYE_DOWN'|'RIGHT_EYE_LEFT'|'RIGHT_EYE_RIGHT'|'RIGHT_EYE_UP'|'RIGHT_EYE_DOWN'|'NOSE_LEFT'|'NOSE_RIGHT'|'MOUTH_UP'|'MOUTH_DOWN'|'LEFT_PUPIL'|'RIGHT_PUPIL',
                                'X': ...,
                                'Y': ...
                            },
                        ],
                        'Pose': {
                            'Roll': ...,
                            'Yaw': ...,
                            'Pitch': ...
                        },
                        'Quality': {
                            'Brightness': ...,
                            'Sharpness': ...
                        }
                    }
                },
            ],
            'UnmatchedFaces': [
                {
                    'BoundingBox': {
                        'Width': ...,
                        'Height': ...,
                        'Left': ...,
                        'Top': ...
                    },
                    'Confidence': ...,
                    'Landmarks': [
                        {
                            'Type': 'EYE_LEFT'|'EYE_RIGHT'|'NOSE'|'MOUTH_LEFT'|'MOUTH_RIGHT'|'LEFT_EYEBROW_LEFT'|'LEFT_EYEBROW_RIGHT'|'LEFT_EYEBROW_UP'|'RIGHT_EYEBROW_LEFT'|'RIGHT_EYEBROW_RIGHT'|'RIGHT_EYEBROW_UP'|'LEFT_EYE_LEFT'|'LEFT_EYE_RIGHT'|'LEFT_EYE_UP'|'LEFT_EYE_DOWN'|'RIGHT_EYE_LEFT'|'RIGHT_EYE_RIGHT'|'RIGHT_EYE_UP'|'RIGHT_EYE_DOWN'|'NOSE_LEFT'|'NOSE_RIGHT'|'MOUTH_UP'|'MOUTH_DOWN'|'LEFT_PUPIL'|'RIGHT_PUPIL',
                            'X': ...,
                            'Y': ...
                        },
                    ],
                    'Pose': {
                        'Roll': ...,
                        'Yaw': ...,
                        'Pitch': ...
                    },
                    'Quality': {
                        'Brightness': ...,
                        'Sharpness': ...
                    }
                },
            ],
            'SourceImageOrientationCorrection': 'ROTATE_0'|'ROTATE_90'|'ROTATE_180'|'ROTATE_270',
            'TargetImageOrientationCorrection': 'ROTATE_0'|'ROTATE_90'|'ROTATE_180'|'ROTATE_270'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **SourceImageFace** *(dict) --* 

          The face in the source image that was used for comparison.

          
          

          - **BoundingBox** *(dict) --* 

            Bounding box of the face.

            
            

            - **Width** *(float) --* 

              Width of the bounding box as a ratio of the overall image width.

              
            

            - **Height** *(float) --* 

              Height of the bounding box as a ratio of the overall image height.

              
            

            - **Left** *(float) --* 

              Left coordinate of the bounding box as a ratio of overall image width.

              
            

            - **Top** *(float) --* 

              Top coordinate of the bounding box as a ratio of overall image height.

              
        
          

          - **Confidence** *(float) --* 

            Confidence level that the selected bounding box contains a face.

            
      
        

        - **FaceMatches** *(list) --* 

          An array of faces in the target image that match the source image face. Each ``CompareFacesMatch`` object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

          
          

          - *(dict) --* 

            Provides information about a face in a target image that matches the source image face analysed by ``CompareFaces`` . The ``Face`` property contains the bounding box of the face in the target image. The ``Similarity`` property is the confidence that the source image face matches the face in the bounding box.

            
            

            - **Similarity** *(float) --* 

              Level of confidence that the faces match.

              
            

            - **Face** *(dict) --* 

              Provides face metadata (bounding box and confidence that the bounding box actually contains a face).

              
              

              - **BoundingBox** *(dict) --* 

                Bounding box of the face.

                
                

                - **Width** *(float) --* 

                  Width of the bounding box as a ratio of the overall image width.

                  
                

                - **Height** *(float) --* 

                  Height of the bounding box as a ratio of the overall image height.

                  
                

                - **Left** *(float) --* 

                  Left coordinate of the bounding box as a ratio of overall image width.

                  
                

                - **Top** *(float) --* 

                  Top coordinate of the bounding box as a ratio of overall image height.

                  
            
              

              - **Confidence** *(float) --* 

                Level of confidence that what the bounding box contains is a face.

                
              

              - **Landmarks** *(list) --* 

                An array of facial landmarks.

                
                

                - *(dict) --* 

                  Indicates the location of the landmark on the face.

                  
                  

                  - **Type** *(string) --* 

                    Type of the landmark.

                    
                  

                  - **X** *(float) --* 

                    x-coordinate from the top left of the landmark expressed as the ration of the width of the image. For example, if the images is 700x200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5. 

                    
                  

                  - **Y** *(float) --* 

                    y-coordinate from the top left of the landmark expressed as the ration of the height of the image. For example, if the images is 700x200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

                    
              
            
              

              - **Pose** *(dict) --* 

                Indicates the pose of the face as determined by its pitch, roll, and yaw.

                
                

                - **Roll** *(float) --* 

                  Value representing the face rotation on the roll axis.

                  
                

                - **Yaw** *(float) --* 

                  Value representing the face rotation on the yaw axis.

                  
                

                - **Pitch** *(float) --* 

                  Value representing the face rotation on the pitch axis.

                  
            
              

              - **Quality** *(dict) --* 

                Identifies face image brightness and sharpness. 

                
                

                - **Brightness** *(float) --* 

                  Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

                  
                

                - **Sharpness** *(float) --* 

                  Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

                  
            
          
        
      
        

        - **UnmatchedFaces** *(list) --* 

          An array of faces in the target image that did not match the source image face.

          
          

          - *(dict) --* 

            Provides face metadata for target image faces that are analysed by ``CompareFaces`` and ``RecognizeCelebrities`` .

            
            

            - **BoundingBox** *(dict) --* 

              Bounding box of the face.

              
              

              - **Width** *(float) --* 

                Width of the bounding box as a ratio of the overall image width.

                
              

              - **Height** *(float) --* 

                Height of the bounding box as a ratio of the overall image height.

                
              

              - **Left** *(float) --* 

                Left coordinate of the bounding box as a ratio of overall image width.

                
              

              - **Top** *(float) --* 

                Top coordinate of the bounding box as a ratio of overall image height.

                
          
            

            - **Confidence** *(float) --* 

              Level of confidence that what the bounding box contains is a face.

              
            

            - **Landmarks** *(list) --* 

              An array of facial landmarks.

              
              

              - *(dict) --* 

                Indicates the location of the landmark on the face.

                
                

                - **Type** *(string) --* 

                  Type of the landmark.

                  
                

                - **X** *(float) --* 

                  x-coordinate from the top left of the landmark expressed as the ration of the width of the image. For example, if the images is 700x200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5. 

                  
                

                - **Y** *(float) --* 

                  y-coordinate from the top left of the landmark expressed as the ration of the height of the image. For example, if the images is 700x200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

                  
            
          
            

            - **Pose** *(dict) --* 

              Indicates the pose of the face as determined by its pitch, roll, and yaw.

              
              

              - **Roll** *(float) --* 

                Value representing the face rotation on the roll axis.

                
              

              - **Yaw** *(float) --* 

                Value representing the face rotation on the yaw axis.

                
              

              - **Pitch** *(float) --* 

                Value representing the face rotation on the pitch axis.

                
          
            

            - **Quality** *(dict) --* 

              Identifies face image brightness and sharpness. 

              
              

              - **Brightness** *(float) --* 

                Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

                
              

              - **Sharpness** *(float) --* 

                Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

                
          
        
      
        

        - **SourceImageOrientationCorrection** *(string) --* 

          The orientation of the source image (counterclockwise direction). If your application displays the source image, you can use this value to correct image orientation. The bounding box coordinates returned in ``SourceImageFace`` represent the location of the face before the image orientation is corrected. 

           

          .. note::

             

            If the source image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If the Exif metadata for the source image populates the orientation field, the value of ``OrientationCorrection`` is null and the ``SourceImageFace`` bounding box coordinates represent the location of the face after Exif metadata is used to correct the orientation. Images in .png format don't contain Exif metadata.

             

          
        

        - **TargetImageOrientationCorrection** *(string) --* 

          The orientation of the target image (in counterclockwise direction). If your application displays the target image, you can use this value to correct the orientation of the image. The bounding box coordinates returned in ``FaceMatches`` and ``UnmatchedFaces`` represent face locations before the image orientation is corrected. 

           

          .. note::

             

            If the target image is in .jpg format, it might contain Exif metadata that includes the orientation of the image. If the Exif metadata for the target image populates the orientation field, the value of ``OrientationCorrection`` is null and the bounding box coordinates in ``FaceMatches`` and ``UnmatchedFaces`` represent the location of the face after Exif metadata is used to correct the orientation. Images in .png format don't contain Exif metadata.

             

          
    

    **Examples** 

    This operation compares the largest face detected in the source image with each face detected in the target image.
    ::

      response = client.compare_faces(
          SimilarityThreshold=90,
          SourceImage={
              'S3Object': {
                  'Bucket': 'mybucket',
                  'Name': 'mysourceimage',
              },
          },
          TargetImage={
              'S3Object': {
                  'Bucket': 'mybucket',
                  'Name': 'mytargetimage',
              },
          },
      )
      
      print(response)

    
    Expected Output:
    ::

      {
          'FaceMatches': [
              {
                  'Face': {
                      'BoundingBox': {
                          'Height': 0.334814816713,
                          'Left': 0.318888902664,
                          'Top': 0.493333339691,
                          'Width': 0.25,
                      },
                      'Confidence': 99.9991226196,
                  },
                  'Similarity': 100,
              },
          ],
          'SourceImageFace': {
              'BoundingBox': {
                  'Height': 0.334814816713,
                  'Left': 0.318888902664,
                  'Top': 0.493333339691,
                  'Width': 0.25,
              },
              'Confidence': 99.9991226196,
          },
          'ResponseMetadata': {
              '...': '...',
          },
      }

    

  .. py:method:: create_collection(**kwargs)

    

    Creates a collection in an AWS Region. You can add faces to the collection using the operation. 

     

    For example, you might create collections, one for each of your application users. A user can then index faces using the ``IndexFaces`` operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container. 

     

    .. note::

       

      Collection names are case-sensitive.

       

     

    For an example, see  example1 . 

     

    This operation requires permissions to perform the ``rekognition:CreateCollection`` action.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/CreateCollection>`_    


    **Request Syntax** 
    ::

      response = client.create_collection(
          CollectionId='string'
      )
    :type CollectionId: string
    :param CollectionId: **[REQUIRED]** 

      ID for the collection that you are creating.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StatusCode': 123,
            'CollectionArn': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **StatusCode** *(integer) --* 

          HTTP status code indicating the result of the operation.

          
        

        - **CollectionArn** *(string) --* 

          Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources. 

          
    

    **Examples** 

    This operation creates a Rekognition collection for storing image data.
    ::

      response = client.create_collection(
          CollectionId='myphotos',
      )
      
      print(response)

    
    Expected Output:
    ::

      {
          'CollectionArn': 'aws:rekognition:us-west-2:123456789012:collection/myphotos',
          'StatusCode': 200,
          'ResponseMetadata': {
              '...': '...',
          },
      }

    

  .. py:method:: delete_collection(**kwargs)

    

    Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see  example1 .

     

    This operation requires permissions to perform the ``rekognition:DeleteCollection`` action.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteCollection>`_    


    **Request Syntax** 
    ::

      response = client.delete_collection(
          CollectionId='string'
      )
    :type CollectionId: string
    :param CollectionId: **[REQUIRED]** 

      ID of the collection to delete.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StatusCode': 123
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **StatusCode** *(integer) --* 

          HTTP status code that indicates the result of the operation.

          
    

    **Examples** 

    This operation deletes a Rekognition collection.
    ::

      response = client.delete_collection(
          CollectionId='myphotos',
      )
      
      print(response)

    
    Expected Output:
    ::

      {
          'StatusCode': 200,
          'ResponseMetadata': {
              '...': '...',
          },
      }

    

  .. py:method:: delete_faces(**kwargs)

    

    Deletes 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 perform the ``rekognition:DeleteFaces`` action.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DeleteFaces>`_    


    **Request Syntax** 
    ::

      response = client.delete_faces(
          CollectionId='string',
          FaceIds=[
              'string',
          ]
      )
    :type CollectionId: string
    :param CollectionId: **[REQUIRED]** 

      Collection from which to remove the specific faces.

      

    
    :type FaceIds: list
    :param FaceIds: **[REQUIRED]** 

      An array of face IDs to delete.

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'DeletedFaces': [
                'string',
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **DeletedFaces** *(list) --* 

          An array of strings (face IDs) of the faces that were deleted.

          
          

          - *(string) --* 
      
    

    **Examples** 

    This operation deletes one or more faces from a Rekognition collection.
    ::

      response = client.delete_faces(
          CollectionId='myphotos',
          FaceIds=[
              'ff43d742-0c13-5d16-a3e8-03d3f58e980b',
          ],
      )
      
      print(response)

    
    Expected Output:
    ::

      {
          'DeletedFaces': [
              'ff43d742-0c13-5d16-a3e8-03d3f58e980b',
          ],
          'ResponseMetadata': {
              '...': '...',
          },
      }

    

  .. py:method:: detect_faces(**kwargs)

    

    Detects faces within an image (JPEG or PNG) that is provided as input.

     

    For each face detected, the operation returns face details including a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, etc. 

     

    The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm may not detect the faces or might detect faces with lower confidence. 

     

    .. note::

       

      This is a stateless API operation. That is, the operation does not persist any data.

       

     

    For an example, see  get-started-exercise-detect-faces .

     

    This operation requires permissions to perform the ``rekognition:DetectFaces`` action. 

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectFaces>`_    


    **Request Syntax** 
    ::

      response = client.detect_faces(
          Image={
              'Bytes': b'bytes',
              'S3Object': {
                  'Bucket': 'string',
                  'Name': 'string',
                  'Version': 'string'
              }
          },
          Attributes=[
              'DEFAULT'|'ALL',
          ]
      )
    :type Image: dict
    :param Image: **[REQUIRED]** 

      The image in which you want to detect faces. You can specify a blob or an S3 object. 

      

    
      - **Bytes** *(bytes) --* 

        Blob of image bytes up to 5 MBs.

        

      
      - **S3Object** *(dict) --* 

        Identifies an S3 object as the image source.

        

      
        - **Bucket** *(string) --* 

          Name of the S3 bucket.

          

        
        - **Name** *(string) --* 

          S3 object key name.

          

        
        - **Version** *(string) --* 

          If the bucket is versioning enabled, you can specify the object version. 

          

        
      
    
    :type Attributes: list
    :param Attributes: 

      An array of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for ``Attributes`` or if you specify ``["DEFAULT"]`` , the API returns the following subset of facial attributes: ``BoundingBox`` , ``Confidence`` , ``Pose`` , ``Quality`` and ``Landmarks`` . If you provide ``["ALL"]`` , all facial attributes are returned but the operation will take longer to complete.

       

      If you provide both, ``["ALL", "DEFAULT"]`` , the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). 

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'FaceDetails': [
                {
                    'BoundingBox': {
                        'Width': ...,
                        'Height': ...,
                        'Left': ...,
                        'Top': ...
                    },
                    'AgeRange': {
                        'Low': 123,
                        'High': 123
                    },
                    'Smile': {
                        'Value': True|False,
                        'Confidence': ...
                    },
                    'Eyeglasses': {
                        'Value': True|False,
                        'Confidence': ...
                    },
                    'Sunglasses': {
                        'Value': True|False,
                        'Confidence': ...
                    },
                    'Gender': {
                        'Value': 'MALE'|'FEMALE',
                        'Confidence': ...
                    },
                    'Beard': {
                        'Value': True|False,
                        'Confidence': ...
                    },
                    'Mustache': {
                        'Value': True|False,
                        'Confidence': ...
                    },
                    'EyesOpen': {
                        'Value': True|False,
                        'Confidence': ...
                    },
                    'MouthOpen': {
                        'Value': True|False,
                        'Confidence': ...
                    },
                    'Emotions': [
                        {
                            'Type': 'HAPPY'|'SAD'|'ANGRY'|'CONFUSED'|'DISGUSTED'|'SURPRISED'|'CALM'|'UNKNOWN',
                            'Confidence': ...
                        },
                    ],
                    'Landmarks': [
                        {
                            'Type': 'EYE_LEFT'|'EYE_RIGHT'|'NOSE'|'MOUTH_LEFT'|'MOUTH_RIGHT'|'LEFT_EYEBROW_LEFT'|'LEFT_EYEBROW_RIGHT'|'LEFT_EYEBROW_UP'|'RIGHT_EYEBROW_LEFT'|'RIGHT_EYEBROW_RIGHT'|'RIGHT_EYEBROW_UP'|'LEFT_EYE_LEFT'|'LEFT_EYE_RIGHT'|'LEFT_EYE_UP'|'LEFT_EYE_DOWN'|'RIGHT_EYE_LEFT'|'RIGHT_EYE_RIGHT'|'RIGHT_EYE_UP'|'RIGHT_EYE_DOWN'|'NOSE_LEFT'|'NOSE_RIGHT'|'MOUTH_UP'|'MOUTH_DOWN'|'LEFT_PUPIL'|'RIGHT_PUPIL',
                            'X': ...,
                            'Y': ...
                        },
                    ],
                    'Pose': {
                        'Roll': ...,
                        'Yaw': ...,
                        'Pitch': ...
                    },
                    'Quality': {
                        'Brightness': ...,
                        'Sharpness': ...
                    },
                    'Confidence': ...
                },
            ],
            'OrientationCorrection': 'ROTATE_0'|'ROTATE_90'|'ROTATE_180'|'ROTATE_270'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **FaceDetails** *(list) --* 

          Details of each face found in the image. 

          
          

          - *(dict) --* 

            Structure containing attributes of the face that the algorithm detected.

            
            

            - **BoundingBox** *(dict) --* 

              Bounding box of the face.

              
              

              - **Width** *(float) --* 

                Width of the bounding box as a ratio of the overall image width.

                
              

              - **Height** *(float) --* 

                Height of the bounding box as a ratio of the overall image height.

                
              

              - **Left** *(float) --* 

                Left coordinate of the bounding box as a ratio of overall image width.

                
              

              - **Top** *(float) --* 

                Top coordinate of the bounding box as a ratio of overall image height.

                
          
            

            - **AgeRange** *(dict) --* 

              The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

              
              

              - **Low** *(integer) --* 

                The lowest estimated age.

                
              

              - **High** *(integer) --* 

                The highest estimated age.

                
          
            

            - **Smile** *(dict) --* 

              Indicates whether or not the face is smiling, and the confidence level in the determination.

              
              

              - **Value** *(boolean) --* 

                Boolean value that indicates whether the face is smiling or not.

                
              

              - **Confidence** *(float) --* 

                Level of confidence in the determination.

                
          
            

            - **Eyeglasses** *(dict) --* 

              Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

              
              

              - **Value** *(boolean) --* 

                Boolean value that indicates whether the face is wearing eye glasses or not.

                
              

              - **Confidence** *(float) --* 

                Level of confidence in the determination.

                
          
            

            - **Sunglasses** *(dict) --* 

              Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

              
              

              - **Value** *(boolean) --* 

                Boolean value that indicates whether the face is wearing sunglasses or not.

                
              

              - **Confidence** *(float) --* 

                Level of confidence in the determination.

                
          
            

            - **Gender** *(dict) --* 

              Gender of the face and the confidence level in the determination.

              
              

              - **Value** *(string) --* 

                Gender of the face.

                
              

              - **Confidence** *(float) --* 

                Level of confidence in the determination.

                
          
            

            - **Beard** *(dict) --* 

              Indicates whether or not the face has a beard, and the confidence level in the determination.

              
              

              - **Value** *(boolean) --* 

                Boolean value that indicates whether the face has beard or not.

                
              

              - **Confidence** *(float) --* 

                Level of confidence in the determination.

                
          
            

            - **Mustache** *(dict) --* 

              Indicates whether or not the face has a mustache, and the confidence level in the determination.

              
              

              - **Value** *(boolean) --* 

                Boolean value that indicates whether the face has mustache or not.

                
              

              - **Confidence** *(float) --* 

                Level of confidence in the determination.

                
          
            

            - **EyesOpen** *(dict) --* 

              Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

              
              

              - **Value** *(boolean) --* 

                Boolean value that indicates whether the eyes on the face are open.

                
              

              - **Confidence** *(float) --* 

                Level of confidence in the determination.

                
          
            

            - **MouthOpen** *(dict) --* 

              Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

              
              

              - **Value** *(boolean) --* 

                Boolean value that indicates whether the mouth on the face is open or not.

                
              

              - **Confidence** *(float) --* 

                Level of confidence in the determination.

                
          
            

            - **Emotions** *(list) --* 

              The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY. 

              
              

              - *(dict) --* 

                The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

                
                

                - **Type** *(string) --* 

                  Type of emotion detected.

                  
                

                - **Confidence** *(float) --* 

                  Level of confidence in the determination.

                  
            
          
            

            - **Landmarks** *(list) --* 

              Indicates the location of landmarks on the face.

              
              

              - *(dict) --* 

                Indicates the location of the landmark on the face.

                
                

                - **Type** *(string) --* 

                  Type of the landmark.

                  
                

                - **X** *(float) --* 

                  x-coordinate from the top left of the landmark expressed as the ration of the width of the image. For example, if the images is 700x200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5. 

                  
                

                - **Y** *(float) --* 

                  y-coordinate from the top left of the landmark expressed as the ration of the height of the image. For example, if the images is 700x200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

                  
            
          
            

            - **Pose** *(dict) --* 

              Indicates the pose of the face as determined by its pitch, roll, and yaw.

              
              

              - **Roll** *(float) --* 

                Value representing the face rotation on the roll axis.

                
              

              - **Yaw** *(float) --* 

                Value representing the face rotation on the yaw axis.

                
              

              - **Pitch** *(float) --* 

                Value representing the face rotation on the pitch axis.

                
          
            

            - **Quality** *(dict) --* 

              Identifies image brightness and sharpness.

              
              

              - **Brightness** *(float) --* 

                Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

                
              

              - **Sharpness** *(float) --* 

                Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

                
          
            

            - **Confidence** *(float) --* 

              Confidence level that the bounding box contains a face (and not a different object such as a tree).

              
        
      
        

        - **OrientationCorrection** *(string) --* 

          The orientation of the input image (counter-clockwise direction). If your application displays the image, you can use this value to correct image orientation. The bounding box coordinates returned in ``FaceDetails`` represent face locations before the image orientation is corrected. 

           

          .. note::

             

            If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of ``OrientationCorrection`` is null and the ``FaceDetails`` bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

             

          
    

    **Examples** 

    This operation detects faces in an image stored in an AWS S3 bucket.
    ::

      response = client.detect_faces(
          Image={
              'S3Object': {
                  'Bucket': 'mybucket',
                  'Name': 'myphoto',
              },
          },
      )
      
      print(response)

    
    Expected Output:
    ::

      {
          'FaceDetails': [
              {
                  'BoundingBox': {
                      'Height': 0.180000007153,
                      'Left': 0.555555582047,
                      'Top': 0.336666673422,
                      'Width': 0.239999994636,
                  },
                  'Confidence': 100,
                  'Landmarks': [
                      {
                          'Type': 'EYE_LEFT',
                          'X': 0.639473736286,
                          'Y': 0.408196240664,
                      },
                      {
                          'Type': 'EYE_RIGHT',
                          'X': 0.726666092873,
                          'Y': 0.410392254591,
                      },
                      {
                          'Type': 'NOSE_LEFT',
                          'X': 0.691246211529,
                          'Y': 0.442409604788,
                      },
                      {
                          'Type': 'MOUTH_DOWN',
                          'X': 0.630619823933,
                          'Y': 0.46700039506,
                      },
                      {
                          'Type': 'MOUTH_UP',
                          'X': 0.721560895443,
                          'Y': 0.471142619848,
                      },
                  ],
                  'Pose': {
                      'Pitch': 4.05080652237,
                      'Roll': 0.995074748993,
                      'Yaw': 13.6937904358,
                  },
                  'Quality': {
                      'Brightness': 37.6016998291,
                      'Sharpness': 80,
                  },
              },
          ],
          'OrientationCorrection': 'ROTATE_0',
          'ResponseMetadata': {
              '...': '...',
          },
      }

    

  .. py:method:: detect_labels(**kwargs)

    

    Detects instances of real-world labels within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see  get-started-exercise-detect-labels .

     

    For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response will include all three labels, one for each object. 

     

     ``{Name: lighthouse, Confidence: 98.4629}``  

     

     ``{Name: rock,Confidence: 79.2097}``  

     

     ``{Name: sea,Confidence: 75.061}``  

     

    In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels. 

     

     ``{Name: flower,Confidence: 99.0562}``  

     

     ``{Name: plant,Confidence: 99.0562}``  

     

     ``{Name: tulip,Confidence: 99.0562}``  

     

    In this example, the detection algorithm more precisely identifies the flower as a tulip.

     

    You can provide the input image as an S3 object or as base64-encoded bytes. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify ``MinConfidence`` to control the confidence threshold for the labels returned. The default is 50%. You can also add the ``MaxLabels`` parameter to limit the number of labels returned. 

     

    .. note::

       

      If the object detected is a person, the operation doesn't provide the same facial details that the  DetectFaces operation provides.

       

     

    This is a stateless API operation. That is, the operation does not persist any data.

     

    This operation requires permissions to perform the ``rekognition:DetectLabels`` action. 

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectLabels>`_    


    **Request Syntax** 
    ::

      response = client.detect_labels(
          Image={
              'Bytes': b'bytes',
              'S3Object': {
                  'Bucket': 'string',
                  'Name': 'string',
                  'Version': 'string'
              }
          },
          MaxLabels=123,
          MinConfidence=...
      )
    :type Image: dict
    :param Image: **[REQUIRED]** 

      The input image. You can provide a blob of image bytes or an S3 object.

      

    
      - **Bytes** *(bytes) --* 

        Blob of image bytes up to 5 MBs.

        

      
      - **S3Object** *(dict) --* 

        Identifies an S3 object as the image source.

        

      
        - **Bucket** *(string) --* 

          Name of the S3 bucket.

          

        
        - **Name** *(string) --* 

          S3 object key name.

          

        
        - **Version** *(string) --* 

          If the bucket is versioning enabled, you can specify the object version. 

          

        
      
    
    :type MaxLabels: integer
    :param MaxLabels: 

      Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels. 

      

    
    :type MinConfidence: float
    :param MinConfidence: 

      Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

       

      If ``MinConfidence`` is not specified, the operation returns labels with a confidence values greater than or equal to 50 percent.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Labels': [
                {
                    'Name': 'string',
                    'Confidence': ...
                },
            ],
            'OrientationCorrection': 'ROTATE_0'|'ROTATE_90'|'ROTATE_180'|'ROTATE_270'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Labels** *(list) --* 

          An array of labels for the real-world objects detected. 

          
          

          - *(dict) --* 

            Structure containing details about the detected label, including name, and level of confidence.

            
            

            - **Name** *(string) --* 

              The name (label) of the object.

              
            

            - **Confidence** *(float) --* 

              Level of confidence.

              
        
      
        

        - **OrientationCorrection** *(string) --* 

          The orientation of the input image (counter-clockwise direction). If your application displays the image, you can use this value to correct the orientation. If Amazon Rekognition detects that the input image was rotated (for example, by 90 degrees), it first corrects the orientation before detecting the labels. 

           

          .. note::

             

            If the input image Exif metadata populates the orientation field, Amazon Rekognition does not perform orientation correction and the value of OrientationCorrection will be null.

             

          
    

    **Examples** 

    This operation detects labels in the supplied image
    ::

      response = client.detect_labels(
          Image={
              'S3Object': {
                  'Bucket': 'mybucket',
                  'Name': 'myphoto',
              },
          },
          MaxLabels=123,
          MinConfidence=70,
      )
      
      print(response)

    
    Expected Output:
    ::

      {
          'Labels': [
              {
                  'Confidence': 99.2507247925,
                  'Name': 'People',
              },
              {
                  'Confidence': 99.2507400513,
                  'Name': 'Person',
              },
          ],
          'ResponseMetadata': {
              '...': '...',
          },
      }

    

  .. py:method:: detect_moderation_labels(**kwargs)

    

    Detects explicit or suggestive adult content in a specified JPEG or PNG format image. Use ``DetectModerationLabels`` to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.

     

    To filter images, use the labels returned by ``DetectModerationLabels`` to determine which types of content are appropriate. For information about moderation labels, see  image-moderation .

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DetectModerationLabels>`_    


    **Request Syntax** 
    ::

      response = client.detect_moderation_labels(
          Image={
              'Bytes': b'bytes',
              'S3Object': {
                  'Bucket': 'string',
                  'Name': 'string',
                  'Version': 'string'
              }
          },
          MinConfidence=...
      )
    :type Image: dict
    :param Image: **[REQUIRED]** 

      The input image as bytes or an S3 object.

      

    
      - **Bytes** *(bytes) --* 

        Blob of image bytes up to 5 MBs.

        

      
      - **S3Object** *(dict) --* 

        Identifies an S3 object as the image source.

        

      
        - **Bucket** *(string) --* 

          Name of the S3 bucket.

          

        
        - **Name** *(string) --* 

          S3 object key name.

          

        
        - **Version** *(string) --* 

          If the bucket is versioning enabled, you can specify the object version. 

          

        
      
    
    :type MinConfidence: float
    :param MinConfidence: 

      Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.

       

      If you don't specify ``MinConfidence`` , the operation returns labels with confidence values greater than or equal to 50 percent.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'ModerationLabels': [
                {
                    'Confidence': ...,
                    'Name': 'string',
                    'ParentName': 'string'
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **ModerationLabels** *(list) --* 

          An array of labels for explicit or suggestive adult content found in the image. The list includes the top-level label and each child label detected in the image. This is useful for filtering specific categories of content. 

          
          

          - *(dict) --* 

            Provides information about a single type of moderated content found in an image. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see  image-moderation .

            
            

            - **Confidence** *(float) --* 

              Specifies the confidence that Amazon Rekognition has that the label has been correctly identified.

               

              If you don't specify the ``MinConfidence`` parameter in the call to ``DetectModerationLabels`` , the operation returns labels with a confidence value greater than or equal to 50 percent.

              
            

            - **Name** *(string) --* 

              The label name for the type of content detected in the image.

              
            

            - **ParentName** *(string) --* 

              The name for the parent label. Labels at the top-level of the hierarchy have the parent label ``""`` .

              
        
      
    

  .. py:method:: generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

        
    Generate a presigned url given a client, its method, and arguments
    
    :type ClientMethod: string
    :param ClientMethod: The client method to presign for
    
    :type Params: dict
    :param Params: The parameters normally passed to
        ``ClientMethod``.
    
    :type ExpiresIn: int
    :param ExpiresIn: The number of seconds the presigned url is valid
        for. By default it expires in an hour (3600 seconds)
    
    :type HttpMethod: string
    :param HttpMethod: The http method to use on the generated url. By
        default, the http method is whatever is used in the method's model.
    
    :returns: The presigned url


  .. py:method:: get_celebrity_info(**kwargs)

    

    Gets the name and additional information about a celebrity based on his or her Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty. For more information, see  celebrity-recognition .

     

    This operation requires permissions to perform the ``rekognition:GetCelebrityInfo`` action. 

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/GetCelebrityInfo>`_    


    **Request Syntax** 
    ::

      response = client.get_celebrity_info(
          Id='string'
      )
    :type Id: string
    :param Id: **[REQUIRED]** 

      The ID for the celebrity. You get the celebrity ID from a call to the operation, which recognizes celebrities in an image. 

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Urls': [
                'string',
            ],
            'Name': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Urls** *(list) --* 

          An array of URLs pointing to additional celebrity information. 

          
          

          - *(string) --* 
      
        

        - **Name** *(string) --* 

          The name of the celebrity.

          
    

  .. py:method:: get_paginator(operation_name)

        
    Create a paginator for an operation.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :raise OperationNotPageableError: Raised if the operation is not
        pageable.  You can use the ``client.can_paginate`` method to
        check if an operation is pageable.
    
    :rtype: L{botocore.paginate.Paginator}
    :return: A paginator object.


  .. py:method:: get_waiter(waiter_name)

        


  .. py:method:: index_faces(**kwargs)

    

    Detects faces in the input image and adds them to the specified collection. 

     

    Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations. 

     

    If you provide the optional ``externalImageID`` for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image. 

     

    In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image. If you request all facial attributes (using the ``detectionAttributes`` parameter, Amazon Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mount) and other facial attributes such gender. If you provide the same image, specify the same collection, and use the same external ID in the ``IndexFaces`` operation, Amazon Rekognition doesn't save duplicate face metadata. 

     

    For an example, see  example2 .

     

    This operation requires permissions to perform the ``rekognition:IndexFaces`` action.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/IndexFaces>`_    


    **Request Syntax** 
    ::

      response = client.index_faces(
          CollectionId='string',
          Image={
              'Bytes': b'bytes',
              'S3Object': {
                  'Bucket': 'string',
                  'Name': 'string',
                  'Version': 'string'
              }
          },
          ExternalImageId='string',
          DetectionAttributes=[
              'DEFAULT'|'ALL',
          ]
      )
    :type CollectionId: string
    :param CollectionId: **[REQUIRED]** 

      The ID of an existing collection to which you want to add the faces that are detected in the input images.

      

    
    :type Image: dict
    :param Image: **[REQUIRED]** 

      The input image as bytes or an S3 object.

      

    
      - **Bytes** *(bytes) --* 

        Blob of image bytes up to 5 MBs.

        

      
      - **S3Object** *(dict) --* 

        Identifies an S3 object as the image source.

        

      
        - **Bucket** *(string) --* 

          Name of the S3 bucket.

          

        
        - **Name** *(string) --* 

          S3 object key name.

          

        
        - **Version** *(string) --* 

          If the bucket is versioning enabled, you can specify the object version. 

          

        
      
    
    :type ExternalImageId: string
    :param ExternalImageId: 

      ID you want to assign to all the faces detected in the image.

      

    
    :type DetectionAttributes: list
    :param DetectionAttributes: 

      An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for ``Attributes`` or if you specify ``["DEFAULT"]`` , the API returns the following subset of facial attributes: ``BoundingBox`` , ``Confidence`` , ``Pose`` , ``Quality`` and ``Landmarks`` . If you provide ``["ALL"]`` , all facial attributes are returned but the operation will take longer to complete.

       

      If you provide both, ``["ALL", "DEFAULT"]`` , the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). 

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'FaceRecords': [
                {
                    'Face': {
                        'FaceId': 'string',
                        'BoundingBox': {
                            'Width': ...,
                            'Height': ...,
                            'Left': ...,
                            'Top': ...
                        },
                        'ImageId': 'string',
                        'ExternalImageId': 'string',
                        'Confidence': ...
                    },
                    'FaceDetail': {
                        'BoundingBox': {
                            'Width': ...,
                            'Height': ...,
                            'Left': ...,
                            'Top': ...
                        },
                        'AgeRange': {
                            'Low': 123,
                            'High': 123
                        },
                        'Smile': {
                            'Value': True|False,
                            'Confidence': ...
                        },
                        'Eyeglasses': {
                            'Value': True|False,
                            'Confidence': ...
                        },
                        'Sunglasses': {
                            'Value': True|False,
                            'Confidence': ...
                        },
                        'Gender': {
                            'Value': 'MALE'|'FEMALE',
                            'Confidence': ...
                        },
                        'Beard': {
                            'Value': True|False,
                            'Confidence': ...
                        },
                        'Mustache': {
                            'Value': True|False,
                            'Confidence': ...
                        },
                        'EyesOpen': {
                            'Value': True|False,
                            'Confidence': ...
                        },
                        'MouthOpen': {
                            'Value': True|False,
                            'Confidence': ...
                        },
                        'Emotions': [
                            {
                                'Type': 'HAPPY'|'SAD'|'ANGRY'|'CONFUSED'|'DISGUSTED'|'SURPRISED'|'CALM'|'UNKNOWN',
                                'Confidence': ...
                            },
                        ],
                        'Landmarks': [
                            {
                                'Type': 'EYE_LEFT'|'EYE_RIGHT'|'NOSE'|'MOUTH_LEFT'|'MOUTH_RIGHT'|'LEFT_EYEBROW_LEFT'|'LEFT_EYEBROW_RIGHT'|'LEFT_EYEBROW_UP'|'RIGHT_EYEBROW_LEFT'|'RIGHT_EYEBROW_RIGHT'|'RIGHT_EYEBROW_UP'|'LEFT_EYE_LEFT'|'LEFT_EYE_RIGHT'|'LEFT_EYE_UP'|'LEFT_EYE_DOWN'|'RIGHT_EYE_LEFT'|'RIGHT_EYE_RIGHT'|'RIGHT_EYE_UP'|'RIGHT_EYE_DOWN'|'NOSE_LEFT'|'NOSE_RIGHT'|'MOUTH_UP'|'MOUTH_DOWN'|'LEFT_PUPIL'|'RIGHT_PUPIL',
                                'X': ...,
                                'Y': ...
                            },
                        ],
                        'Pose': {
                            'Roll': ...,
                            'Yaw': ...,
                            'Pitch': ...
                        },
                        'Quality': {
                            'Brightness': ...,
                            'Sharpness': ...
                        },
                        'Confidence': ...
                    }
                },
            ],
            'OrientationCorrection': 'ROTATE_0'|'ROTATE_90'|'ROTATE_180'|'ROTATE_270'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **FaceRecords** *(list) --* 

          An array of faces detected and added to the collection. For more information, see  howitworks-index-faces . 

          
          

          - *(dict) --* 

            Object containing both the face metadata (stored in the back-end database) and facial attributes that are detected but aren't stored in the database.

            
            

            - **Face** *(dict) --* 

              Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned. 

              
              

              - **FaceId** *(string) --* 

                Unique identifier that Amazon Rekognition assigns to the face.

                
              

              - **BoundingBox** *(dict) --* 

                Bounding box of the face.

                
                

                - **Width** *(float) --* 

                  Width of the bounding box as a ratio of the overall image width.

                  
                

                - **Height** *(float) --* 

                  Height of the bounding box as a ratio of the overall image height.

                  
                

                - **Left** *(float) --* 

                  Left coordinate of the bounding box as a ratio of overall image width.

                  
                

                - **Top** *(float) --* 

                  Top coordinate of the bounding box as a ratio of overall image height.

                  
            
              

              - **ImageId** *(string) --* 

                Unique identifier that Amazon Rekognition assigns to the input image.

                
              

              - **ExternalImageId** *(string) --* 

                Identifier that you assign to all the faces in the input image.

                
              

              - **Confidence** *(float) --* 

                Confidence level that the bounding box contains a face (and not a different object such as a tree).

                
          
            

            - **FaceDetail** *(dict) --* 

              Structure containing attributes of the face that the algorithm detected.

              
              

              - **BoundingBox** *(dict) --* 

                Bounding box of the face.

                
                

                - **Width** *(float) --* 

                  Width of the bounding box as a ratio of the overall image width.

                  
                

                - **Height** *(float) --* 

                  Height of the bounding box as a ratio of the overall image height.

                  
                

                - **Left** *(float) --* 

                  Left coordinate of the bounding box as a ratio of overall image width.

                  
                

                - **Top** *(float) --* 

                  Top coordinate of the bounding box as a ratio of overall image height.

                  
            
              

              - **AgeRange** *(dict) --* 

                The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

                
                

                - **Low** *(integer) --* 

                  The lowest estimated age.

                  
                

                - **High** *(integer) --* 

                  The highest estimated age.

                  
            
              

              - **Smile** *(dict) --* 

                Indicates whether or not the face is smiling, and the confidence level in the determination.

                
                

                - **Value** *(boolean) --* 

                  Boolean value that indicates whether the face is smiling or not.

                  
                

                - **Confidence** *(float) --* 

                  Level of confidence in the determination.

                  
            
              

              - **Eyeglasses** *(dict) --* 

                Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

                
                

                - **Value** *(boolean) --* 

                  Boolean value that indicates whether the face is wearing eye glasses or not.

                  
                

                - **Confidence** *(float) --* 

                  Level of confidence in the determination.

                  
            
              

              - **Sunglasses** *(dict) --* 

                Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

                
                

                - **Value** *(boolean) --* 

                  Boolean value that indicates whether the face is wearing sunglasses or not.

                  
                

                - **Confidence** *(float) --* 

                  Level of confidence in the determination.

                  
            
              

              - **Gender** *(dict) --* 

                Gender of the face and the confidence level in the determination.

                
                

                - **Value** *(string) --* 

                  Gender of the face.

                  
                

                - **Confidence** *(float) --* 

                  Level of confidence in the determination.

                  
            
              

              - **Beard** *(dict) --* 

                Indicates whether or not the face has a beard, and the confidence level in the determination.

                
                

                - **Value** *(boolean) --* 

                  Boolean value that indicates whether the face has beard or not.

                  
                

                - **Confidence** *(float) --* 

                  Level of confidence in the determination.

                  
            
              

              - **Mustache** *(dict) --* 

                Indicates whether or not the face has a mustache, and the confidence level in the determination.

                
                

                - **Value** *(boolean) --* 

                  Boolean value that indicates whether the face has mustache or not.

                  
                

                - **Confidence** *(float) --* 

                  Level of confidence in the determination.

                  
            
              

              - **EyesOpen** *(dict) --* 

                Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

                
                

                - **Value** *(boolean) --* 

                  Boolean value that indicates whether the eyes on the face are open.

                  
                

                - **Confidence** *(float) --* 

                  Level of confidence in the determination.

                  
            
              

              - **MouthOpen** *(dict) --* 

                Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

                
                

                - **Value** *(boolean) --* 

                  Boolean value that indicates whether the mouth on the face is open or not.

                  
                

                - **Confidence** *(float) --* 

                  Level of confidence in the determination.

                  
            
              

              - **Emotions** *(list) --* 

                The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY. 

                
                

                - *(dict) --* 

                  The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

                  
                  

                  - **Type** *(string) --* 

                    Type of emotion detected.

                    
                  

                  - **Confidence** *(float) --* 

                    Level of confidence in the determination.

                    
              
            
              

              - **Landmarks** *(list) --* 

                Indicates the location of landmarks on the face.

                
                

                - *(dict) --* 

                  Indicates the location of the landmark on the face.

                  
                  

                  - **Type** *(string) --* 

                    Type of the landmark.

                    
                  

                  - **X** *(float) --* 

                    x-coordinate from the top left of the landmark expressed as the ration of the width of the image. For example, if the images is 700x200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5. 

                    
                  

                  - **Y** *(float) --* 

                    y-coordinate from the top left of the landmark expressed as the ration of the height of the image. For example, if the images is 700x200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

                    
              
            
              

              - **Pose** *(dict) --* 

                Indicates the pose of the face as determined by its pitch, roll, and yaw.

                
                

                - **Roll** *(float) --* 

                  Value representing the face rotation on the roll axis.

                  
                

                - **Yaw** *(float) --* 

                  Value representing the face rotation on the yaw axis.

                  
                

                - **Pitch** *(float) --* 

                  Value representing the face rotation on the pitch axis.

                  
            
              

              - **Quality** *(dict) --* 

                Identifies image brightness and sharpness.

                
                

                - **Brightness** *(float) --* 

                  Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

                  
                

                - **Sharpness** *(float) --* 

                  Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

                  
            
              

              - **Confidence** *(float) --* 

                Confidence level that the bounding box contains a face (and not a different object such as a tree).

                
          
        
      
        

        - **OrientationCorrection** *(string) --* 

          The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct image orientation. The bounding box coordinates returned in ``FaceRecords`` represent face locations before the image orientation is corrected. 

           

          .. note::

             

            If the input image is in jpeg format, it might contain exchangeable image (Exif) metadata. If so, and the Exif metadata populates the orientation field, the value of ``OrientationCorrection`` is null and the bounding box coordinates in ``FaceRecords`` represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

             

          
    

    **Examples** 

    This operation detects faces in an image and adds them to the specified Rekognition collection.
    ::

      response = client.index_faces(
          CollectionId='myphotos',
          DetectionAttributes=[
          ],
          ExternalImageId='myphotoid',
          Image={
              'S3Object': {
                  'Bucket': 'mybucket',
                  'Name': 'myphoto',
              },
          },
      )
      
      print(response)

    
    Expected Output:
    ::

      {
          'FaceRecords': [
              {
                  'Face': {
                      'BoundingBox': {
                          'Height': 0.334814816713,
                          'Left': 0.318888902664,
                          'Top': 0.493333339691,
                          'Width': 0.25,
                      },
                      'Confidence': 99.9991226196,
                      'FaceId': 'ff43d742-0c13-5d16-a3e8-03d3f58e980b',
                      'ImageId': '465f4e93-763e-51d0-b030-b9667a2d94b1',
                  },
                  'FaceDetail': {
                      'BoundingBox': {
                          'Height': 0.334814816713,
                          'Left': 0.318888902664,
                          'Top': 0.493333339691,
                          'Width': 0.25,
                      },
                      'Confidence': 99.9991226196,
                      'Landmarks': [
                          {
                              'Type': 'EYE_LEFT',
                              'X': 0.397676467896,
                              'Y': 0.624834597111,
                          },
                          {
                              'Type': 'EYE_RIGHT',
                              'X': 0.481093645096,
                              'Y': 0.63171172142,
                          },
                          {
                              'Type': 'NOSE_LEFT',
                              'X': 0.419862389565,
                              'Y': 0.711194038391,
                          },
                          {
                              'Type': 'MOUTH_DOWN',
                              'X': 0.405253022909,
                              'Y': 0.749770104885,
                          },
                          {
                              'Type': 'MOUTH_UP',
                              'X': 0.475324898958,
                              'Y': 0.755854964256,
                          },
                      ],
                      'Pose': {
                          'Pitch': -9.71364593506,
                          'Roll': 4.70728111267,
                          'Yaw': -24.4386634827,
                      },
                      'Quality': {
                          'Brightness': 29.2335891724,
                          'Sharpness': 80,
                      },
                  },
              },
              {
                  'Face': {
                      'BoundingBox': {
                          'Height': 0.325925916433,
                          'Left': 0.514444470406,
                          'Top': 0.151111111045,
                          'Width': 0.244444444776,
                      },
                      'Confidence': 99.9995040894,
                      'FaceId': '8be04dba-4e58-520d-850e-9eae4af70eb2',
                      'ImageId': '465f4e93-763e-51d0-b030-b9667a2d94b1',
                  },
                  'FaceDetail': {
                      'BoundingBox': {
                          'Height': 0.325925916433,
                          'Left': 0.514444470406,
                          'Top': 0.151111111045,
                          'Width': 0.244444444776,
                      },
                      'Confidence': 99.9995040894,
                      'Landmarks': [
                          {
                              'Type': 'EYE_LEFT',
                              'X': 0.600689232349,
                              'Y': 0.290842205286,
                          },
                          {
                              'Type': 'EYE_RIGHT',
                              'X': 0.680814146996,
                              'Y': 0.296090424061,
                          },
                          {
                              'Type': 'NOSE_LEFT',
                              'X': 0.639533221722,
                              'Y': 0.352259576321,
                          },
                          {
                              'Type': 'MOUTH_DOWN',
                              'X': 0.589208304882,
                              'Y': 0.386898875237,
                          },
                          {
                              'Type': 'MOUTH_UP',
                              'X': 0.674560010433,
                              'Y': 0.394125759602,
                          },
                      ],
                      'Pose': {
                          'Pitch': -4.68313837051,
                          'Roll': 2.10295295715,
                          'Yaw': 6.71665525436,
                      },
                      'Quality': {
                          'Brightness': 34.9516983032,
                          'Sharpness': 160,
                      },
                  },
              },
          ],
          'OrientationCorrection': 'ROTATE_0',
          'ResponseMetadata': {
              '...': '...',
          },
      }

    

  .. py:method:: list_collections(**kwargs)

    

    Returns 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 to fetch the next set of collection IDs.

     

    For an example, see  example1 .

     

    This operation requires permissions to perform the ``rekognition:ListCollections`` action.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListCollections>`_    


    **Request Syntax** 
    ::

      response = client.list_collections(
          NextToken='string',
          MaxResults=123
      )
    :type NextToken: string
    :param NextToken: 

      Pagination token from the previous response.

      

    
    :type MaxResults: integer
    :param MaxResults: 

      Maximum number of collection IDs to return.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CollectionIds': [
                'string',
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **CollectionIds** *(list) --* 

          An array of collection IDs.

          
          

          - *(string) --* 
      
        

        - **NextToken** *(string) --* 

          If the result is truncated, the response provides a ``NextToken`` that you can use in the subsequent request to fetch the next set of collection IDs.

          
    

    **Examples** 

    This operation returns a list of Rekognition collections.
    ::

      response = client.list_collections(
      )
      
      print(response)

    
    Expected Output:
    ::

      {
          'CollectionIds': [
              'myphotos',
          ],
          'ResponseMetadata': {
              '...': '...',
          },
      }

    

  .. py:method:: list_faces(**kwargs)

    

    Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see  example3 . 

     

    This operation requires permissions to perform the ``rekognition:ListFaces`` action.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListFaces>`_    


    **Request Syntax** 
    ::

      response = client.list_faces(
          CollectionId='string',
          NextToken='string',
          MaxResults=123
      )
    :type CollectionId: string
    :param CollectionId: **[REQUIRED]** 

      ID of the collection from which to list the faces.

      

    
    :type NextToken: string
    :param NextToken: 

      If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

      

    
    :type MaxResults: integer
    :param MaxResults: 

      Maximum number of faces to return.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Faces': [
                {
                    'FaceId': 'string',
                    'BoundingBox': {
                        'Width': ...,
                        'Height': ...,
                        'Left': ...,
                        'Top': ...
                    },
                    'ImageId': 'string',
                    'ExternalImageId': 'string',
                    'Confidence': ...
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Faces** *(list) --* 

          An array of ``Face`` objects. 

          
          

          - *(dict) --* 

            Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned. 

            
            

            - **FaceId** *(string) --* 

              Unique identifier that Amazon Rekognition assigns to the face.

              
            

            - **BoundingBox** *(dict) --* 

              Bounding box of the face.

              
              

              - **Width** *(float) --* 

                Width of the bounding box as a ratio of the overall image width.

                
              

              - **Height** *(float) --* 

                Height of the bounding box as a ratio of the overall image height.

                
              

              - **Left** *(float) --* 

                Left coordinate of the bounding box as a ratio of overall image width.

                
              

              - **Top** *(float) --* 

                Top coordinate of the bounding box as a ratio of overall image height.

                
          
            

            - **ImageId** *(string) --* 

              Unique identifier that Amazon Rekognition assigns to the input image.

              
            

            - **ExternalImageId** *(string) --* 

              Identifier that you assign to all the faces in the input image.

              
            

            - **Confidence** *(float) --* 

              Confidence level that the bounding box contains a face (and not a different object such as a tree).

              
        
      
        

        - **NextToken** *(string) --* 

          If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

          
    

    **Examples** 

    This operation lists the faces in a Rekognition collection.
    ::

      response = client.list_faces(
          CollectionId='myphotos',
          MaxResults=20,
      )
      
      print(response)

    
    Expected Output:
    ::

      {
          'Faces': [
              {
                  'BoundingBox': {
                      'Height': 0.180000007153,
                      'Left': 0.555555999279,
                      'Top': 0.336667001247,
                      'Width': 0.239999994636,
                  },
                  'Confidence': 100,
                  'FaceId': '1c62e8b5-69a7-5b7d-b3cd-db4338a8a7e7',
                  'ImageId': '147fdf82-7a71-52cf-819b-e786c7b9746e',
              },
              {
                  'BoundingBox': {
                      'Height': 0.165555998683,
                      'Left': 0.309630006552,
                      'Top': 0.706667006016,
                      'Width': 0.220741003752,
                  },
                  'Confidence': 100,
                  'FaceId': '29a75abe-397b-5101-ba4f-706783b2246c',
                  'ImageId': '147fdf82-7a71-52cf-819b-e786c7b9746e',
              },
              {
                  'BoundingBox': {
                      'Height': 0.323442012072,
                      'Left': 0.323332995176,
                      'Top': 0.5,
                      'Width': 0.242221996188,
                  },
                  'Confidence': 99.998298645,
                  'FaceId': '38271d79-7bc2-5efb-b752-398a8d575b85',
                  'ImageId': 'd5631190-d039-54e4-b267-abd22c8647c5',
              },
              {
                  'BoundingBox': {
                      'Height': 0.03555560112,
                      'Left': 0.373887002468,
                      'Top': 0.247777998447,
                      'Width': 0.0474776998162,
                  },
                  'Confidence': 99.9921035767,
                  'FaceId': '3b01bef0-c883-5654-ba42-d5ad28b720b3',
                  'ImageId': '812d9f04-86f9-54fc-9275-8d0dcbcb6784',
              },
              {
                  'BoundingBox': {
                      'Height': 0.0533333010972,
                      'Left': 0.293769001961,
                      'Top': 0.356667011976,
                      'Width': 0.0712165981531,
                  },
                  'Confidence': 99.9991989136,
                  'FaceId': '4839a608-49d0-566c-8301-509d71b534d1',
                  'ImageId': '812d9f04-86f9-54fc-9275-8d0dcbcb6784',
              },
              {
                  'BoundingBox': {
                      'Height': 0.324925988913,
                      'Left': 0.515555977821,
                      'Top': 0.151335000992,
                      'Width': 0.243332996964,
                  },
                  'Confidence': 99.99949646,
                  'FaceId': '70008e50-75e4-55d0-8e80-363fb73b3a14',
                  'ImageId': 'd5631190-d039-54e4-b267-abd22c8647c5',
              },
              {
                  'BoundingBox': {
                      'Height': 0.037777800113,
                      'Left': 0.700296998024,
                      'Top': 0.187777996063,
                      'Width': 0.0504450984299,
                  },
                  'Confidence': 99.926399231,
                  'FaceId': '7f5f88ed-d684-5a88-b0df-01e4a521552b',
                  'ImageId': '812d9f04-86f9-54fc-9275-8d0dcbcb6784',
              },
              {
                  'BoundingBox': {
                      'Height': 0.055555600673,
                      'Left': 0.139466002584,
                      'Top': 0.463333010674,
                      'Width': 0.0727002993226,
                  },
                  'Confidence': 99.9946975708,
                  'FaceId': '895b4e2c-81de-5902-a4bd-d1792bda00b2',
                  'ImageId': '812d9f04-86f9-54fc-9275-8d0dcbcb6784',
              },
              {
                  'BoundingBox': {
                      'Height': 0.32592600584,
                      'Left': 0.514443993568,
                      'Top': 0.151111006737,
                      'Width': 0.244443997741,
                  },
                  'Confidence': 99.99949646,
                  'FaceId': '8be04dba-4e58-520d-850e-9eae4af70eb2',
                  'ImageId': '465f4e93-763e-51d0-b030-b9667a2d94b1',
              },
              {
                  'BoundingBox': {
                      'Height': 0.18888899684,
                      'Left': 0.378338009119,
                      'Top': 0.235556006432,
                      'Width': 0.252225995064,
                  },
                  'Confidence': 99.9999008179,
                  'FaceId': '908544ad-edc3-59df-8faf-6a87cc256cf5',
                  'ImageId': '3c731605-d772-541a-a5e7-0375dbc68a07',
              },
              {
                  'BoundingBox': {
                      'Height': 0.334814995527,
                      'Left': 0.318888992071,
                      'Top': 0.493333011866,
                      'Width': 0.25,
                  },
                  'Confidence': 99.9990997314,
                  'FaceId': 'ff43d742-0c13-5d16-a3e8-03d3f58e980b',
                  'ImageId': '465f4e93-763e-51d0-b030-b9667a2d94b1',
              },
          ],
          'ResponseMetadata': {
              '...': '...',
          },
      }

    

  .. py:method:: recognize_celebrities(**kwargs)

    

    Returns an array of celebrities recognized in the input image. The image is passed either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPEG formatted file. For more information, see  celebrity-recognition . 

     

     ``RecognizeCelebrities`` returns the 15 largest faces in the image. It lists recognized celebrities in the ``CelebrityFaces`` list and unrecognized faces in the ``UnrecognizedFaces`` list. The operation doesn't return celebrities whose face sizes are smaller than the largest 15 faces in the image.

     

    For each celebrity recognized, the API returns a ``Celebrity`` object. The ``Celebrity`` object contains the celebrity name, ID, URL links to additional information, match confidence, and a ``ComparedFace`` object that you can use to locate the celebrity's face on the image.

     

    Rekognition does not retain information about which images a celebrity has been recognized in. Your application must store this information and use the ``Celebrity`` ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by ``RecognizeCelebrities`` , you will need the ID to identify the celebrity in a call to the operation.

     

    For an example, see  recognize-celebrities-tutorial .

     

    This operation requires permissions to perform the ``rekognition:RecognizeCelebrities`` operation.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/RecognizeCelebrities>`_    


    **Request Syntax** 
    ::

      response = client.recognize_celebrities(
          Image={
              'Bytes': b'bytes',
              'S3Object': {
                  'Bucket': 'string',
                  'Name': 'string',
                  'Version': 'string'
              }
          }
      )
    :type Image: dict
    :param Image: **[REQUIRED]** 

      The input image to use for celebrity recognition.

      

    
      - **Bytes** *(bytes) --* 

        Blob of image bytes up to 5 MBs.

        

      
      - **S3Object** *(dict) --* 

        Identifies an S3 object as the image source.

        

      
        - **Bucket** *(string) --* 

          Name of the S3 bucket.

          

        
        - **Name** *(string) --* 

          S3 object key name.

          

        
        - **Version** *(string) --* 

          If the bucket is versioning enabled, you can specify the object version. 

          

        
      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CelebrityFaces': [
                {
                    'Urls': [
                        'string',
                    ],
                    'Name': 'string',
                    'Id': 'string',
                    'Face': {
                        'BoundingBox': {
                            'Width': ...,
                            'Height': ...,
                            'Left': ...,
                            'Top': ...
                        },
                        'Confidence': ...,
                        'Landmarks': [
                            {
                                'Type': 'EYE_LEFT'|'EYE_RIGHT'|'NOSE'|'MOUTH_LEFT'|'MOUTH_RIGHT'|'LEFT_EYEBROW_LEFT'|'LEFT_EYEBROW_RIGHT'|'LEFT_EYEBROW_UP'|'RIGHT_EYEBROW_LEFT'|'RIGHT_EYEBROW_RIGHT'|'RIGHT_EYEBROW_UP'|'LEFT_EYE_LEFT'|'LEFT_EYE_RIGHT'|'LEFT_EYE_UP'|'LEFT_EYE_DOWN'|'RIGHT_EYE_LEFT'|'RIGHT_EYE_RIGHT'|'RIGHT_EYE_UP'|'RIGHT_EYE_DOWN'|'NOSE_LEFT'|'NOSE_RIGHT'|'MOUTH_UP'|'MOUTH_DOWN'|'LEFT_PUPIL'|'RIGHT_PUPIL',
                                'X': ...,
                                'Y': ...
                            },
                        ],
                        'Pose': {
                            'Roll': ...,
                            'Yaw': ...,
                            'Pitch': ...
                        },
                        'Quality': {
                            'Brightness': ...,
                            'Sharpness': ...
                        }
                    },
                    'MatchConfidence': ...
                },
            ],
            'UnrecognizedFaces': [
                {
                    'BoundingBox': {
                        'Width': ...,
                        'Height': ...,
                        'Left': ...,
                        'Top': ...
                    },
                    'Confidence': ...,
                    'Landmarks': [
                        {
                            'Type': 'EYE_LEFT'|'EYE_RIGHT'|'NOSE'|'MOUTH_LEFT'|'MOUTH_RIGHT'|'LEFT_EYEBROW_LEFT'|'LEFT_EYEBROW_RIGHT'|'LEFT_EYEBROW_UP'|'RIGHT_EYEBROW_LEFT'|'RIGHT_EYEBROW_RIGHT'|'RIGHT_EYEBROW_UP'|'LEFT_EYE_LEFT'|'LEFT_EYE_RIGHT'|'LEFT_EYE_UP'|'LEFT_EYE_DOWN'|'RIGHT_EYE_LEFT'|'RIGHT_EYE_RIGHT'|'RIGHT_EYE_UP'|'RIGHT_EYE_DOWN'|'NOSE_LEFT'|'NOSE_RIGHT'|'MOUTH_UP'|'MOUTH_DOWN'|'LEFT_PUPIL'|'RIGHT_PUPIL',
                            'X': ...,
                            'Y': ...
                        },
                    ],
                    'Pose': {
                        'Roll': ...,
                        'Yaw': ...,
                        'Pitch': ...
                    },
                    'Quality': {
                        'Brightness': ...,
                        'Sharpness': ...
                    }
                },
            ],
            'OrientationCorrection': 'ROTATE_0'|'ROTATE_90'|'ROTATE_180'|'ROTATE_270'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **CelebrityFaces** *(list) --* 

          Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 15 celebrities in an image.

          
          

          - *(dict) --* 

            Provides information about a celebrity recognized by the operation.

            
            

            - **Urls** *(list) --* 

              An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.

              
              

              - *(string) --* 
          
            

            - **Name** *(string) --* 

              The name of the celebrity.

              
            

            - **Id** *(string) --* 

              A unique identifier for the celebrity. 

              
            

            - **Face** *(dict) --* 

              Provides information about the celebrity's face, such as its location on the image.

              
              

              - **BoundingBox** *(dict) --* 

                Bounding box of the face.

                
                

                - **Width** *(float) --* 

                  Width of the bounding box as a ratio of the overall image width.

                  
                

                - **Height** *(float) --* 

                  Height of the bounding box as a ratio of the overall image height.

                  
                

                - **Left** *(float) --* 

                  Left coordinate of the bounding box as a ratio of overall image width.

                  
                

                - **Top** *(float) --* 

                  Top coordinate of the bounding box as a ratio of overall image height.

                  
            
              

              - **Confidence** *(float) --* 

                Level of confidence that what the bounding box contains is a face.

                
              

              - **Landmarks** *(list) --* 

                An array of facial landmarks.

                
                

                - *(dict) --* 

                  Indicates the location of the landmark on the face.

                  
                  

                  - **Type** *(string) --* 

                    Type of the landmark.

                    
                  

                  - **X** *(float) --* 

                    x-coordinate from the top left of the landmark expressed as the ration of the width of the image. For example, if the images is 700x200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5. 

                    
                  

                  - **Y** *(float) --* 

                    y-coordinate from the top left of the landmark expressed as the ration of the height of the image. For example, if the images is 700x200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

                    
              
            
              

              - **Pose** *(dict) --* 

                Indicates the pose of the face as determined by its pitch, roll, and yaw.

                
                

                - **Roll** *(float) --* 

                  Value representing the face rotation on the roll axis.

                  
                

                - **Yaw** *(float) --* 

                  Value representing the face rotation on the yaw axis.

                  
                

                - **Pitch** *(float) --* 

                  Value representing the face rotation on the pitch axis.

                  
            
              

              - **Quality** *(dict) --* 

                Identifies face image brightness and sharpness. 

                
                

                - **Brightness** *(float) --* 

                  Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

                  
                

                - **Sharpness** *(float) --* 

                  Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

                  
            
          
            

            - **MatchConfidence** *(float) --* 

              The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.

              
        
      
        

        - **UnrecognizedFaces** *(list) --* 

          Details about each unrecognized face in the image.

          
          

          - *(dict) --* 

            Provides face metadata for target image faces that are analysed by ``CompareFaces`` and ``RecognizeCelebrities`` .

            
            

            - **BoundingBox** *(dict) --* 

              Bounding box of the face.

              
              

              - **Width** *(float) --* 

                Width of the bounding box as a ratio of the overall image width.

                
              

              - **Height** *(float) --* 

                Height of the bounding box as a ratio of the overall image height.

                
              

              - **Left** *(float) --* 

                Left coordinate of the bounding box as a ratio of overall image width.

                
              

              - **Top** *(float) --* 

                Top coordinate of the bounding box as a ratio of overall image height.

                
          
            

            - **Confidence** *(float) --* 

              Level of confidence that what the bounding box contains is a face.

              
            

            - **Landmarks** *(list) --* 

              An array of facial landmarks.

              
              

              - *(dict) --* 

                Indicates the location of the landmark on the face.

                
                

                - **Type** *(string) --* 

                  Type of the landmark.

                  
                

                - **X** *(float) --* 

                  x-coordinate from the top left of the landmark expressed as the ration of the width of the image. For example, if the images is 700x200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5. 

                  
                

                - **Y** *(float) --* 

                  y-coordinate from the top left of the landmark expressed as the ration of the height of the image. For example, if the images is 700x200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

                  
            
          
            

            - **Pose** *(dict) --* 

              Indicates the pose of the face as determined by its pitch, roll, and yaw.

              
              

              - **Roll** *(float) --* 

                Value representing the face rotation on the roll axis.

                
              

              - **Yaw** *(float) --* 

                Value representing the face rotation on the yaw axis.

                
              

              - **Pitch** *(float) --* 

                Value representing the face rotation on the pitch axis.

                
          
            

            - **Quality** *(dict) --* 

              Identifies face image brightness and sharpness. 

              
              

              - **Brightness** *(float) --* 

                Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

                
              

              - **Sharpness** *(float) --* 

                Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

                
          
        
      
        

        - **OrientationCorrection** *(string) --* 

          The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in ``CelebrityFaces`` and ``UnrecognizedFaces`` represent face locations before the image orientation is corrected. 

           

          .. note::

             

            If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of ``OrientationCorrection`` is null and the ``CelebrityFaces`` and ``UnrecognizedFaces`` bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. 

             

          
    

  .. py:method:: search_faces(**kwargs)

    

    For 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 the  IndexFaces operation. The operation compares the features of the input face with faces in the specified collection. 

     

    .. note::

       

      You can also search faces without indexing faces by using the ``SearchFacesByImage`` operation.

       

     

    The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a ``confidence`` value for each face match, indicating the confidence that the specific face matches the input face. 

     

    For an example, see  example3 .

     

    This operation requires permissions to perform the ``rekognition:SearchFaces`` action.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchFaces>`_    


    **Request Syntax** 
    ::

      response = client.search_faces(
          CollectionId='string',
          FaceId='string',
          MaxFaces=123,
          FaceMatchThreshold=...
      )
    :type CollectionId: string
    :param CollectionId: **[REQUIRED]** 

      ID of the collection the face belongs to.

      

    
    :type FaceId: string
    :param FaceId: **[REQUIRED]** 

      ID of a face to find matches for in the collection.

      

    
    :type MaxFaces: integer
    :param MaxFaces: 

      Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

      

    
    :type FaceMatchThreshold: float
    :param FaceMatchThreshold: 

      Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'SearchedFaceId': 'string',
            'FaceMatches': [
                {
                    'Similarity': ...,
                    'Face': {
                        'FaceId': 'string',
                        'BoundingBox': {
                            'Width': ...,
                            'Height': ...,
                            'Left': ...,
                            'Top': ...
                        },
                        'ImageId': 'string',
                        'ExternalImageId': 'string',
                        'Confidence': ...
                    }
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **SearchedFaceId** *(string) --* 

          ID of the face that was searched for matches in a collection.

          
        

        - **FaceMatches** *(list) --* 

          An array of faces that matched the input face, along with the confidence in the match.

          
          

          - *(dict) --* 

            Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.

            
            

            - **Similarity** *(float) --* 

              Confidence in the match of this face with the input face.

              
            

            - **Face** *(dict) --* 

              Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.

              
              

              - **FaceId** *(string) --* 

                Unique identifier that Amazon Rekognition assigns to the face.

                
              

              - **BoundingBox** *(dict) --* 

                Bounding box of the face.

                
                

                - **Width** *(float) --* 

                  Width of the bounding box as a ratio of the overall image width.

                  
                

                - **Height** *(float) --* 

                  Height of the bounding box as a ratio of the overall image height.

                  
                

                - **Left** *(float) --* 

                  Left coordinate of the bounding box as a ratio of overall image width.

                  
                

                - **Top** *(float) --* 

                  Top coordinate of the bounding box as a ratio of overall image height.

                  
            
              

              - **ImageId** *(string) --* 

                Unique identifier that Amazon Rekognition assigns to the input image.

                
              

              - **ExternalImageId** *(string) --* 

                Identifier that you assign to all the faces in the input image.

                
              

              - **Confidence** *(float) --* 

                Confidence level that the bounding box contains a face (and not a different object such as a tree).

                
          
        
      
    

    **Examples** 

    This operation searches for matching faces in the collection the supplied face belongs to.
    ::

      response = client.search_faces(
          CollectionId='myphotos',
          FaceId='70008e50-75e4-55d0-8e80-363fb73b3a14',
          FaceMatchThreshold=90,
          MaxFaces=10,
      )
      
      print(response)

    
    Expected Output:
    ::

      {
          'FaceMatches': [
              {
                  'Face': {
                      'BoundingBox': {
                          'Height': 0.32592600584,
                          'Left': 0.514443993568,
                          'Top': 0.151111006737,
                          'Width': 0.244443997741,
                      },
                      'Confidence': 99.99949646,
                      'FaceId': '8be04dba-4e58-520d-850e-9eae4af70eb2',
                      'ImageId': '465f4e93-763e-51d0-b030-b9667a2d94b1',
                  },
                  'Similarity': 99.9722213745,
              },
              {
                  'Face': {
                      'BoundingBox': {
                          'Height': 0.165555998683,
                          'Left': 0.309630006552,
                          'Top': 0.706667006016,
                          'Width': 0.220741003752,
                      },
                      'Confidence': 100,
                      'FaceId': '29a75abe-397b-5101-ba4f-706783b2246c',
                      'ImageId': '147fdf82-7a71-52cf-819b-e786c7b9746e',
                  },
                  'Similarity': 97.0415496826,
              },
              {
                  'Face': {
                      'BoundingBox': {
                          'Height': 0.18888899684,
                          'Left': 0.378338009119,
                          'Top': 0.235556006432,
                          'Width': 0.252225995064,
                      },
                      'Confidence': 99.9999008179,
                      'FaceId': '908544ad-edc3-59df-8faf-6a87cc256cf5',
                      'ImageId': '3c731605-d772-541a-a5e7-0375dbc68a07',
                  },
                  'Similarity': 95.9452056885,
              },
          ],
          'SearchedFaceId': '70008e50-75e4-55d0-8e80-363fb73b3a14',
          'ResponseMetadata': {
              '...': '...',
          },
      }

    

  .. py:method:: search_faces_by_image(**kwargs)

    

    For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. 

     

    .. note::

       

      To search for all faces in an input image, you might first call the operation, and then use the face IDs returned in subsequent calls to the operation. 

       

      You can also call the ``DetectFaces`` operation and use the bounding boxes in the response to make face crops, which then you can pass in to the ``SearchFacesByImage`` operation. 

       

     

    The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a ``similarity`` indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. 

     

    For an example, see  example3 .

     

    This operation requires permissions to perform the ``rekognition:SearchFacesByImage`` action.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/SearchFacesByImage>`_    


    **Request Syntax** 
    ::

      response = client.search_faces_by_image(
          CollectionId='string',
          Image={
              'Bytes': b'bytes',
              'S3Object': {
                  'Bucket': 'string',
                  'Name': 'string',
                  'Version': 'string'
              }
          },
          MaxFaces=123,
          FaceMatchThreshold=...
      )
    :type CollectionId: string
    :param CollectionId: **[REQUIRED]** 

      ID of the collection to search.

      

    
    :type Image: dict
    :param Image: **[REQUIRED]** 

      The input image as bytes or an S3 object.

      

    
      - **Bytes** *(bytes) --* 

        Blob of image bytes up to 5 MBs.

        

      
      - **S3Object** *(dict) --* 

        Identifies an S3 object as the image source.

        

      
        - **Bucket** *(string) --* 

          Name of the S3 bucket.

          

        
        - **Name** *(string) --* 

          S3 object key name.

          

        
        - **Version** *(string) --* 

          If the bucket is versioning enabled, you can specify the object version. 

          

        
      
    
    :type MaxFaces: integer
    :param MaxFaces: 

      Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

      

    
    :type FaceMatchThreshold: float
    :param FaceMatchThreshold: 

      (Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'SearchedFaceBoundingBox': {
                'Width': ...,
                'Height': ...,
                'Left': ...,
                'Top': ...
            },
            'SearchedFaceConfidence': ...,
            'FaceMatches': [
                {
                    'Similarity': ...,
                    'Face': {
                        'FaceId': 'string',
                        'BoundingBox': {
                            'Width': ...,
                            'Height': ...,
                            'Left': ...,
                            'Top': ...
                        },
                        'ImageId': 'string',
                        'ExternalImageId': 'string',
                        'Confidence': ...
                    }
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **SearchedFaceBoundingBox** *(dict) --* 

          The bounding box around the face in the input image that Amazon Rekognition used for the search.

          
          

          - **Width** *(float) --* 

            Width of the bounding box as a ratio of the overall image width.

            
          

          - **Height** *(float) --* 

            Height of the bounding box as a ratio of the overall image height.

            
          

          - **Left** *(float) --* 

            Left coordinate of the bounding box as a ratio of overall image width.

            
          

          - **Top** *(float) --* 

            Top coordinate of the bounding box as a ratio of overall image height.

            
      
        

        - **SearchedFaceConfidence** *(float) --* 

          The level of confidence that the ``searchedFaceBoundingBox`` , contains a face.

          
        

        - **FaceMatches** *(list) --* 

          An array of faces that match the input face, along with the confidence in the match.

          
          

          - *(dict) --* 

            Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.

            
            

            - **Similarity** *(float) --* 

              Confidence in the match of this face with the input face.

              
            

            - **Face** *(dict) --* 

              Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.

              
              

              - **FaceId** *(string) --* 

                Unique identifier that Amazon Rekognition assigns to the face.

                
              

              - **BoundingBox** *(dict) --* 

                Bounding box of the face.

                
                

                - **Width** *(float) --* 

                  Width of the bounding box as a ratio of the overall image width.

                  
                

                - **Height** *(float) --* 

                  Height of the bounding box as a ratio of the overall image height.

                  
                

                - **Left** *(float) --* 

                  Left coordinate of the bounding box as a ratio of overall image width.

                  
                

                - **Top** *(float) --* 

                  Top coordinate of the bounding box as a ratio of overall image height.

                  
            
              

              - **ImageId** *(string) --* 

                Unique identifier that Amazon Rekognition assigns to the input image.

                
              

              - **ExternalImageId** *(string) --* 

                Identifier that you assign to all the faces in the input image.

                
              

              - **Confidence** *(float) --* 

                Confidence level that the bounding box contains a face (and not a different object such as a tree).

                
          
        
      
    

    **Examples** 

    This operation searches for faces in a Rekognition collection that match the largest face in an S3 bucket stored image.
    ::

      response = client.search_faces_by_image(
          CollectionId='myphotos',
          FaceMatchThreshold=95,
          Image={
              'S3Object': {
                  'Bucket': 'mybucket',
                  'Name': 'myphoto',
              },
          },
          MaxFaces=5,
      )
      
      print(response)

    
    Expected Output:
    ::

      {
          'FaceMatches': [
              {
                  'Face': {
                      'BoundingBox': {
                          'Height': 0.323442012072,
                          'Left': 0.323332995176,
                          'Top': 0.5,
                          'Width': 0.242221996188,
                      },
                      'Confidence': 99.998298645,
                      'FaceId': '38271d79-7bc2-5efb-b752-398a8d575b85',
                      'ImageId': 'd5631190-d039-54e4-b267-abd22c8647c5',
                  },
                  'Similarity': 99.9703674316,
              },
          ],
          'SearchedFaceBoundingBox': {
              'Height': 0.334814816713,
              'Left': 0.318888902664,
              'Top': 0.493333339691,
              'Width': 0.25,
          },
          'SearchedFaceConfidence': 99.9991226196,
          'ResponseMetadata': {
              '...': '...',
          },
      }

    

==========
Paginators
==========


The available paginators are:

* :py:class:`Rekognition.Paginator.ListCollections`


* :py:class:`Rekognition.Paginator.ListFaces`



.. py:class:: Rekognition.Paginator.ListCollections

  ::

    
    paginator = client.get_paginator('list_collections')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Rekognition.Client.list_collections`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListCollections>`_    


    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

        

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CollectionIds': [
                'string',
            ],
            
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **CollectionIds** *(list) --* 

          An array of collection IDs.

          
          

          - *(string) --* 
      
    

.. py:class:: Rekognition.Paginator.ListFaces

  ::

    
    paginator = client.get_paginator('list_faces')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Rekognition.Client.list_faces`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListFaces>`_    


    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          CollectionId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type CollectionId: string
    :param CollectionId: **[REQUIRED]** 

      ID of the collection from which to list the faces.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

        

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Faces': [
                {
                    'FaceId': 'string',
                    'BoundingBox': {
                        'Width': ...,
                        'Height': ...,
                        'Left': ...,
                        'Top': ...
                    },
                    'ImageId': 'string',
                    'ExternalImageId': 'string',
                    'Confidence': ...
                },
            ],
            
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **Faces** *(list) --* 

          An array of ``Face`` objects. 

          
          

          - *(dict) --* 

            Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned. 

            
            

            - **FaceId** *(string) --* 

              Unique identifier that Amazon Rekognition assigns to the face.

              
            

            - **BoundingBox** *(dict) --* 

              Bounding box of the face.

              
              

              - **Width** *(float) --* 

                Width of the bounding box as a ratio of the overall image width.

                
              

              - **Height** *(float) --* 

                Height of the bounding box as a ratio of the overall image height.

                
              

              - **Left** *(float) --* 

                Left coordinate of the bounding box as a ratio of overall image width.

                
              

              - **Top** *(float) --* 

                Top coordinate of the bounding box as a ratio of overall image height.

                
          
            

            - **ImageId** *(string) --* 

              Unique identifier that Amazon Rekognition assigns to the input image.

              
            

            - **ExternalImageId** *(string) --* 

              Identifier that you assign to all the faces in the input image.

              
            

            - **Confidence** *(float) --* 

              Confidence level that the bounding box contains a face (and not a different object such as a tree).

              
        
      
    