

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



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



.. py:class:: Rekognition.Client

  A low-level client representing Amazon Rekognition
  

  This is the API Reference for `Amazon Rekognition Image <https://docs.aws.amazon.com/rekognition/latest/dg/images.html>`__, `Amazon Rekognition Custom Labels <https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html>`__, `Amazon Rekognition Stored Video <https://docs.aws.amazon.com/rekognition/latest/dg/video.html>`__, `Amazon Rekognition Streaming Video <https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html>`__. It provides descriptions of actions, data types, common parameters, and common errors.

   

  **Amazon Rekognition Image**

   

  
  * `AssociateFaces <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_AssociateFaces.html>`__
   
  * `CompareFaces <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CompareFaces.html>`__
   
  * `CreateCollection <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateCollection.html>`__
   
  * `CreateUser <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateUser.html>`__
   
  * `DeleteCollection <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteCollection.html>`__
   
  * `DeleteFaces <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteFaces.html>`__
   
  * `DeleteUser <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteUser.html>`__
   
  * `DescribeCollection <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeCollection.html>`__
   
  * `DetectFaces <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectFaces.html>`__
   
  * `DetectLabels <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectLabels.html>`__
   
  * `DetectModerationLabels <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectModerationLabels.html>`__
   
  * `DetectProtectiveEquipment <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectProtectiveEquipment.html>`__
   
  * `DetectText <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectText.html>`__
   
  * `DisassociateFaces <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DisassociateFaces.html>`__
   
  * `GetCelebrityInfo <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityInfo.html>`__
   
  * `GetMediaAnalysisJob <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetMediaAnalysisJob.html>`__
   
  * `IndexFaces <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_IndexFaces.html>`__
   
  * `ListCollections <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListCollections.html>`__
   
  * `ListMediaAnalysisJob <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListMediaAnalysisJob.html>`__
   
  * `ListFaces <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html>`__
   
  * `ListUsers <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html>`__
   
  * `RecognizeCelebrities <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RecognizeCelebrities.html>`__
   
  * `SearchFaces <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFaces.html>`__
   
  * `SearchFacesByImage <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFacesByImage.html>`__
   
  * `SearchUsers <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsers.html>`__
   
  * `SearchUsersByImage <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsersByImage.html>`__
   
  * `StartMediaAnalysisJob <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartMediaAnalysisJob.html>`__
  

   

  **Amazon Rekognition Custom Labels**

   

  
  * `CopyProjectVersion <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CopyProjectVersion.html>`__
   
  * `CreateDataset <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateDataset.html>`__
   
  * `CreateProject <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProject.html>`__
   
  * `CreateProjectVersion <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProjectVersion.html>`__
   
  * `DeleteDataset <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteDataset.html>`__
   
  * `DeleteProject <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProject.html>`__
   
  * `DeleteProjectPolicy <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectPolicy.html>`__
   
  * `DeleteProjectVersion <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectVersion.html>`__
   
  * `DescribeDataset <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeDataset.html>`__
   
  * `DescribeProjects <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjects.html>`__
   
  * `DescribeProjectVersions <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjectVersions.html>`__
   
  * `DetectCustomLabels <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectCustomLabels.html>`__
   
  * `DistributeDatasetEntries <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DistributeDatasetEntries.html>`__
   
  * `ListDatasetEntries <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetEntries.html>`__
   
  * `ListDatasetLabels <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetLabels.html>`__
   
  * `ListProjectPolicies <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListProjectPolicies.html>`__
   
  * `PutProjectPolicy <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_PutProjectPolicy.html>`__
   
  * `StartProjectVersion <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartProjectVersion.html>`__
   
  * `StopProjectVersion <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopProjectVersion.html>`__
   
  * `UpdateDatasetEntries <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateDatasetEntries.html>`__
  

   

  **Amazon Rekognition Video Stored Video**

   

  
  * `GetCelebrityRecognition <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityRecognition.html>`__
   
  * `GetContentModeration <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetContentModeration.html>`__
   
  * `GetFaceDetection <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceDetection.html>`__
   
  * `GetFaceSearch <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceSearch.html>`__
   
  * `GetLabelDetection <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetLabelDetection.html>`__
   
  * `GetPersonTracking <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetPersonTracking.html>`__
   
  * `GetSegmentDetection <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetSegmentDetection.html>`__
   
  * `GetTextDetection <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetTextDetection.html>`__
   
  * `StartCelebrityRecognition <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartCelebrityRecognition.html>`__
   
  * `StartContentModeration <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartContentModeration.html>`__
   
  * `StartFaceDetection <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceDetection.html>`__
   
  * `StartFaceSearch <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceSearch.html>`__
   
  * `StartLabelDetection <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartLabelDetection.html>`__
   
  * `StartPersonTracking <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartPersonTracking.html>`__
   
  * `StartSegmentDetection <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartSegmentDetection.html>`__
   
  * `StartTextDetection <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartTextDetection.html>`__
  

   

  **Amazon Rekognition Video Streaming Video**

   

  
  * `CreateStreamProcessor <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor.html>`__
   
  * `DeleteStreamProcessor <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteStreamProcessor.html>`__
   
  * `DescribeStreamProcessor <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeStreamProcessor.html>`__
   
  * `ListStreamProcessors <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListStreamProcessors.html>`__
   
  * `StartStreamProcessor <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartStreamProcessor.html>`__
   
  * `StopStreamProcessor <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopStreamProcessor.html>`__
   
  * `UpdateStreamProcessor <https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateStreamProcessor.html>`__
  

  ::

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

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  rekognition/client/associate_faces
  rekognition/client/can_paginate
  rekognition/client/close
  rekognition/client/compare_faces
  rekognition/client/copy_project_version
  rekognition/client/create_collection
  rekognition/client/create_dataset
  rekognition/client/create_face_liveness_session
  rekognition/client/create_project
  rekognition/client/create_project_version
  rekognition/client/create_stream_processor
  rekognition/client/create_user
  rekognition/client/delete_collection
  rekognition/client/delete_dataset
  rekognition/client/delete_faces
  rekognition/client/delete_project
  rekognition/client/delete_project_policy
  rekognition/client/delete_project_version
  rekognition/client/delete_stream_processor
  rekognition/client/delete_user
  rekognition/client/describe_collection
  rekognition/client/describe_dataset
  rekognition/client/describe_project_versions
  rekognition/client/describe_projects
  rekognition/client/describe_stream_processor
  rekognition/client/detect_custom_labels
  rekognition/client/detect_faces
  rekognition/client/detect_labels
  rekognition/client/detect_moderation_labels
  rekognition/client/detect_protective_equipment
  rekognition/client/detect_text
  rekognition/client/disassociate_faces
  rekognition/client/distribute_dataset_entries
  rekognition/client/get_celebrity_info
  rekognition/client/get_celebrity_recognition
  rekognition/client/get_content_moderation
  rekognition/client/get_face_detection
  rekognition/client/get_face_liveness_session_results
  rekognition/client/get_face_search
  rekognition/client/get_label_detection
  rekognition/client/get_media_analysis_job
  rekognition/client/get_paginator
  rekognition/client/get_person_tracking
  rekognition/client/get_segment_detection
  rekognition/client/get_text_detection
  rekognition/client/get_waiter
  rekognition/client/index_faces
  rekognition/client/list_collections
  rekognition/client/list_dataset_entries
  rekognition/client/list_dataset_labels
  rekognition/client/list_faces
  rekognition/client/list_media_analysis_jobs
  rekognition/client/list_project_policies
  rekognition/client/list_stream_processors
  rekognition/client/list_tags_for_resource
  rekognition/client/list_users
  rekognition/client/put_project_policy
  rekognition/client/recognize_celebrities
  rekognition/client/search_faces
  rekognition/client/search_faces_by_image
  rekognition/client/search_users
  rekognition/client/search_users_by_image
  rekognition/client/start_celebrity_recognition
  rekognition/client/start_content_moderation
  rekognition/client/start_face_detection
  rekognition/client/start_face_search
  rekognition/client/start_label_detection
  rekognition/client/start_media_analysis_job
  rekognition/client/start_person_tracking
  rekognition/client/start_project_version
  rekognition/client/start_segment_detection
  rekognition/client/start_stream_processor
  rekognition/client/start_text_detection
  rekognition/client/stop_project_version
  rekognition/client/stop_stream_processor
  rekognition/client/tag_resource
  rekognition/client/untag_resource
  rekognition/client/update_dataset_entries
  rekognition/client/update_stream_processor


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


Paginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  rekognition/paginator/DescribeProjectVersions
  rekognition/paginator/DescribeProjects
  rekognition/paginator/ListCollections
  rekognition/paginator/ListDatasetEntries
  rekognition/paginator/ListDatasetLabels
  rekognition/paginator/ListFaces
  rekognition/paginator/ListProjectPolicies
  rekognition/paginator/ListStreamProcessors
  rekognition/paginator/ListUsers


=======
Waiters
=======


Waiters are available on a client instance via the ``get_waiter`` method. For more detailed instructions and examples on the usage or waiters, see the waiters `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters>`_.

The available waiters are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  rekognition/waiter/ProjectVersionRunning
  rekognition/waiter/ProjectVersionTrainingCompleted
